discordapp MUD

alex 732ea880ce Merge branch 'emote-store' of alex/antipath into master 6 vuotta sitten
core 732ea880ce Merge branch 'emote-store' of alex/antipath into master 6 vuotta sitten
.editorconfig cdcc0c0db0 Add editorconfig 6 vuotta sitten
.gitignore 56fecc657b Fix gitignore 6 vuotta sitten
antipath 542feb4330 Add camo; refactor config loader 6 vuotta sitten
config.example.json 6c5966c64c Add intelligent EmoteStore 6 vuotta sitten
license.txt 45b64b0bf5 Initial commit 6 vuotta sitten
package-lock.json 732ea880ce Merge branch 'emote-store' of alex/antipath into master 6 vuotta sitten
package.json fde7b29b6a Warn if graphicsmagick not installed 6 vuotta sitten
readme.md 72e14484c2 Choose move target by avatar 6 vuotta sitten

readme.md

A Discord-based MUD. Requires Node.js and graphicsmagick to be installed.

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