Files
IsleBot/Readme.md
Samuele Lorefice 0685bc33ce updated readme
2023-11-05 17:26:58 +01:00

26 lines
880 B
Markdown

# Isle Bot
### _A bot for a private server._
## Features:
- Card Rolling
- Turn Based Combat
- _more to come..._
#### Setup
1. Clone the repo
2. Create a venv by running `python -m venv venv` and activate it using `venv\Scripts\activate.bat` or the ps1 variant for powershell
3. Install requirements with `pip install -r requirements.txt`
4. Create a `.env` file with the following contents:
```ini
TOKEN=your_discord_bot_token_here
```
5. Run `start.ps1` or `start.bat`
6. Invite the bot to your server
7. Profit!
##### Notes
The bot is provided as is and is not guaranteed to work. If you have any issues, please open an issue on the github repo. I might or might not fix it.
You're welcome to fork the repo and make your own changes, but I do not guarantee that I will be accepting your pull request.
This just a pet project and as such it might get abandoned at any time.