BabyMsp2k
96 lines
4.9 KiB
Markdown
96 lines
4.9 KiB
Markdown
# ⚡ Trixinity-Event Plugin
|
|
|
|
**Trixinity-Event** je specializovaný plugin pro správu herních eventů na Minecraft serverech, který nabízí přehledné příkazy, automatizované úkony a integraci s klíčovými serverovými pluginy.
|
|
|
|
| Status | Hodnota | Zdroj |
|
|
| :--- | :--- | :--- |
|
|
| **Verze** | v1.0.0 | |
|
|
| **API Verze** | 1.21 | |
|
|
| **Autor** | BabyMsp2k | |
|
|
|
|
---
|
|
|
|
## 🧩 Požadované pluginy
|
|
|
|
### Povinné závislosti
|
|
* **WorldGuard**: Používá se pro přepínání flagů (build, pvp) v regionu `EVENT`.
|
|
|
|
### Doporučené / Soft Dependencies
|
|
* **PlaceholderAPI**: Umožňuje zobrazení aktuálního statusu eventu a jména Eventera.
|
|
* **LuckPerms**: Plugin využívá příkazy `/lp user...` pro nastavení role Eventer.
|
|
* **WorldEdit**: Zmiňován v nápovědě pro administrátory pro úpravy event arén.
|
|
|
|
---
|
|
|
|
## ⚙️ Příkazy
|
|
|
|
Všechny příkazy pro správu eventů vyžadují oprávnění **`trixinity.event.admin`** nebo **`op`**.
|
|
|
|
| Příkaz | Popis | Oprávnění |
|
|
| :--- | :--- | :--- |
|
|
| **`/trixinity`** | Zobrazí základní informace o pluginu (verze, autor). | `trixinity.admin` (op) |
|
|
| **`/event`** (alias: `/e`) | Hlavní příkaz pro správu eventů. | `trixinity.event.admin` (op) |
|
|
| **`/eventer <nick>`** | Nastaví hráče jako Eventera (pomocí LuckPerms role `eventer`) a uloží do konfigurace. | `*` (pouze pro administrátory) |
|
|
| **`/cleareventer`** | Vymaže současného Eventera a vrátí jeho LuckPerms roli na `default`. | `*` (pouze pro administrátory) |
|
|
|
|
### Sub-příkazy `/event`
|
|
|
|
| Sub-příkaz | Popis | Klíčové akce |
|
|
| :--- | :--- | :--- |
|
|
| **`pripravuje`** | Nastaví status eventu na "Připravuje se" a vypne whitelist. | `whitelist off` |
|
|
| **`start`** | Nastaví status na "Začal", zapne whitelist a zaplní oblast železnými mřížemi. | `whitelist on`, `/fill ... iron_bars` |
|
|
| **`end`** | Nastaví status na "Skončil" a resetuje oblast bloků. | `/fill ... air`, `/fill ... iron_bars` |
|
|
| **`event spleef`** | Spustí Spleef event: naplní arénu sněhovými bloky a dá hráčům zlatou lopatu s **Efficiency III**. | Připraví Spleef arénu. |
|
|
| **`build <on/off>`** | Povolí/zakáže stavění v regionu WorldGuardu s názvem **`__global__`** ve světě **`EVENT`**. | WorldGuard flag `build` |
|
|
| **`pvp <on/off>`** | Povolí/zakáže PvP v regionu WorldGuardu s názvem **`__global__`** ve světě **`EVENT`**. | WorldGuard flag `pvp` |
|
|
|
|
---
|
|
|
|
## 🏗️ Struktura projektu
|
|
|
|
Projekt používá standardní Gradle strukturu pro Minecraft pluginy s využitím Wrapperu a GitHub Actions pro CI.
|
|
|
|
.
|
|
├── .github/ # Konfigurace pro GitHub, CI/CD, Issues a Bots
|
|
│ ├── actions/
|
|
│ │ └── common-setup/ # Společné nastavení Javy pro Workflows
|
|
│ ├── CODEOWNERS
|
|
│ ├── CONTRIBUTING.md # Pokyny pro přispívání
|
|
│ ├── dependabot.yml # Konfigurace pro automatické aktualizace závislostí
|
|
│ ├── ISSUE_TEMPLATE/
|
|
│ ├── stale.yml # Konfigurace pro Probot: Stale
|
|
│ └── workflows/ # Workflows pro Testy, Releasy a Notifikace
|
|
├── build.gradle # Hlavní konfigurační soubor Gradle (závislosti, ShadowJar, Checkstyle)
|
|
├── config/
|
|
│ └── checkstyle/
|
|
│ └── checkstyle.xml # Konfigurace pro kontrolu stylu (Google Java Style)
|
|
├── CODE_OF_CONDUCT.md # Kodex chování pro přispěvatele
|
|
├── gradle/
|
|
│ └── wrapper/
|
|
│ ├── gradle-wrapper.jar
|
|
│ └── gradle-wrapper.properties
|
|
├── gradlew # Skript pro spuštění Gradle na Linuxu/macOS
|
|
├── gradlew.bat # Skript pro spuštění Gradle na Windows
|
|
├── LICENSE # Licence projektu (GNU GPL v3)
|
|
├── README.md # Tento soubor
|
|
├── settings.gradle # Nastavení názvu projektu (Trixinity-Event)
|
|
└── src/
|
|
├── main/
|
|
│ ├── java/
|
|
│ │ └── dev/trixinity/event/
|
|
│ │ ├── commands/ # Logika pro /event, /eventer, /cleareventer
|
|
│ │ ├── placeholders/ # Implementace PlaceholderAPI
|
|
│ │ └── TrixinityEvent.java # Hlavní třída pluginu
|
|
│ └── resources/
|
|
│ ├── config.yml # Výchozí konfigurační soubor
|
|
│ └── plugin.yml # Metadata pluginu a definice příkazů
|
|
└── test/
|
|
└── java/ # Testy (aktuálně obsahuje pouze prázdný testovací soubor)
|
|
|
|
|
|
---
|
|
|
|
## 💖 Credits
|
|
|
|
Plugin Trixinity-Event vytvořil s ❤️ **BabyMsp2k**.
|