====== TulpenCraftEssentials ======

~~NOTOC~~

===== 📌 Status =====

^ Eigenschap ^ Waarde ^
| **Plugin** | TulpenCraftEssentials |
| **Status** | 🟢 Actief |
| **Versie** | 1.1.1 |
| **Buildsysteem** | Maven |
| **Platform** | Paper |
| **Server(s)** | Survival |
| **Onderdeel van netwerk** | Ja |
| **Laatste controle** | {{DATUM}} |

^ Server ^ Actief ^
| **Velocity** | ❌ |
| **Lobby** | ❌ |
| **Survival** | ✅ |
| **Events** | ❌ |

----

===== 🎯 Doel =====

TulpenCraftEssentials is de algemene utility-plugin van TulpenCraft.

De plugin bundelt algemene serverfunctionaliteit die niet specifiek genoeg is voor een afzonderlijke gespecialiseerde plugin. Hieronder vallen configureerbare serverlinks, een eenmalige starterkit, welkomstberichten en persoonlijke begroetingen.

De plugin is bewust lichtgewicht opgezet en heeft geen runtime-afhankelijkheid van andere plugins.

----

===== 📦 Installatie =====

**Jar-bestand:**

<code>
TulpenCraftEssentials-1.1.1.jar
</code>

**Locatie:**

<code>
/srv/minecraft/survival/plugins/TulpenCraftEssentials-1.1.1.jar
</code>

**Buildsysteem:**

<code>
Maven
</code>

**Buildcommando:**

<code bash>
mvn clean package
</code>

**Build-output:**

<code>
target/TulpenCraftEssentials-1.1.1.jar
</code>

----

===== ⚙️ Configuratie =====

**Configuratiebestand:**

<code>
/srv/minecraft/survival/plugins/TulpenCraftEssentials/config.yml
</code>

**Opslag persoonlijke begroetingen:**

<code>
/srv/minecraft/survival/plugins/TulpenCraftEssentials/greetings.yml
</code>

==== Belangrijke instellingen ====

^ Instelling ^ Waarde ^ Betekenis ^
| `links.website` | Configureerbaar | URL van de TulpenCraft-website |
| `links.wiki` | Configureerbaar | URL van de TulpenCraft-wiki |
| `links.prijzen` | Configureerbaar | URL naar de actuele prijslijst |
| `links.discord` | Configureerbaar | URL naar de TulpenCraft Discord |
| `links.regels` | Configureerbaar | URL naar de serverregels |
| `links.vote` | Configureerbaar | URL naar de vote-pagina |
| `welcome.enabled` | `true` | Schakelt welkomstfunctionaliteit in |
| `welcome.first_join.enabled` | `true` | Schakelt het first-join bericht in |
| `welcome.returning.enabled` | `true` | Schakelt het terugkeerbericht in |
| `welcome.custom_greeting.enabled` | `true` | Schakelt persoonlijke begroetingen in |
| `welcome.custom_greeting.show_on_join` | `true` | Toont de persoonlijke begroeting bij het joinen |
| `welcome.custom_greeting.max_length` | `48` | Maximale lengte van een persoonlijke begroeting |
| `starterkit.enabled` | `true` | Schakelt de starterkit in |
| `starterkit.one_time` | `true` | Zorgt dat de starterkit slechts eenmaal kan worden ontvangen |
| `starterkit.items` | Configureerbaar | Inhoud van de starterkit |

==== TulpenCraft-configuratie ====

<code yaml>
links:
  website: "https://tulpencraft.nl"
  wiki: "https://wiki.tulpencraft.nl"
  prijzen: "https://wiki.tulpencraft.nl/algemene-informatie/economie/pricelimits"
  discord: "https://discord.gg/VERVANG-DIT"
  regels: "https://wiki.tulpencraft.nl/algemene-informatie/regels"
  vote: "https://wiki.tulpencraft.nl/algemene-informatie/voten"

welcome:
  enabled: true
  first_join:
    enabled: true
  returning:
    enabled: true
  custom_greeting:
    enabled: true
    show_on_join: true
    max_length: 48

starterkit:
  enabled: true
  one_time: true
</code>

----

===== 🔐 Rechten =====

