feature/UCAF-655-enhanced-wiki

.github/ISSUE_TEMPLATE/bug-oder-fehler.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 **Beschreibe den Bug oder Fehler**
-Eine klare und präzise Beschreibung des Fehlers.
+Füge hier eine klare und präzise Beschreibung des Fehlers ein.
 
 **Wie kann der Bug oder Fehler reproduziert werden?**
 Schritte zum Reproduzieren des Verhaltens:
@@ -18,11 +18,11 @@ Schritte zum Reproduzieren des Verhaltens:
 4. Dort ist der Fehler
 
 **Erwartetes Verhalten**
-Eine klare und präzise Beschreibung dessen, was erwartet wurde.
+Füge hier eine klare und präzise Beschreibung dessen, was erwartet wurde, ein.
 
 **Screenshots**
 Füge gegebenenfalls Screenshots hinzu, um das Problem zu erläutern.
 
 **Weitere Informationen (bitte ausfüllen):**
 Minecraft Version: `1.12.2`
-Addon Version: `1.10.2`
+Addon Version: `2.0.0-alpha.4`

.github/workflows/build.yml

@@ -1,13 +1,11 @@
-name: Build
+name: Build LabyAddon
 
 on:
   push:
-    branches:
-      - develop
+    branches: [ "develop" ]
   pull_request:
-    branches:
-      - main
-      - develop
+    branches: [ "develop" ]
+  workflow_dispatch:
 
 jobs:
   build:
@@ -16,12 +14,15 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 8
+
+      - name: 🔥 Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          distribution: 'temurin'
-          java-version: '8'
-      - name: Grant execute permission for gradlew
+          distribution: 'corretto'
+          java-version: '17'
+
+      - name: 🔑 Grant execute permission for gradlew
         run: chmod +x gradlew
-      - name: Build with Gradle
-        run: ./gradlew downloadLabyModAPI build
+
+      - name: 🔨 Build with Gradle
+        run: ./gradlew build --full-stacktrace

.github/workflows/release.yml

@@ -2,27 +2,55 @@ name: Release
 
 on:
   push:
-    branches:
-      - main
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+env:
+  PUBLIC_RELEASE_BUILD: true
+  PUBLIC_RELEASE_BUILD_TOKEN: ${{ secrets.PUBLIC_RELEASE_BUILD_TOKEN }}
 
 jobs:
-  build:
+  labyaddon:
 
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 8
+
+      - name: 🔥 Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          distribution: 'temurin'
-          java-version: '8'
-      - name: Grant execute permission for gradlew
+          distribution: 'corretto'
+          java-version: '17'
+
+      - name: 🔑 Grant execute permission for gradlew
         run: chmod +x gradlew
-      - name: Build with Gradle
-        run: ./gradlew downloadLabyModAPI build
-      - name: Upload jar
-        uses: actions/upload-artifact@v1
+
+      - name: 🔨 Build with Gradle
+        run: ./gradlew build --full-stacktrace
+
+      - name: 📈 Upload Artifact
+        uses: actions/upload-artifact@v3
         with:
           name: Artifacts
-          path: build/libs/
+          path: build/libs/*-release.jar
+
+  wiki:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: 📦 Install mkdocs dependencies
+        run: |
+          pip install mkdocs-material
+          pip install mkdocs-git-revision-date-localized-plugin
+
+      - name: 🔨 Build and deploy mkdocs
+        run: mkdocs gh-deploy --force

.github/workflows/wiki.yml

@@ -0,0 +1,29 @@
+name: Build Wiki
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    branches: [ "develop" ]
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: 📦 Install mkdocs dependencies
+        run: |
+          pip install mkdocs-material
+          pip install mkdocs-git-revision-date-localized-plugin
+
+      - name: 🔨 Build mkdocs
+        run: mkdocs build

.gitignore

@@ -1,26 +1,139 @@
-# eclipse
-bin
-*.launch
-.settings
-.metadata
-.classpath
-.project
-
-# idea
-out
-*.ipr
+# Created by .ignore support plugin (hsz.mobi)
+### Java template
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+.idea/**/misc.xml
+.idea/**/discord.xml
+.idea/**/encodings.xml
+.idea/codeStyles/
+.idea/sonarlint/
+
+# Generated files
+.idea/**/contentModel.xml
+.idea/**/jarRepositories.xml
+.idea/**/uiDesigner.xml
+.idea/**/inspectionProfiles
+.idea/**/.name
+.idea/**/vcs.xml
+.idea/**/compiler.xml
+.idea/**/libraries-with-intellij-classes.xml
+run/**
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/dbnavigator.xml
+.idea/kotlinScripting.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+.idea/modules.xml
+.idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
 *.iws
-*.iml
-.idea
 
-# gradle
-build
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Gradle template
 .gradle
+/**/build/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Cache of project
+.gradletasknamecache
+
+# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
+# gradle/wrapper/gradle-wrapper.properties
+
+.idea/modules/
+
+.idea/intellij-javadocs-4.0.1.xml
+docs/generated/
+
+# Project
+run/
 
