Skip to content
This repository was archived by the owner on Aug 9, 2021. It is now read-only.

Commit 5bb4ad4

Browse files
committed
Version 1.4
1 parent b1d8d24 commit 5bb4ad4

4 files changed

Lines changed: 45 additions & 4 deletions

File tree

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# 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

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>com.samifying</groupId>
88
<artifactId>main-plugin</artifactId>
9-
<version>1.3</version>
9+
<version>1.4</version>
1010
<packaging>jar</packaging>
1111

1212
<name>MainPlugin</name>
@@ -94,7 +94,7 @@
9494
<dependency>
9595
<groupId>net.dv8tion</groupId>
9696
<artifactId>JDA</artifactId>
97-
<version>4.2.1_257</version>
97+
<version>4.2.1_259</version>
9898
</dependency>
9999
<dependency>
100100
<groupId>com.github.MilkBowl</groupId>

src/main/java/com/samifying/plugin/modules/commands/ForceCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public void execute(MainPlugin plugin, Member member, TextChannel channel, Strin
4949
channel.sendMessage("Feature not yet implemented").queue();
5050
}
5151
} else {
52-
channel.sendMessage("Bad arguments, options: `verify`, `role` or 'delete'").queue();
52+
channel.sendMessage("Bad arguments, options: `verify`, `role` or `delete`").queue();
5353
}
5454
}
5555

src/main/java/com/samifying/plugin/modules/commands/HelpCommand.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ public void execute(MainPlugin plugin, Member member, TextChannel channel, Strin
2323
.addField("!config", "Configures various properties", false)
2424
.addField("!rcon", "Executes a command on the Minecraft server", false)
2525
.addField("!whois", "Retrieves data relating verified players", false)
26+
.addField("!force", "Manual verification and removal", false)
2627
.build()).queue();
2728
return;
2829
}

0 commit comments

Comments
 (0)