Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.67 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.67 KB

LeetQuest

A Web MMORPG forked off BrowserQuest.

Usage

Building the client: To build the client, run npm run build.

Building game maps: This (particularly expensive) step needs to run separately via npm run build-maps. It is only necessary when the tools/maps/tmx/map.tmx file has been edited — the built map files are version-controlled.

Running the server: To run the game server, run npm start (remember to build the client first if necessary). The server takes a single optional command-line argument, viz. the name of a configuration file, which defaults to config.json. The configuration file overrides the defaults supplied in config.default.json.

Some additional documentation is located in the client, server, and tools/maps directories.

Developing

In development mode, the game server automatically rebuilds the client whenever its source files are changed. To use this mode, invoke npm run start-dev.

To invoke the code auto-formatter and linter — preferrably before every commit —, run npm run cleanup. The formatter and linter are available separately as npm run format and npm run lint, respectively.

To format and/or lint the entire source code unconditionally, use npm run format-full, npm run lint-full, or npm run cleanup-full instead.

License

Code is licensed under MPL 2.0. Content is licensed under CC-BY-SA 3.0. See the LICENSE file for details.

Credits

The original BrowserQuest was created by Franck Lecollinet and Guillaume Lecollinet from Little Workshop.