Update README

This commit is contained in:
Roscoe 2025-05-16 15:25:06 +01:00
commit a652e7b029
Signed by: RoscoeDaWah
SSH key fingerprint: SHA256:Hqn452XQ1ETzUt/FthJu6+OFkS4NBxCv5VQSEvuk7CE

View file

@ -1,3 +1,30 @@
# PGN-ator
# PGNator
A simple utility to convert PGN files to animated GIFs
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 |