Skip to content
This repository has been archived by the owner on Sep 23, 2022. It is now read-only.

Latest commit

 

History

History
39 lines (29 loc) · 2.92 KB

README.md

File metadata and controls

39 lines (29 loc) · 2.92 KB

Discord Twitter Follow YouTube Channel Subscribers

Verany SkyBlock Dokumentation

Willkommen zur Dokumentation des SkyBlock Spiels. Hier findet ihr Anleitungen zur Installation, Konfiguration und Weiterentwicklung. Zusätzlich dazu findet ihr hier eine Dokumentation über die Bestandteile des Projektes, darunter zählen zum Beispiel die Branches- und ihre Aufgaben die (wenn vorhanden) Module und weitere wichtige Hinweise, die noch vor dem eigentlichen entwickeln wichtig für euch sein können.


Installation:

Die Installation des SkyBlock Spiels erfolgt über das Klonen in GitHub. Wir empfehlen dir für deine Projekte einen WorkSpace Ordner zu erstellen, in welchem du dann einen GitHub Ordner hast, in welchem widerrum nach Usern oder in unserem Fall Organisationen spezifiziert wird. In diesem Beispiel sieht das dann so aus:

D:\Dokumente\WorkSpace\GitHub\verany-network\skyblock

Das Projekt mit CLI klonen

gh repo clone verany-network/skyblock

Deployments & Tests:

Das Testen des SkyBlock Spiels erfolgt auf einem von uns dafür angelegten Mirror Server. Dort könnt ihr die Spigot API / Core voll ausschöpfen ohne euch Sorgen um die User auf unserem Produktions-Server machen zu müssen. Aufrufen könnt ihr diesen Service unter demo.verany.net. Bei einem Klick auf das entsprechende Projekt werdet ihr nach eurem Personal Development Key (PDK) gefragt. Dieser wurde euch bei eurer Teameinführung in dem Einführungsdokument übergeben. Dieser dient hier jetzt zur Identifizierung der Logins / Aktionen und somit auch als Passwort.

Um das Projekt auf eurem Stand überhaupt online zu bekommen müsst ihr jetzt noch den entsprechenden GitHub Workflow ausführen. Eine Auflistung der Workflows und ihre Funktionen findet ihr im Navigationsbereich unter Actions.


Branches:

  • production: Produktionsbuild (Wird automatisch auf die entsprechenden Dienste geladen)
  • release/*: Release Builds (z.B. release/2021.7.4, eine stabil laufende Version benannt nach dem Zeitpunkt)
  • feature/*: Feature Update Branch (z.B. feature/stats-update, für große Updates)
  • dev/*: Developer spezifischer Branch (z.B. dev/nicokempe, für kleine Änderungen und nur temporär ausgelegt)

Lizensierung:

Niemand außer der Administration selbst und dem Nico Kempe Einzelunternehmen steht es zu den geschriebenen Code ohne Erlaubnis zu verwenden. Bei eigenem Einsatz in das Projekt gibt man automatisch alle Rechte an der aufgewendeten Arbeit ab.