From 5bb4ad4caa35a77975a349d92a6c2b70b254f69f Mon Sep 17 00:00:00 2001 From: Petar Kresoja Date: Mon, 19 Apr 2021 20:21:28 +0200 Subject: [PATCH] Version 1.4 --- README.md | 42 ++++++++++++++++++- pom.xml | 4 +- .../plugin/modules/commands/ForceCommand.java | 2 +- .../plugin/modules/commands/HelpCommand.java | 1 + 4 files changed, 45 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f7ee91f..d8987e4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ # MainPlugin -The main server plugin, used on the server, handles the discord bot and the money rpc api endpoint +This is the main plugin on the SamiCraft Minecraft server, it handles the Discord bot and the MoneyRPC Balance API + +### Discord Bot Features + +Discord bot handles various features on the server, some of the most notable are: + +- Verification and server whitelisting +- Twitch clips channel filter +- Minecraft server status + +#### Command list: + +- `!balance` - Displays your balance on the server +- `!botinvite` - Discord invite link for the bot +- `!help` - Command list and description +- `!moneyrpc` - Instructions on how to install the MoneyRPC mod +- `!myid` - Prints out your discord id +- `!seed` - Displays the current world's seed +- `!spawn` - Writes out current world's spawn location +- `!mcstatus` or `!online` - Displays current server status +- `!tutorial` - Youtube playlist containing all the plugin tutorials +- `!verify` - Links your Minecraft and Discord accounts + +#### Admin command list: + +- `!config` - Changes the server configuration +- `!force` - Verifies or removes users from whitelist +- `!rcon` - Executes a command on the server +- `!whois` - Retrieves details about a user/player + +### MoneyRPC Balance API + +You can get real time user balance data from the server using the following endpoint: + +- `http://api.samifying.com/v1/balance?id=` + +#### Additional API Information + +- Rate limit is **1 call per second** +- Returned value is a single string +- User must be verified and must have joined the server once \ No newline at end of file diff --git a/pom.xml b/pom.xml index c586a16..db1f5b2 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ com.samifying main-plugin - 1.3 + 1.4 jar MainPlugin @@ -94,7 +94,7 @@ net.dv8tion JDA - 4.2.1_257 + 4.2.1_259 com.github.MilkBowl diff --git a/src/main/java/com/samifying/plugin/modules/commands/ForceCommand.java b/src/main/java/com/samifying/plugin/modules/commands/ForceCommand.java index 52561d5..3264457 100644 --- a/src/main/java/com/samifying/plugin/modules/commands/ForceCommand.java +++ b/src/main/java/com/samifying/plugin/modules/commands/ForceCommand.java @@ -49,7 +49,7 @@ public void execute(MainPlugin plugin, Member member, TextChannel channel, Strin channel.sendMessage("Feature not yet implemented").queue(); } } else { - channel.sendMessage("Bad arguments, options: `verify`, `role` or 'delete'").queue(); + channel.sendMessage("Bad arguments, options: `verify`, `role` or `delete`").queue(); } } diff --git a/src/main/java/com/samifying/plugin/modules/commands/HelpCommand.java b/src/main/java/com/samifying/plugin/modules/commands/HelpCommand.java index 19b0e67..4a11e1d 100644 --- a/src/main/java/com/samifying/plugin/modules/commands/HelpCommand.java +++ b/src/main/java/com/samifying/plugin/modules/commands/HelpCommand.java @@ -23,6 +23,7 @@ public void execute(MainPlugin plugin, Member member, TextChannel channel, Strin .addField("!config", "Configures various properties", false) .addField("!rcon", "Executes a command on the Minecraft server", false) .addField("!whois", "Retrieves data relating verified players", false) + .addField("!force", "Manual verification and removal", false) .build()).queue(); return; }