discordapp MUD

Florrie 3f35b84bd6 Merge branch 'master' of https://notabug.org/alex/antipath into saved-parties vor 6 Jahren
core 3f35b84bd6 Merge branch 'master' of https://notabug.org/alex/antipath into saved-parties vor 6 Jahren
.editorconfig cdcc0c0db0 Add editorconfig vor 6 Jahren
.gitignore 56fecc657b Fix gitignore vor 6 Jahren
antipath 542feb4330 Add camo; refactor config loader vor 6 Jahren
config.example.json 5bcb05e068 Add exemplary Player data class vor 6 Jahren
license.txt 45b64b0bf5 Initial commit vor 6 Jahren
package-lock.json 17bd182313 Merge branch 'impl-battles' of alex/antipath into master vor 6 Jahren
package.json 17bd182313 Merge branch 'impl-battles' of alex/antipath into master vor 6 Jahren
readme.md 542feb4330 Add camo; refactor config loader vor 6 Jahren

readme.md

A Discord-based MUD. Requires Node.js.

Running

Start by cloning the repository (aka downloading it, and automagically setting up so it's easy for you to make and share contributions). Enter this in a terminal:

$ git clone https://notabug.org/alex/antipath.git path/to/antipath

You will need to set up config before the program works. Copy config.example.json to config.json, then edit it, filling in database access info and other miscellaneous information.

Once your config is set up (or you want to test it), follow these steps in your terminal:

$ cd path/to/antipath
$ npm install                 # The first time you run, to get Node.js dependencies
$ npm install --no-save nedb  # Or mongodb, which requires extra setup
$ node .                      # This is what you do to actually run the program