discordapp MUD

Florrie 9940f8c011 Mention git clone, formatting tweaks 6 éve
core 45b64b0bf5 Initial commit 6 éve
.gitignore 45b64b0bf5 Initial commit 6 éve
antipath 45b64b0bf5 Initial commit 6 éve
config.example.json 45b64b0bf5 Initial commit 6 éve
license.txt 45b64b0bf5 Initial commit 6 éve
package-lock.json 45b64b0bf5 Initial commit 6 éve
package.json 45b64b0bf5 Initial commit 6 éve
readme.md 9940f8c011 Mention git clone, formatting tweaks 6 éve

readme.md

A Discord-based MUD. Requires MongoDB and 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

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
$ node .  # This is what you do to actually run the program