Andere Versionen: English

Einführung

Willkommen im englischen Liquip-Wiki. In diesem Artikel erfahren Sie, wie Sie das Liquip-Plugin verwenden, welche Funktionen es hat und wie Sie es mit eigenen Plugins erweitern können.

Quellcode

Der Quellcode, aus dem diesem Artikel generiert wird, finden Sie auf GitHub.

Start

In dieser Kategorie werden wir die Themen Installation und das Konfigurationsformat behandeln.

Inhaltspunkt 1 - Installation

Um mit Liquip arbeiten zu können, müssen Sie Liquip erstmal Installieren. Die Installation wird in folgendem Artikel von uns verständlich erläutert.

Inhaltspunkt 2 - Konfigformat

Damit Sie Items erstellen können, müssen Sie erstmal unser verwendetes Konfigurationsformat verstehen. Wir verwenden ein Format, welches auf JSON basiert.

Installation

Um Liquip zu installieren, müssen Sie die letzte Version von der Github Releases Seite herunterladen.

Wenn Sie die JAR-Datei heruntergeladen haben, sollten Sie diese in das plugin Verzeichnis Ihres Servers verschieben. Wenn Sie noch keinen Server aufgesetzt haben finden Sie auf dieser Seite eine Anleitung dafür.

Voraussetzungen

Um Liquip benutzen zu können brauchen Sie folgendes:

  • Java 17 oder neuer
  • Paper 1.19 Server (andere Versionen sind nicht getestet)

Installation von Java

Falls Sie kein Java installiert haben können Sie zu Adoptium gehen und sich dort die Java Binarys und sogar fertige Installer herunterladen.

Um zu testen, ob Sie Java erfolgreich installiert haben, müssen Sie Ihre Konsole öffnen und dort den Befehl java --version eingeben. Sie werden danach eine Antwort wie openjdk 17.0.1 2021-10-19 erhalten. Wichtig ist die erste Zahl nach openjdk 17 oder höher ist.

Installation von Paper und Aufsetzen des Minecraft-Servers

Um Ihren persönlichen Minecraft Server zu erstellen, müssen Sie sich erstmal die neuste Paper-Version von deren Website herunterladen und die heruntergeladene JAR-Datei zu Ihrem gewünschten Verzeichnis verschieben.

Um danach den Server zu starten, müssen Sie Ihr Terminal in dem Verzeichnis öffnen und folgenden Befehl ausführen: java -Xms2G -Xmx2G -jar <Dateiname der JAR-Datei + .jar> --nogui also z. B. java -Xms2G -Xmx2G -jar paper-1.19.3-362.jar --nogui.

Beim ersten Start der Datei wird höchstwahrscheinlich ein Error auftreten. Die Error-Nachricht müsste ungefähr so aussehen: Failed to load eula.txt. Dies ist völlig normal und heißt einfach, dass Sie dem Endbenutzer-Lizensvertrag zustimmen müssen.

Dafür öffnen Sie die neu erstellte Datei eula.txt. In dieser müsste ungefähr das stehen:

#By changing the setting below to TRUE you are indicating your agreement to our EULA (https://aka.ms/MinecraftEULA).
#Tue Dec 27 18:00:00 CET 2022
eula=false

Schreiben Sie das letzte Wort in dieser Datei von false zu true.

Wenn Sie das erledigt haben, können Sie den Server über den gleichen, schon ausgeführten Befehl starten.

Jetzt müsste sich auch ein plugin Ordner erstellen, in den Sie die Liquip-Datei hineinkopieren. (s. o.)

Um das Plugin zu laden, müssen Sie den Server neu starten. Das geht mit dem Befehl stop und nach dem erfolgreichen Stoppen des Servers geben Sie einfach wieder den vorher verwendeteten Start-Befehl ein.

Das Konfigurations Format

Liquip benutzt eine modifizierte Version von JSON. Wenn du nicht weißt, was JSON ist, kannst du dir den Wikipedia Artikel dazu anschauen.

Wichtig ist vor allem dieser Unterpunkt.

Unterschiede

Liquip lässt folgende Dinge zu:

  • Tags ohne Anführungszeichen
  • Kommentare
  • Einzelne Anführungszeichen

