Skip to content

Developer Guide

Jump to bottom Edit New page
Benedek Vartok edited this page Nov 19, 2014 · 31 revisions

nodeGame Developer Guide

DISCLAIMER

Be advised that the steps described in the following sections are a work in progress and may not work at the moment.

Installation

The README describes a simple way to get the program running, but for development it might be more useful to work with the more recent Git-version and let npm only install the dependencies:

  1. git clone [email protected]:nodeGame/nodegame.git
  2. cd nodegame
  3. npm install

That way, you will also get Git's version-control files in the root nodegame/ directory and the submodules, such as nodegame/node_modules/nodegame-client/.

Compiling the Code

If you make changes in the code, you will have to run some build scripts to update the files necessary for running nodeGame:

  1. Do your changes in the module or your choice.
  2. In that module: node bin/make.js build
  3. Go to the server module (nodegame/node_modules/nodegame-server) and do: node bin/make.js build-client

After these steps, the program should be good to go.

Writing Code

TODO

Writing Documentation

TODO

Go back to the wiki Home.

License

Copyright (C) 2021 Stefano Balietti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Add a custom sidebar
Clone this wiki locally