From 2f2e870cc75c8d6f2c80dd0968c133c784ec2350 Mon Sep 17 00:00:00 2001 From: Joe Robinson Date: Thu, 25 Nov 2021 03:31:09 +0000 Subject: Add README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..30da377 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +roboconomy +========== + +Setup +----- + +Install dependencies: +`pip install -r requirements.txt` + +Copy `config.yaml.example` to `config.yaml` and fill in the relevant values. + + +Initialising +------------ + +Run `python initialise_db.py` to populate the database with users and EXP. + +Running +------- + +Run `python bot.py` and leave it running to listen for messages + +Commands +-------- + +Currently response to the following commands in discord: + +- /coins: Shows your current coins +- /daily: Gives you some coins once a day (or just any time at the moment) +- /coin_flip [coin bet] [heads or tails]: Flips a coin. Gives you double your bet if you guess correctly +- /dice: Rolls some dice. Doesn't do anything with the result -- cgit v1.2.3 From f1c86203def4af5237ac9b12841a4e45841dae29 Mon Sep 17 00:00:00 2001 From: Joe Robinson Date: Thu, 25 Nov 2021 03:33:41 +0000 Subject: Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 30da377..19f3137 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ Install dependencies: Copy `config.yaml.example` to `config.yaml` and fill in the relevant values. +Requires a MySQL DB running. Credentials are set in config.yaml + Initialising ------------ -- cgit v1.2.3