Skip to content

Commit

Permalink
README: add dependencies, remove --enable-ipc
Browse files Browse the repository at this point in the history
  • Loading branch information
0vf committed Jul 8, 2024
1 parent 01935b6 commit 2b5c573
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ Self-hosted moderation bot
- Quickmod (right click message -> Apps -> Quickmod)
- Moderation marking (the ability to mark moderations as active or inactive)

### Dependencies
- **Atleast Python 3.10**
- discord.py
- discord.py-pagination
- Flask (flask[async])
- Flask-Discord
- better-ipc
- humanfriendly
- cogwatch
- schedule

### Setup
Begin by cloning the repository
```
Expand Down Expand Up @@ -46,9 +57,8 @@ secret = "Vinny - simple moderation bot" # IMPORTANT! This is used to encrypt co
(token and secrets for demonstration purposes, they aren't real)

# Dashboard setup
We have a fairly modern dashboard premade out of the box, which you can launch by using the following commands:
We have a fairly modern dashboard premade out of the box, which you can launch by using the following command:
```bash
python3 ./main.py --enable-ipc & # IMPORTANT! The IPC extension must be enabled for dashboard functions.
python3 dashboard/dashboard.py # IMPORTANT! You must execute the dashboard from project root! Preferably use a WSGI server to run the dashboard.
```

Expand All @@ -58,4 +68,4 @@ python3 dashboard/dashboard.py # IMPORTANT! You must execute the dashboard from
- Simple per-server log/event-log configuration (will be expanded upon soon)

### TODO:
- Cog reloading system (for hotfixes)
- None (for now)

0 comments on commit 2b5c573

Please sign in to comment.