Das sieht ungefähr so aus:

{
  // some comment
  name: 'value',
  'otherName': "otherValue"
}

Erklärung Liquip-Spezifischer Begriffe

Bei Liquip benutzen wir viele Begriffe, die eventuell für manche uneindeutig sind. Deshalb versuchen wir in diesem Artikel diese Begriffe anschaulich zu erklären, um dir deine Arbeit mit Liquip zu erleichtern.

Algemeine Begriffe

  • Liquip - Das gesammte Plugin (Liquip=Name)
  • Paper - Einer Serversoftware für deine Minecraftserver

Begriffe in der Konfigurationsdatei

  • key - Die genaue Kennzeichnung des Items (z. B. liquip:testitem). Standartmäfig ist der key so aufgebaut: <namespace>:<id>.
  • material - Das Item an sich, welches angezeigt wird. (z. B. minecraft:stone). Hier gibt es eine Liste aller Items + key
  • displayname - Der Text der Angezeigt werden soll, wenn man das Item in Minecraft hat. (Farben sind auch möglich)
  • lore - Die Beschreibung des Items, die angezeigt wird, wenn man mit dem Mauszeiger auf dem Item ist.
  • features - Spezielle Funktionen, die extra pogrammiert werden müssen und Items zugewisen werden können.
  • recipes - Das Crafting-Rezept um das Item im Überlebendmodus herstellen zu können.
  • enchantments - Verzauberungen die man dem Item zuweist.

Weitere Begriffe

  • id - Eine einzigartige Bezeichnung für jedes Item in Minecraft.
  • namespace - Ein Namespace fasst eine Gruppe von Datenwerten (IDs) zusammen, er ist sozusagen ihr Familienname.

Eigene Items

In diesem Kapitel wirst du endlich lernen, deine eigenen Items zu erstellen.

Registration

Bevor du endlich dein erstes Item erstellen kannst, musst du erstmal wissen, wie du deine eigenen Items registrierst.

Was bedeutet eigentlich Registrieren?

Bei Liquip muss man seine Items nochmal in einer Hauptkonfigdatei auflisten. Man gibt immer den Pfad und den Namen deines neuen Items in solch einer Konfigdatei an, damit das Plugin später weiß, wo sich deine Konfigurationsdateien für deine Items befinden.

Dies ist zwingend Nötig, wenn du deine Items später in Minecraft sehen möchtest.

Ordnerstruktur

Aktuell müsste die Ordnerstruktur in plugins/liquip so aussehen:

└── config.json

Jetzt musst du nor noch einen Überbegriff erstellen, unter dem du deine Items auflistest. Am besten nennst du ihn ungefähr so: items

Die Konfigurationsdatei würde dann so aussehen:

.
├── config.json
└── items
   ├── bedrock_pickaxe.json
   └── bedrock_sword.json

Du kannst auch weitere Unterordner für jede namespace erstellen.

.
├── config.json
└── items
    └── mynewitems
        ├── bedrock_pickaxe.json
        └── bedrock_sword.json

Registration

Um die Items nun zu registrieren, musst du in die config.json folgenden Code eingeben:

{
  "items": [
    "<Pfad zu deinem Item>/<Dateiname (.json)>"
  ]
}

Wenn du deine Items später erstellt hast, müsste deine Konfigurationsdatei dann ungefähr so aussehen:

{
  "items": [
    "items/mynewitems/bedrock_pickaxe.json",
    "items/mynewitems/bedrock_sword.json"
  ]
}

Minimale Konfigdatei

Die minimalste Konfigurationsdatei ist so aufgebaut:

{
  "key": "<namespace:id>",
  "material": "<minecraft_item>",
  "displayName": "<Anzeigename>"
}

In den nächsten Kapiteln wirst du weitere Erweiterungen sehen, um deine Items weiter zu modifizieren.

Farbige Anzeigenamen

Wir haben bei Liquip außerdem MiniMessages implementiert. Das heißt, dass Sie die Möglichkeit haben, Ihre Items farbig zu gestalten.

Weitere Informationen und eine genaue Anleitung zur Verwendung von MiniMessages, finden Sie hier (Englisch).

Professionelles

Typen

Standartfeatures