30 lines
681 B
Markdown
30 lines
681 B
Markdown
# PGNator
|
|
|
|
A Discord bot that turns PGN (Portable Game Notation) files into animated GIFs
|
|
|
|
## Required Environment
|
|
- Java 17+ (May work on older versions but untested)
|
|
- Maven
|
|
|
|
### Tested Operating Systems
|
|
- macOS 14 & 15 (arm64)
|
|
- Windows 10 22H2 (x86_64)
|
|
- Debian 12 (x86_64)
|
|
|
|
---
|
|
|
|
## Config file schema
|
|
```json
|
|
{
|
|
"token": "your_token"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Commands
|
|
|
|
| Command | Description | Arguments | Type |
|
|
|------------|----------------------------------------|--------------|-------|
|
|
| `/ping` | Gets the bot's gateway & rest ping | None | N/A |
|
|
| `/pgn2gif` | Turns the provided PGN file into a GIF | `[pgn_file]` | File |
|