CardBoard SharkMI Fork

<div align="center"> <img width="130" src="https://cardboardpowered.org/assets/cardboard-box.png"> # Cardboard (SharkMI Fork) **Run Bukkit / Spigot / Paper plugins on Fabric servers** (https://img.shields.io/badge/License-GPL--3.0-orange)](LICENSE) (https://img.shields.io/badge/Fabric-0.16%2B-%23dacfa4)](https://fabricmc.net/) (https://img.shields.io/github/stars/SharkMI-0x7E/CardBoard?style=flat&logo=github&color=yellow)](../../stargazers) (README.zh_CN.md) </div> > **This is a community fork** maintained by (https://github.com/SharkMI-0x7E), based on (https://github.com/CardboardPowered/cardboard). > > It includes additional compatibility fixes that have not yet been merged upstream. ### 🐛 Issues & Feedback - **Fork-specific bugs or suggestions** → Please open an (https://github.com/SharkMI-0x7E/CardBoard/issues). - **General discussion or questions** → Feel free to join the (https://discord.gg/tddTWXZtaP) (the upstream community). --- ## Fork Differences This is a fork of the official (https://github.com/CardboardPowered/cardboard) project with the following changes: - **Enhanced mixin compatibility**: Replaced `@Overwrite` annotations with precise injection methods (`@Inject`, `@ModifyArg`, `@Redirect`) to avoid conflicts with other Fabric mods - **MiniMOTD compatibility**: Fixed server status ping conflicts with MiniMOTD mod - **carpet-tis-addition compatibility**: Fixed boat item placement conflicts - **Fabric API NPE fix**: Resolved crash caused by Fabric API field injection timing - **OWASP security scanning**: Integrated OWASP Dependency-Check into the build pipeline - **Mixin conflict detection tool**: Built-in runtime scanner that detects mixin conflicts across all loaded mods at startup (6 detection rules, FATAL/HIGH/MEDIUM/LOW severity levels, console + JSON report output, optional auto-disable for fatal conflicts) --- ## Overview Cardboard is an implementation of the **Bukkit/Spigot/Paper API for FabricMC**. It allows you to run plugins from the Bukkit ecosystem on a Fabric modded server, giving you the best of both worlds: mods and plugins. ## Features - Support for Bukkit/Spigot/Paper plugins - Full Bukkit API implementation (work in progress) - NMS (`net.minecraft.server`) support with automatic remapping - Compatible with Fabric API - Mojang official mappings ## Installation ### Prerequisites | Software | Version | |----------|---------| | Java | 21+ | | Fabric Loader | 0.16+ | | Minecraft | 1.21.11 | ### Steps 1. **Install Fabric Server** - Download the (https://fabricmc.net/use/installer/) - Or use the (https://fabricmc.net/use/server/) 2. **Download Cardboard** - Get the latest jar from the (https://cardboardpowered.org/download/), (../../releases), or (https://modrinth.com/mod/cardboard-sharkmi-fork) 3. **Place in mods folder** ``` server/ ├── mods/ │ ├── cardboard-xxx.jar <-- put here │ └── fabric-api-xxx.jar <-- Fabric API (required) ├── eula.txt └── server.properties ``` 4. **Start the server** - The config file will be generated automatically on first launch - Place plugins in the `plugins/` folder ## Usage ### Loading Plugins Simply drop `.jar` plugin files into the `plugins/` directory and restart the server. ### Configuration Configuration file is located at `config/cardboard/cardboard-config.yml`: ```yaml # Enable automatic conflict resolution auto-conflict-resolution: true # Force-disabled mixins (for resolving conflicts) mixin-force-disable: # Mixin conflict detection runtime-conflict-scan: true conflict-scan-json-output: false auto-disable-fatal-conflicts: false # Debug options debug-print-event-call: false debug-print-all-calls: false ``` For detailed conflict detection configuration, see (docs/mixin-conflict-detection/user-guide.md). ## Building ### Requirements - Java 21+ - Gradle (wrapper included, no extra installation needed) ### Build Commands ```powershell # Windows .\gradlew.bat build # Linux/Mac ./gradlew build # Skip tests (faster) .\gradlew.bat build -x test ``` Build artifacts are located in `build/libs/`. ## Version Support | Minecraft Version | Fabric Version | Branch | Status | |-------------------|----------------|--------|--------| | 1.21.11 | 0.16+ | ver/1.21.11 | Active | | <= 1.21.8 | - | - | No Longer Supported | This fork focuses exclusively on the latest Minecraft version. Older versions are not maintained. See (https://github.com/CardboardPowered/cardboard/wiki/Supported-Versions) for upstream details. ## Plugin Compatibility ### Tested Working | Plugin | Status | Notes | |--------|--------|-------| | EssentialsX | Partial | Core features work | | WorldEdit | Partial | B