From 37642afec5c9983c17fa26b22c8fa9c78cd8083d Mon Sep 17 00:00:00 2001 From: GaMeNu <98153342+GaMeNu@users.noreply.github.com> Date: Tue, 5 Dec 2023 18:56:11 +0200 Subject: [PATCH] v2.2.4 preps --- README.md | 13 ++++++------- botinfo.json | 2 +- ...irements-new-python.txt => requirements-3_11.txt | 0 3 files changed, 7 insertions(+), 8 deletions(-) rename requirements-new-python.txt => requirements-3_11.txt (100%) diff --git a/README.md b/README.md index dd3035f..8236671 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,9 @@ Feel free to send suggestions and bug reports through our [discord server](https ## Setup Invite the bot to a server, and /register a channel, and you're ready to go! -Alternatively, you can DM the bot to receive alerts directly to your DMs! +Alternatively, you can /register a Direct Message / Group DM channel to receive alerts directly! -Please do note that the bot instance listed here is hosted on a private machine, and may be a bit slow. +Please do note that the bot instance listed under the [links section](#links) is hosted on a private machine, and may be a bit slow. It is recommended to [host your own instance](#self-hosting), if possible. ## Command documentation #### /register @@ -68,7 +68,7 @@ Python 3.10 and below: Python 3.11 and above: ``` -(python -m) pip install -r requirements-new-python.txt +(python -m) pip install -r requirements-3_11.txt ``` #### Other requirements @@ -77,7 +77,8 @@ Python 3.11 and above: ### Local data: #### .env file -Save the following to a file named ".env", and replace the angled brackets with the matching data +Save the following to a file named ".env", and replace the angled brackets with the matching data. Do note that it has to be on the same directory as `main.py`. + ```env TOKEN = AUTHOR_ID = @@ -86,10 +87,8 @@ DB_USERNAME = DB_PASSWORD = ``` -note that the .env file must be in the same directory as main.py - #### botinfo file -in botinfo.json, change the "maintainer" value (default is "GaMeNu (@gamenu)") to your username, and maybe add contact information. This is in order to allow others to contact you about issues with your specific instance, and will be publicly available through /info. +In botinfo.json, change the "maintainer" value (default is "GaMeNu (@gamenu)") to your username, and maybe add contact information. This is in order to allow others to contact you about issues with your specific instance, and will be publicly available through /info. **Make sure to not write any personal/private information there!** diff --git a/botinfo.json b/botinfo.json index 19008aa..14cd972 100644 --- a/botinfo.json +++ b/botinfo.json @@ -1,4 +1,4 @@ { - "version": "2.3.0", + "version": "2.2.4", "maintainer": "GaMeNu (@gamenu)" } \ No newline at end of file diff --git a/requirements-new-python.txt b/requirements-3_11.txt similarity index 100% rename from requirements-new-python.txt rename to requirements-3_11.txt