Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"python.testing.unittestArgs": [
"-v",
"-s",
"./tests",
"-p",
"test*.py"
],
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true
}
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Run the following commands in the VSCode terminal:

```powershell
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r ./src/resources/requirements.txt
```

#### 5. Confirm `ffmpeg` is installed:
Expand Down Expand Up @@ -84,7 +84,7 @@ Suggested permissions:

#### 4. Save the bot token

Create a file named `.env` with the following contents:
Create a file named `.env` in the `src/resources` directory with the following contents:

```txt
TOKEN=your-discord-bot-token-here
Expand Down Expand Up @@ -112,9 +112,10 @@ TOKEN=your-discord-bot-token-here

#### 1. Ensure your `.env` file contains the bot token.
#### 2. If you want voice alerts, place one or more `.mp3` files in the `resources/` folder.
#### 3. Start the bot from the project root in the virtual environment:
#### 3. Start the bot from the src directory in the virtual environment:

```powershell
cd src
python bot.py
```

Expand All @@ -130,3 +131,7 @@ python bot.py

- If the bot cannot find the `resources/` folder or no MP3 files are present, it will still run but will not play audio.
- You can customize channel names and messages in `ui/helpers/constants.py`.
- To run tests, navigate to the project directory and run the following in the terminal:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By this, do you meet the root of the project?

```powershell
python -m unittest discover -s tests
```
File renamed without changes.
Loading