Update README.md

Added the gamemodes.py specification, switched requirement from 3.2 to 3.3 and encouraged 3.4+.
This commit is contained in:
Emanuel Barry 2016-06-30 20:31:53 -04:00 committed by GitHub
parent 7a0c9b87e1
commit 8d1cfa1a77

View File

@ -4,9 +4,11 @@ We have an active community, and we'd love for you to [join us][2]!
# Running your own copy
You need Python 3.2 or newer to run the bot.
You need Python 3.3 or newer to run the bot. Python 3.4 and higher is recommended.
Copy `botconfig.py.example` to `botconfig.py` and modify the settings as needed. You can also copy-paste individual settings from `src/settings.py` into `botconfig.py` if you want to modify them.
Copy `botconfig.py.example` to `botconfig.py` and modify the settings as needed. You can also copy-paste individual settings from `src/settings.py` into `botconfig.py` if you want to modify them. You may also add or customize your own game modes by renaming `gamemodes.py.example` to `gamemodes.py` and using the same layout used in `src/gamemodes.py`.
Note: you should never alter files under the `src` folder directly (unless you are submitting a change to the code), use `botconfig.py` and `gamemodes.py` for related changes.
To start the bot, run `./wolfbot.py`. You can use `--verbose` to log all raw IRC messages and `--debug` to enable some debugging features. These options should not be used in production.