mirror of
https://github.com/SamueleLorefice/isleBot.git
synced 2026-01-14 21:55:49 +00:00
Added readme, added content to the start.ps1, added requirements.txt
This commit is contained in:
25
Readme.md
Normal file
25
Readme.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# 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 `python -m venv venv` and activate it `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.
|
||||
Reference in New Issue
Block a user