updated readme

This commit is contained in:
notnull 2019-01-28 04:10:41 -05:00
parent 6f02feeb4e
commit 65474d498e

30
README.org Normal file
View File

@ -0,0 +1,30 @@
* banned from the milieu
This is a fork of https://github.com/lykoss/lykos with the messages altered for anarchists.
* Running your own copy
:PROPERTIES:
:CUSTOM_ID: running-your-own-copy
:END:
You need Python 3.3 or newer to run the bot. Python 3.4 and higher is
recommended.
SQLite3 is required for the bot's database. If compiling Python from
source, you may need to install the appropriate SQLite3 development
libraries for your distribution first.
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.