^ Permission ^ Rank ^ Beschrijving ^
| `tulpenessentials.starterkit` | Standaard: iedereen | Mag de starterkit gebruiken |
| `tulpenessentials.admin` | Standaard: Operator | Mag TulpenCraftEssentials beheren |
| `tulpenessentials.customgreeting` | Standaard: niemand | Mag een eigen begroeting instellen |
| `tulpenessentials.customgreeting.color` | Standaard: Operator | Mag kleurcodes gebruiken in de eigen begroeting |
| `tulpenessentials.customgreeting.others` | Standaard: Operator | Mag begroetingen van andere spelers beheren |

==== Rankverdeling ====

De plugin koppelt permissions niet rechtstreeks aan TulpenCraft-ranks. De daadwerkelijke rankverdeling wordt centraal beheerd, bijvoorbeeld via LuckPerms.

^ Rank ^ Rechten ^
| **Speler** | `tulpenessentials.starterkit` |
| **VIP** | Afhankelijk van centrale permissionconfiguratie |
| **VIP+** | Afhankelijk van centrale permissionconfiguratie |
| **Helper** | Afhankelijk van centrale permissionconfiguratie |
| **Bouwer** | Afhankelijk van centrale permissionconfiguratie |
| **Moderator** | Afhankelijk van centrale permissionconfiguratie |
| **Developer** | Afhankelijk van centrale permissionconfiguratie |
| **Admin** | `tulpenessentials.admin` indien toegewezen |
| **Owner** | `tulpenessentials.admin` indien toegewezen |

----

===== 💬 Commando's =====

^ Commando ^ Permission ^ Beschrijving ^
| <code>/website</code> | — | Opent de geconfigureerde TulpenCraft-website |
| <code>/wiki</code> | — | Opent de geconfigureerde TulpenCraft-wiki |
| <code>/prijzen</code> | — | Opent de actuele TulpenCraft-prijslijst |
| <code>/discord</code> | — | Opent de geconfigureerde Discord-link |
| <code>/regels</code> | — | Opent de geconfigureerde serverregels |
| <code>/vote</code> | — | Opent de geconfigureerde vote-pagina |
| <code>/voten</code> | — | Alias voor `/vote` |
| <code>/starterkit</code> | `tulpenessentials.starterkit` | Ontvangt de eenmalige starterkit |
| <code>/kit</code> | `tulpenessentials.starterkit` | Alias voor `/starterkit` |
| <code>/tulpen reload</code> | `tulpenessentials.admin` | Herlaadt de pluginconfiguratie |
| <code>/begroeting</code> | `tulpenessentials.customgreeting` | Bekijk de eigen begroeting |
| <code>/begroeting &lt;tekst&gt;</code> | `tulpenessentials.customgreeting` | Stel een eigen begroeting in |
| <code>/begroeting reset</code> | `tulpenessentials.customgreeting` | Verwijder de eigen begroeting |
| <code>/greeting</code> | `tulpenessentials.customgreeting` | Alias voor `/begroeting` |
| <code>/begroeting speler &lt;naam&gt;</code> | `tulpenessentials.customgreeting.others` | Bekijk de begroeting van een andere speler |
| <code>/begroeting speler &lt;naam&gt; &lt;tekst&gt;</code> | `tulpenessentials.customgreeting.others` | Stel een begroeting voor een andere speler in |
| <code>/begroeting speler &lt;naam&gt; reset</code> | `tulpenessentials.customgreeting.others` | Verwijder de begroeting van een andere speler |

----

===== 🔗 Afhankelijkheden =====

==== Verplichte afhankelijkheden ====

  * Paper API `1.21.8-R0.1-SNAPSHOT`
  * Java 21

==== Plugin-afhankelijkheden ====

Geen.

TulpenCraftEssentials vereist geen:

  * LuckPerms
  * Vault
  * PlaceholderAPI
  * WorldGuard
  * GriefPrevention
  * ProtocolLib
  * PacketEvents
  * andere TulpenCraft-plugin

==== Optionele integraties ====

Geen.

----

===== 🌐 Netwerk / Proxy =====

**Proxy-plugin:** Nee

^ Onderdeel ^ Waarde ^
| Proxy | Velocity |
| Backend | Survival |

