Skip to content

Commit 4d84631

Browse files
committed
Update README.md
1 parent 74db8f4 commit 4d84631

3 files changed

Lines changed: 56 additions & 2 deletions

File tree

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,45 @@ as soon as WCL log is posted into logspam channel by WCL bot.
44
SLAO bot will get report link from that message and will provide rankings information
55
either for full clear or for up to 4 fights.
66

7-
## Install
8-
Rename .env.template to .env and fill values
7+
8+
## Dev setup
9+
1. Clone the repo
10+
2. Setup venv. This is optional but more convenient then system wide installation of our dependencies
11+
```powershell
12+
python -m venv .venv
13+
.\.venv\Scripts\Activate.ps1
14+
```
15+
3. Install dependencies (inside the activated venv)
16+
```powershell
17+
python -m pip install --upgrade pip
18+
python -m pip install -r requirements.txt -r requirements-dev.txt
19+
```
20+
4. Fill in config/base.cfg and config/guild.cfg. There are template files for these configs.
21+
5. Run the bot
22+
```powershell
23+
cd slao_bot
24+
python -m slaobot
25+
```
26+
27+
## Commands
28+
29+
All commands use the configured prefix from `config/base.cfg` (by default `slaobot-local!`).
30+
31+
- **Sync slash commands**
32+
- Text: `slaobot-local!sync`
33+
- Description: Syncs slash commands for the current guild.
34+
35+
- **Raid statistics (slash commands)**
36+
- `/report <report_id>` – подробный отчёт по логу WCL.
37+
- `/potions <report_id>` – статистика по зельям/камням и пре-потам.
38+
- `/gear <report_id>` – проверка камней, энчантов и оффспек‑лутa.
39+
- `/engineers <report_id>` – использование гранат и инженерных расходников.
40+
41+
- **EPGP (slash commands)**
42+
- `/epgp [target]` – EPGP персонажа (по нику персонажа или вашему нику в Дискорде, если не указано имя персонажа).
43+
- `/raidloot` – последний рейд‑лут.
44+
- `/points` – последние начисления EP/GP.
45+
- `/standing [standing_filter]` – таблица EPGP гильдии (`all`, `non-zero`, `cap`).
46+
47+
- **Signup / newcomers (slash command)**
48+
- `/signup` – анкета для новых игроков, отправляется офицерам.

slao_bot/config/base.cfg.template

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[BASE]
2+
DISCORD_TOKEN =
3+
WCL_CLIENT_ID =
4+
WCL_CLIENT_SECRET =
5+
COMMAND_PREFIX = slaobot-local!
6+
LOG_LEVEL =

slao_bot/config/guild.cfg.template

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[GUILD-ID-HERE]
2+
signup_enabled = False
3+
signup_channel = 0
4+
welcome_message = Welcome to guild server. Use /signup command if you want to join our guild!
5+
epgp_enabled = False
6+
epgp_upload_channel = 0
7+
guild_timezone = Europe/Moscow
8+
guild_name = Some String

0 commit comments

Comments
 (0)