Replace boilerplate README with project-specific documentation

2026-08-09 17:34:33 +02:00
parent 918375da36
commit 59e32acd3d
1 changed files with 27 additions and 1 deletions
@@ -1,4 +1,30 @@
 # SMPCore
-## Diese Repo wird als Copyrepo benutzt und an die jeweiligen Projekte angepasst!

+[![Build](https://git.softwarerat.com/zlaura/SMPCore/actions/workflows/build.yml/badge.svg)](https://git.softwarerat.com/zlaura/SMPCore/actions)

+Core Paper plugin for SoftwareRat SMP servers. Wires together ban commands (via [BansystemAPI](https://git.softwarerat.com/zlaura/BansystemAPI)) and a home system (via [HomesAPI](https://git.softwarerat.com/zlaura/HomesAPI)) into a single plugin.
+
+> This repo is used as a base/copy template and adapted per-project ("Diese Repo wird als Copyrepo benutzt und an die jeweiligen Projekte angepasst").
+
+## Requirements
+
+- Java 8
+- Maven
+- Paper API 1.20.2
+
+## Dependencies
+
+- [HomesAPI](https://git.softwarerat.com/zlaura/HomesAPI) `1.3-SNAPSHOT`
+- [BansystemAPI](https://git.softwarerat.com/zlaura/BansystemAPI) `1.6.9-BETA`
+
+Both are resolved from the private Maven registry at `https://git.softwarerat.com/api/packages/zlaura/maven`.
+
+## Building
+
+```bash
+mvn -B package
+```
+
+## License
+
+No license file is present in this repository; all rights reserved by the author unless stated otherwise.