Updated gitignore and readme

This commit is contained in:
Samuele Lorefice
2023-11-06 20:46:06 +01:00
parent f37998ca9f
commit 1fe234914d
3 changed files with 17 additions and 36 deletions

5
.gitignore vendored
View File

@@ -394,4 +394,7 @@ FodyWeavers.xsd
*.msp
# JetBrains Rider
*.sln.iml
*.sln.iml
# Ignore the config file so you can place the token for your local testing
config.json

View File

@@ -8,32 +8,8 @@
</component>
<component name="ChangeListManager">
<list default="true" id="79ad02fc-d6b5-4413-931b-52fb76129e49" name="Changes" comment="">
<change afterPath="$PROJECT_DIR$/.idea/.idea.IsleBot/.idea/encodings.xml" afterDir="false" />
<change afterPath="$PROJECT_DIR$/.idea/.idea.IsleBot/.idea/indexLayout.xml" afterDir="false" />
<change afterPath="$PROJECT_DIR$/.idea/.idea.IsleBotSharp/.idea/workspace.xml" afterDir="false" />
<change afterPath="$PROJECT_DIR$/Card.cs" afterDir="false" />
<change afterPath="$PROJECT_DIR$/Config.cs" afterDir="false" />
<change afterPath="$PROJECT_DIR$/DbManager.cs" afterDir="false" />
<change afterPath="$PROJECT_DIR$/EStatus.cs" afterDir="false" />
<change afterPath="$PROJECT_DIR$/IsleBot.csproj" afterDir="false" />
<change afterPath="$PROJECT_DIR$/IsleBot.sln" afterDir="false" />
<change afterPath="$PROJECT_DIR$/Match.cs" afterDir="false" />
<change afterPath="$PROJECT_DIR$/Program.cs" afterDir="false" />
<change afterPath="$PROJECT_DIR$/User.cs" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.gitignore" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/.gitignore" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/.idea.IsleBot/.idea/.gitignore" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/IsleBot.iml" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/dbnavigator.xml" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/inspectionProfiles/Project_Default.xml" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/inspectionProfiles/profiles_settings.xml" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/modules.xml" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/vcs.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/.idea.IsleBot/.idea/vcs.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/Card.py" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/Player.py" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/main.py" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/requirements.txt" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/start.ps1" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/.gitignore" beforeDir="false" afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
<change beforePath="$PROJECT_DIR$/config.json" beforeDir="false" afterPath="$PROJECT_DIR$/config.json" afterDir="false" />
</list>
<option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -111,7 +87,7 @@
<option name="presentableId" value="Default" />
<updated>1699202233917</updated>
<workItem from="1699202234933" duration="14451000" />
<workItem from="1699298781898" duration="466000" />
<workItem from="1699298781898" duration="889000" />
</task>
<servers />
</component>

View File

@@ -8,18 +8,20 @@
#### 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`
2. Run `dotnet restore` in the root directory
3. Open `config.json` and add your discord bot token
4. Run `dotnet build -c Release`
5. Run the resulting build in `bin/Release/net7.0/IsleBot.exe`
6. Invite the bot to your server
7. Profit!
##### Notes
###### FAQ
Q: Why this is now a C# project?
A: I am familiar with C#, and python lacks a decent ORM that isn't a pain to use. Deal with it...
###### 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.