CalyxAPI

# CalyxAPI Modular **Paper 1.21+** server system (Java 21) for CalyxMC — admin, economy, chat, homes, minigames, and cosmetics. Extend with addon plugins via the developer API (PlaceholderAPI-style). **MiniMessage** (DE/EN), **Brigadier commands**, SQLite or MySQL/MariaDB. --- ## Versions | Component | Version | Distribution | |-----------|---------|--------------| | **Plugin** (server) | **1.0.0** | Modrinth → `CalyxAPI-1.0.0.jar` in `plugins/` | | **API** (developers) | **1.0.0** | Maven `de.calyx:CalyxAPI:1.0.0` | Plugin and API versions may diverge in future releases. Match the **API version** in Gradle/Maven. --- ## Features ### Core - Modular architecture — toggle modules in `config.yml` - German & English messages (`messages_de.yml` / `messages_en.yml`) - `/calyx` admin hub (reload, version, module branches) - SQLite by default, optional MySQL/MariaDB (HikariCP) - Optional hooks: Vault, PlaceholderAPI, LuckPerms ### Modules Built-in modules in plugin **1.0.0**: | Module | Examples | |--------|----------| | **admin** | `/calyx admin`, `/ban`, `/kick` | | **economy** | `/balance`, `/pay`, `/baltop` | | **chat** | `/msg`, `/r` | | **homes** | `/home`, `/sethome`, `/warp`, `/tpa` | | **games** | `/game`, `/leave` | | **cosmetics** | `/cosmetics` | > Several commands are **skeletons** in 1.0.0 and will be implemented in later updates. --- ## Requirements - **Paper** 1.21.4+ (or compatible fork) - **Java 21** - Optional: Vault, PlaceholderAPI, LuckPerms --- ## Installation 1. Download **CalyxAPI** from Modrinth: **`CalyxAPI-1.0.0.jar`** (plugin version **1.0.0**). 2. Place in your server's `plugins/` folder. 3. Start the server — files are created under `plugins/CalyxAPI/`. 4. Edit `config.yml` and enable/disable modules. 5. Run `/calyx reload` after config changes (or restart). --- ## Developer API For addon plugins. **Repository:** (https://repo.dergamer09.at/) **URL:** `https://repo.dergamer09.at/releases` (public, no login) **Coordinates:** `de.calyx:CalyxAPI:1.0.0` (API version **1.0.0**) Use **`compileOnly`** — the CalyxAPI **plugin JAR** must still be installed on the server. ### Maven `pom.xml`: ```xml <repositories> <repository> <id>dergamer09-repository</id> <name>DerGamer09 Repository</name> <url>https://repo.dergamer09.at/releases</url> </repository> <repository> <id>papermc</id> <url>https://repo.papermc.io/repository/maven-public/</url> </repository> </repositories> <dependencies> <dependency> <groupId>de.calyx</groupId> <artifactId>CalyxAPI</artifactId> <version>1.0.0</version> <scope>provided</scope> </dependency> <dependency> <groupId>io.papermc.paper</groupId> <artifactId>paper-api</artifactId> <version>1.21.4-R0.1-SNAPSHOT</version> <scope>provided</scope> </dependency> </dependencies> ``` ### Gradle Kotlin `build.gradle.kts`: ```kotlin repositories { mavenCentral() maven("https://repo.papermc.io/repository/maven-public/") maven { name = "dergamer09Repository" url = uri("https://repo.dergamer09.at/releases") } } dependencies { compileOnly("io.papermc.paper:paper-api:1.21.4-R0.1-SNAPSHOT") compileOnly("de.calyx:CalyxAPI:1.0.0") } ``` ### Gradle Groovy `build.gradle`: ```groovy repositories { mavenCentral() maven { url 'https://repo.papermc.io/repository/maven-public/' } maven { name 'dergamer09Repository' url 'https://repo.dergamer09.at/releases' } } dependencies { compileOnly 'io.papermc.paper:paper-api:1.21.4-R0.1-SNAPSHOT' compileOnly 'de.calyx:CalyxAPI:1.0.0' } ``` ### Addon dependency `paper-plugin.yml`: ```yaml dependencies: server: CalyxAPI: load: BEFORE required: true join-classpath: true ``` ### API usage ```java // Extend AbstractCalyxModule and register in onEnable(): new MyModule(this).register(); // Or: de.calyx.serversystem.api.CalyxAPI.registerModule(new MyModule(this)); ``` - Brigadier commands via `registerCommands(ModuleCommandRegistrar)` - Events: `CalyxModuleRegisterEvent`, `CalyxModuleUnregisterEvent` --- ## Permissions | Permission | Description | |------------|-------------| | `calyx.admin` | `/calyx` base access | | `calyx.admin.reload` | `/calyx reload` | | `calyx.module.<id>` | `/calyx <module>` branch | | `calyx.economy.*` | Economy commands | | `calyx.homes.*` | Homes / warps / tpa | | `calyx.test` | Test addon (if installed) | --- ## Disclaimer Early release — core framework and module skeletons are stable; individual gameplay features are still being implemented.