51 lines
1.4 KiB
Markdown
51 lines
1.4 KiB
Markdown
# discord-ledger-bot
|
|
|
|
## Prerequisites
|
|
Python must be installed system-wide. See instructions for your operating system below.
|
|
### Windows 11 / 10 [not yet tested]
|
|
Download the installer from [here](https://www.python.org/downloads/), install latest version. If given the option, you should install the 'venv' or 'virtual environment' module as well.
|
|
### Ubuntu / Debian (includes Pop!_OS, Linux Mint, Raspberry Pi OS, etc.)
|
|
```
|
|
sudo apt install python3 python3-venv
|
|
```
|
|
### Fedora (includes Nobara, Bazzite, etc.) [not yet tested]
|
|
```
|
|
sudo dnf install python3 python3-virtualenv
|
|
```
|
|
### Arch Linux (includes CachyOS, Manjaro, SteamOS, etc.)
|
|
```
|
|
sudo pacman -S python3 python3-venv
|
|
```
|
|
### OpenSUSE (Tumbleweed/Leap) [not yet tested]
|
|
```
|
|
sudo zypper install python3 python3-virtualenv
|
|
```
|
|
|
|
|
|
## Installation / Usage instructions
|
|
1. Clone this repository:
|
|
```
|
|
git clone https://git.greyweather.dev/greyweather/discord-ledger-bot.git
|
|
```
|
|
2. Enter the directory
|
|
```
|
|
cd discord-ledger-bot
|
|
```
|
|
3. Create a virtual environment
|
|
```
|
|
python -m venv .
|
|
```
|
|
4. Install the required libraries
|
|
```
|
|
./bin/pip install discord dotenv datetime
|
|
```
|
|
5. Set your Discord application token
|
|
```
|
|
echo "TOKEN='my-token-here'" > .env
|
|
```
|
|
Or add a line reading `TOKEN='my-token-here'` to a file named ".env" using a text editor of your choosing (must be next to your "main.py" file)
|
|
|
|
6. Run the script
|
|
```
|
|
./bin/python main.py
|
|
``` |