-# other
-eclipse
-run
+# LabyGradle | Addon Plugin
+build-data.txt
 
-# Files from Forge MDK
-forge*changelog.txt
-/libs/
+# Don't ignore libraries
+!libs/*.jar

CONTRIBUTING.md

@@ -41,7 +41,7 @@ Wenn Du ein geschlossenes Issue findest, von dem Du denkst, dass es sich um das
 
 #### Was macht ein gutes Bug-Issue aus
 - **Verwende einen klaren und aussagekräftigen Titel** für das Problem, um das Problem zu identifizieren.
-- **Beschreibe die genauen Schritte, die das Problem reproduzieren**, so detailliert wie möglich. Beginne zum Beispiel damit, ob Minecraft länger geladen hat als sonst, welchen Befehl du verwendet hast. Wenn Du die Schritte auflistest, **sag nicht nur, was Du getan hast, sondern erklär auch, wie Du es getan hast** (Hotkey, manuelle Eingabe, ...).
+- **Beschreibe die genauen Schritte, die das Problem reproduzieren**, so detailliert wie möglich. Beginne zum Beispiel damit, ob Minecraft länger geladen hat als sonst, welchen Befehl Du verwendet hast. Wenn Du die Schritte auflistest, **sag nicht nur, was Du getan hast, sondern erklär auch, wie Du es getan hast** (Hotkey, manuelle Eingabe, ...).
 - **Erkläre, welches Verhalten Du stattdessen erwartet hast und warum.**
 - **Füge Screenshots und animierte GIFs bei**, die zeigen, wie der Fehler entstanden ist und diesen deutlich veranschaulichen. Du kannst [dieses Tool](https://www.cockos.com/licecap/) verwenden, um GIFs unter macOS und Windows aufzunehmen und [dieses Tool](https://github.com/colinkeenan/silentcast) oder [dieses Tool](https://github.com/GNOME/byzanz) unter Linux.
 - **Wenn das Spiel abstürzt**, füge den Absturzbericht bei. Dieser wird automatisch von Minecraft geöffnet. Füge den Absturzbericht in einem [Markdown-Codeblock](https://help.github.com/articles/markdown-basics/#multiple-lines), einem [Dateianhang](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/) oder in einem verlinkten [Gist](https://gist.github.com/) hinzu.
@@ -64,7 +64,7 @@ Für einen leichteren Einstieg in das Projekt gibt es `good first issue` und ` h
 ## Code
 
 ### Branch
-Der Branch Name ergibt sich aus dem Titel des Issues. Dabei steht UCAF für Feature und UCAB für Bug. Leerzeichen werden durch Bindestriche ersetzt. Das Template für Branches ist folgendes:
+Der Branch Name ergibt sich aus dem Titel des Issues. Dabei steht UCAF für Feature und UCAB für Bug. Leerzeichen werden durch Bindestriche ersetzt. Das Template für Branches ist Folgendes:
 - Feature (UCAF): `feature/UCAF-NUMMER-BESCHREIBUNG`
 - Bug (UCAB): `bug/UCAB-NUMMER-BESCHREIBUNG`