Update README
This commit is contained in:
parent
8ab139b902
commit
a652e7b029
1 changed files with 29 additions and 2 deletions
31
README.md
31
README.md
|
|
@ -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 |
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue