hiajen/EAA_MOD
1
1
Fork 0
Code Issues 4 Pull requests 1 Projects Releases 4 Activity

#11 Provide readonly config, extend readme, refactor database location #12

Merged
hiajen merged 2 commits from 11-Readonly_Database into master 2021-07-28 19:31:52 +02:00
Conversation 0 Commits 2 Files changed 8 +14 -14
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 4192c554a5 - Show all commits

28
README.md
View file

@ -1,17 +1,17 @@
EAA_MOD EAA_MOD
=============== ===============
This MOD is created by the "Eggwars Am Abend" (EAA) Squad, to increase fun playing minecraft by avoiding hacking/idiotic players and providing some useful tools. This MOD is created by the "Eggwars Am Abend" (EAA) Squad, to increase fun playing Minecraft by avoiding hacking/idiotic players and providing some useful tools.
This mod is 100% clientside and does not interact with the server you are playing on. This mod is 100% client side and does not interact with the server you are playing on.
## Features ## Features
Following a list of features this mod provides Following a list of features, this mod provides
### TAG ### TAG
It's basically a report system. It's basically a report system.
Users are able to mark other players with a set of tags. As example as Hacker/Friend/Goodplayer and so on. Users are able to tag other players with a set of tags. As example as Hacker/Friend/Good player and so on.
In addition, the tag gets weighted by a scale from 0 to 10. In addition, the tag gets weighted by a scale from 0 to 10.
Tagged players are shown at the player overview (TAB) including their recent tag with grade. Tagged players are shown when pressing TAB, including their recent tag with grade.
Other commands like playercheck/lobbycheck also use tag data. Other commands like playercheck/lobbycheck also use tag data.
### Ping as Number ### Ping as Number
@ -22,25 +22,25 @@ https://www.curseforge.com/minecraft/mc-mods/better-ping-display-fabric
### Echo ### Echo
uhm ... yeh ... it echos ... uhm ... you uhm ... yeh ... it echos ... uhm ... you
(used as PoC, will be removed sooner or later)
## Commands ## Commands
All mod commands start with a double slash (`//`), so they don't get confused with other commands All mod commands start with a double slash (`//`), so they don't get confused with other commands
* `//tag <player> <tag> <grade>` * `//tag <player> <tag> <grade>`
* Tags player with chosen tag and grade. On success a toast is shown. * Tags player with chosen tag and grade. On success, a notification is shown.
* `//lobby` * `//lobby`
* Checks if any negative tagged players (Hacker/Idiot/Noob) are in the current lobby. * Checks if any unwanted players (Hacker/Idiot/Noob) are in the current lobby.
* `//check <player>` * `//check <player>`
* shows detailed information about player including past playernames and tags. * shows detailed information about a player, including past player names and tags.
* `//echo <text>` * `//echo <text>`
* reply with text * reply with text
* `//reload` * `//reload`
* reloads cashed players. Useful when playing in a team and someone tagged another player. Otherwise the tag would not appear till next game start. * reloads cashed players. Useful when playing in a team and someone tagged another player. Otherwise, the tag would not appear till next game start.
## Settings ## Settings
Mod needs a file in modfolder called settings.properties containing following values: Mod needs a file in mod folder called settings.properties containing following values:
``` ```
url=mysql://<DATABASE_URL>/ url=mysql://<DATABASE_URL>/
@ -49,8 +49,8 @@ password=<DATABASE USER PASSWORD>
db_name=<DATABASE NAME> db_name=<DATABASE NAME>
``` ```
A working sample config is provided in the config folder, setup with a readonly user of the developers Database. A working sample config is provided in the config folder, setup with a read only user of the developers Database.
## Database ## Database
Database-Model and SQL-Starterscript can be found in the config/database folder. Database-Model and SQL-Starterscript can be found in the config/database folder.
The Mod itself does not create the needed Database structure. The user has to init the Database by itself. The Mod itself does not create the needed Database structure. The user has to init the Database by himself.