|
1 | 1 | # MainPlugin |
2 | | -The main server plugin, used on the server, handles the discord bot and the money rpc api endpoint |
| 2 | +This is the main plugin on the SamiCraft Minecraft server, it handles the Discord bot and the MoneyRPC Balance API |
| 3 | + |
| 4 | +### Discord Bot Features |
| 5 | + |
| 6 | +Discord bot handles various features on the server, some of the most notable are: |
| 7 | + |
| 8 | +- Verification and server whitelisting |
| 9 | +- Twitch clips channel filter |
| 10 | +- Minecraft server status |
| 11 | + |
| 12 | +#### Command list: |
| 13 | + |
| 14 | +- `!balance` - Displays your balance on the server |
| 15 | +- `!botinvite` - Discord invite link for the bot |
| 16 | +- `!help` - Command list and description |
| 17 | +- `!moneyrpc` - Instructions on how to install the MoneyRPC mod |
| 18 | +- `!myid` - Prints out your discord id |
| 19 | +- `!seed` - Displays the current world's seed |
| 20 | +- `!spawn` - Writes out current world's spawn location |
| 21 | +- `!mcstatus` or `!online` - Displays current server status |
| 22 | +- `!tutorial` - Youtube playlist containing all the plugin tutorials |
| 23 | +- `!verify` - Links your Minecraft and Discord accounts |
| 24 | + |
| 25 | +#### Admin command list: |
| 26 | + |
| 27 | +- `!config` - Changes the server configuration |
| 28 | +- `!force` - Verifies or removes users from whitelist |
| 29 | +- `!rcon` - Executes a command on the server |
| 30 | +- `!whois` - Retrieves details about a user/player |
| 31 | + |
| 32 | +### MoneyRPC Balance API |
| 33 | + |
| 34 | +You can get real time user balance data from the server using the following endpoint: |
| 35 | + |
| 36 | +- `http://api.samifying.com/v1/balance?id=<discord-id>` |
| 37 | + |
| 38 | +#### Additional API Information |
| 39 | + |
| 40 | +- Rate limit is **1 call per second** |
| 41 | +- Returned value is a single string |
| 42 | +- User must be verified and must have joined the server once |
0 commit comments