TulpenCraftEssentials draait als backend-plugin op de Survival-server en bevat geen Velocity-component.

----

===== 🛡️ Beveiliging =====

TulpenCraftEssentials heeft geen externe database en heeft geen runtime-afhankelijkheid van andere plugins.

Administratieve functionaliteit wordt beschermd via Bukkit/Paper-permissions.

Persoonlijke begroetingen worden opgeslagen in `greetings.yml`. Gebruikersinvoer wordt opgeschoond voordat deze wordt opgeslagen en weergegeven. Regeleinden worden verwijderd en kleurcodes worden gecontroleerd via een afzonderlijke permission.

De maximale lengte van een persoonlijke begroeting is standaard 48 Unicode-tekens. De plugin telt hierbij Unicode codepoints.

De starterkit gebruikt Bukkit's `PersistentDataContainer` om per speler vast te leggen of de starterkit al is ontvangen.

Links worden vanuit de configuratie geladen en als klikbare Adventure Components aan spelers aangeboden.

----

===== ⚠️ Aandachtspunten =====

  * De plugin vereist Java 21.
  * De plugin is gebouwd tegen Paper API `1.21.8-R0.1-SNAPSHOT`.
  * De plugin heeft geen externe plugin-afhankelijkheden.
  * De starterkit kan standaard slechts eenmaal per speler worden geclaimd.
  * De starterkit-status wordt opgeslagen in de speler-PersistentDataContainer.
  * Persoonlijke begroetingen worden opgeslagen in `greetings.yml`.
  * Een persoonlijke begroeting vervangt bij terugkerende spelers het normale terugkeerbericht.
  * Bij een eerste join blijft het uitgebreide first-join bericht actief.
  * De standaard Discord-URL in de huidige configuratie is nog een placeholder en moet worden vervangen.
  * Configuratiewijzigingen kunnen worden toegepast met `/tulpen reload`.

----

===== 🧪 Troubleshooting =====

==== Plugin wordt niet geladen ====

Controleer of de plugin actief is:

<code>
/plugins
</code>

Controleer vervolgens de serverlog:

<code bash>
grep -i "TulpenCraftEssentials" logs/latest.log
</code>

Controleer ook de Java-versie:

<code bash>
java -version
</code>

De plugin vereist Java 21.

==== Commando's zijn niet beschikbaar ====

Controleer of `TulpenCraftEssentials` succesvol is geladen.

Controleer daarna `logs/latest.log` op fouten tijdens het starten.

==== Configuratiewijzigingen worden niet toegepast ====

Gebruik:

<code>
/tulpen reload
</code>

Controleer vervolgens of de wijziging correct in `config.yml` staat.

==== Starterkit kan niet worden geclaimd ====

Controleer of de speler de starterkit al eerder heeft ontvangen.

Wanneer `starterkit.one_time` is ingeschakeld, wordt de status per speler opgeslagen via `PersistentDataContainer`.

==== Persoonlijke begroeting werkt niet ====

Controleer of de speler beschikt over:

<code>
tulpenessentials.customgreeting
</code>

Controleer daarnaast:

<code>
plugins/TulpenCraftEssentials/greetings.yml
</code>

==== Kleurcodes werken niet ====

Voor het gebruik van kleurcodes is de volgende permission nodig:

<code>
tulpenessentials.customgreeting.color
</code>

==== Een URL werkt niet ====

Controleer de betreffende instelling in:

<code>
plugins/TulpenCraftEssentials/config.yml
</code>

Een URL die nog `VERVANG-DIT` bevat wordt door de plugin als niet-ingesteld beschouwd.

----

===== 📝 Onderhoud =====

**Laatste wijziging:** {{DATUM}}

**Wijziging:** Documentatie opgesteld op basis van TulpenCraftEssentials 1.1.1 en de actuele broncode.

**Status:** 🟢 Actief

----

===== 🔗 Externe links =====

  * [[https://github.com/TulpenCraft/TulpenCraftEssentials|GitHub repository]]
  * [[https://tulpencraft.nl|TulpenCraft]]
  * [[https://wiki.tulpencraft.nl|TulpenCraft Wiki]]