Replace boilerplate README with project-specific documentation

2026-08-09 17:34:30 +02:00
parent 4362edfe30
commit b2a544da08
1 changed files with 25 additions and 71 deletions
@@ -1,81 +1,35 @@
-# Bansystem API
+# BansystemAPI

-## Benutzung
-## Vorraussetzungen
-    - Eine Datenbank inkl. Ban Table(Struktur siehe Code)
-    - Einen MariaDB Server MySQL ansich wird NICHT unterstützt.
+[![Build](https://git.softwarerat.com/zlaura/BansystemAPI/actions/workflows/build.yml/badge.svg)](https://git.softwarerat.com/zlaura/BansystemAPI/actions)

+A Paper API library implementing player ban/mute/report handling (`com.softwarerat.bansystemAPI`), backed by YAML storage.

-### initialisierung des Basis API Codes
+## Requirements

-```java 
-        public void onEnable(){
-        Bansystem bansystem = new Bansystem();
-        bansystem.enableAPI("Benutzer","Passwort","Host","Datenbank");
-        ban = bansystem.getBan();
-        }
- ```      
+- Java 8
+- Maven
+- Paper API 1.21.11

-### Spieler Bannen
-```java 
-public class BanPlayer{
-     Ban ban;
- public BanPlayer(Ban ban) {
-        this.ban = ban; 
-    }
-    public void test(String UUID,String Reason, String Punisher, Long Time){
-          ban.addPunishment(UUID(String),Reason(String) ,Punisher(String) ,Time(Long));
-          
-    }
-}
+## Building

-```
-   ### der Spieler sollte aktuell optional vom server gekickt werden (bald wird über Netty ein Packet an den Discord Bot server gesendet welches dem ProxySystem sagt das es den Spieler kicken soll)
-
-### Spieler entbannen
-```java 
-public class BanPlayer{
-    //Initialize Class
-     Ban ban;
- public BanPlayer(Ban ban) {
-        this.ban = ban; 
-    }
-    public void test(String UUID){
-// deletes the Punishment(s) from the following UUID
-        ban.deletePunishment(args[0]);         
-    }
-}
-```
-### Spieler auf Banzeit checken
-```java 
-public class PlayerJoin {
-
-    Ban ban;
-
-    public PlayerJoin(Ban ban) {
-        this.ban = ban;
-    }
-
-    @EventHandler
-    public void onPostLogin(PostLoginEvent event) {
-
-        System.out.println("neuer Join erkannt");
-        UUID player = event.getPlayer().getUniqueId();
-        ProxiedPlayer proxiedPlayer = event.getPlayer();
-
-
-        System.out.println("Joinevent | Neuer Datenabruf");
-        //Spieler mittels Banzeit joinen lassen oder nicht, die != 0 muss so sein weil sonst ne OutOfBounds kommen wird
-        if (ban.getBanTime(player.toString()) != 0) {
-            if (ban.getBanTime(player.toString()) >= System.currentTimeMillis()) {
-                proxiedPlayer.disconnect("du wurdest gebannt grund siehste im discord");
-            }
-        } else {
-            System.out.println("Spieler nit gebannt");
-        }
-    }
-}
+```bash
+mvn -B package
 ```

+## Using it in another project

+Published as a Maven snapshot to the private registry at `https://git.softwarerat.com/api/packages/zlaura/maven`:

+```xml
+<dependency>
+    <groupId>com.softwarerat</groupId>
+    <artifactId>BansystemAPI</artifactId>
+    <version>1.6.9-BETA</version>
+</dependency>
+```
+
+Used by [SMPCore](https://git.softwarerat.com/zlaura/SMPCore).
+
+## License
+
+No license file is present in this repository; all rights reserved by the author unless stated otherwise.