discordapp MUD

Joshua 49d468bfa2 Fix some spacing and bracket issues 6 gadi atpakaļ
core 49d468bfa2 Fix some spacing and bracket issues 6 gadi atpakaļ
.editorconfig cdcc0c0db0 Add editorconfig 6 gadi atpakaļ
.gitignore 56fecc657b Fix gitignore 6 gadi atpakaļ
antipath 542feb4330 Add camo; refactor config loader 6 gadi atpakaļ
config.example.json 5bcb05e068 Add exemplary Player data class 6 gadi atpakaļ
license.txt 45b64b0bf5 Initial commit 6 gadi atpakaļ
package-lock.json ab55e8bcc7 Working GraphicBar streams! 6 gadi atpakaļ
package.json 02ef0b56ec GraphicBar stuff - not yet tested with buffers (WIP) 6 gadi atpakaļ
readme.md 542feb4330 Add camo; refactor config loader 6 gadi atpakaļ

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