https://github.com/mrtrizer/dvigloengine
Minimalistic game engine for Web.
https://github.com/mrtrizer/dvigloengine
Last synced: 10 months ago
JSON representation
Minimalistic game engine for Web.
- Host: GitHub
- URL: https://github.com/mrtrizer/dvigloengine
- Owner: mrtrizer
- Created: 2015-11-15T13:21:51.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-18T17:57:26.000Z (over 10 years ago)
- Last Synced: 2025-09-11T20:43:19.629Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 391 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Main Page {#mainpage}
=========
# DvigloEngine
##Install
To install:
git clone https://github.com/mrtrizer/DvigloEngine.git dviglo
cd dviglo
npm install
##Start server
To start example project:
node server/server.js start examples/tree_test
##Create own project (not implemented)
To init new project:
node server/server.js init
##Edit project (not implemented)
To start editor:
node server/server.js edit
# Documentation
It is Doxyfile in a root of the project. You need doxygen and graphviz installed to generate full documentation. Run doxygen in a project root and generated docs will be placed in doc/doxydoc/html.
# Project structure
##File tree
Every project has project.json file in a root. It defines how to build and serve project and it's folder structure. See an example:
{
"client":"./src/client/test.js", //Source, containing main function
"server":"./src/server/handlers.js", //Request handlers
"common":"./src/common/", //Location of common for client and server sources
"res":"./src/res/*", //App resources (become avaliable in http://your.site/res/*)
"favicon":"./favicon.ico" //Favicon location
}
##Entry point
As you can't change index.html, your script runs right after body initialization via main() function call. You can start write your code here. Short example:
export function main() {
console.log("Hello, world!");
}
Now you can init an object tree here. I have an idea to move this code to the core in future and give only control for object tree and it's leafs. But now I follow a simplest way.