redstoner-2019 / redengine

Game Pipeline

Pipeline Version: 0.1-alpha-1
Dokumentation Stand: 26.10.2023 12:00

1 Getting started

1.1 Die JAR installieren

Hier erkläre ich kurz wie die .jar in das Projekt in IntelliJ eingebunden werden kann.

1. Lade die neuste Version der Engine von https://github.com/Redstoner-2019/RedEngine/releases herunter.
2. Nach dem Download öffne IntelliJ und gehe über File > Project Structure in die Projekteinstellungen.
3. Klicke jetzt auf Libraries und dann auf das kleine + oben links.
4. Klicke jetzt auf Java und wähle die .jar Datei aus.
5. Klicke jetzt noch einmal auf Ok und das Setup ist Fertig!

1.2 Ein Fenster Erstellen

Um ein Fenster zu erstellen muss nur ein Camera Objekt erstellt und mit .start() gestartet werden. Daraufhin wird sich ein Fenster mit der Größe des Monitors öffnen.

Ein Beispiel:

Camera camera = new Camera(new ArrayList<>());
camera.start();

Wie man bereits sieht wird bei der Erstellung des Camera-Objekts eine Liste mit übergeben. Diese Liste ist eine Liste des Typs String. Diese Liste sind die Texturen die direkt nach dem Start des Fensters geladen werden. Wenn als Beispiel

Camera camera = new Camera(Arrays.asList("grass.png"));

verwendet wird, dann wird die Textur grass.png in dem Ordner resources/textures/ geladen. \

WICHTIG!

Texturen müssen ZWINGEND im PNG format sein, ansonsten können diese nicht geladen werden!

Es ist allerdings auch möglich einfach eine leere Liste zu übergeben (Nicht null!), dabei werden dann keine Texturen direkt geladen.
Wenn man den obrigen Code so ausführt gibt es aktuell jetzt noch das Problem dass das Fenster einfach Weiß ist und es die Meldung Keine Rückmeldung! gibt. Dafür muss eine Render-loop erstellt werden. Dies ist einfach zu tun.\

Dafür können wir einfach

List<GameObjectData> objects = new ArrayList<>();
List<Shader> shaders = new ArrayList<>();

while (!camera.shouldWindowClose()) {
    camera.render(objects, shaders);
}

verwenden. Was tut dieser Code jetzt allerdings?
Zunächst werden 2 Listen erstellt. Eine Liste vom Typ GameObjectData und eine Liste vom Typ Shader. Die Namen dieser Listen sind irrelevant, es sind nur die Datentypen wichtig. In diesem Fall in der objects-Liste werden die Objekte welche Gerendert werden sollen an die Kamera übergeben und gerendert. Hierbei ist zu beachten, dass das erste Element der Liste als erstes gerendert wird und somit von später gerenderten Objekten überlagert werden kann!
Dieser Code reicht jetzt aber erst einmal aus um ein Fenster zu erzeugen.

1.3 Das Fenster einstellen

Als nächtes kommen wir zu nützlichen Dingen die man an dem Fenster einstellen kann.

Zuallererst wollen wir uns die Framerate (Also FPS) im Fenstertitel anzeigen lassen. Das ändern des Fenstertitels ist mit dem folgenden Code einfach getan:

camera.setTitle("Hello World!");

Wenn wir diesen Code in die while-schleife einfügen wird sich der Fenstertitel auf Hello World! ändern. Wir wollen aber die Bildrate anzeigen lassen. Dafür können wir die Methode camera.getFps() verwenden. Wenn wir jetzt den Code auf z.B.

camera.setTitle(camera.getFps() + " FPS");

ändern wird uns jetzt im Fenstertitel die Bildrate angezeigt!

Der Komplette Code bisher sollte nun etwa so aussehen:

public static void main(String[] args){
    Camera camera = new Camera(new ArrayList<>());
    camera.start();
    
    List<GameObjectData> objects = new ArrayList<>();
    List<Shader> shaders = new ArrayList<>();
    
    while (!camera.shouldWindowClose()) {
        camera.render(objects, shaders);
        camera.setTitle(camera.getFps() + " FPS");
    }
}

1.4 Rendern von Texturen

Allerdings ist ein schwarzer Bildschirm nicht sonderlich interessant. Daher kommen wir jetzt zum wichtigen Thema, wie kann man Texturen auf den Bildschirm rendern?
Dafür muss die Textur zunächst geladen werden. Dafür kann man einfach ein neues Texture Objekt erzeugen. Dazu muss eine URL angegeben werden wo sich das Objekt befindet. Dort kann man z.B. wie in diesem Beispiel mit Resources.getResource("textures/texture.png") eine URL zu der Textur Datei erzeugt werden, welche sich in diesem Fall im resources/textures/ Ordner befindet. Diese URL kann an das Objekt weitergegeben werden. Der Code dafür sieht folgendermaßen aus:

Texture texture = new Texture(Resources.getResource("textures/skyTexture.png"));

Diese Textur kann nun der Kamera zugewiesen werden, damit die Kamera weiß wo sich die Textur befindet:

Texture texture = new Texture(Resources.getResource("textures/skyTexture.png"));
camera.addTexture(texture,"sky");

Das zweite Argument in diesem Fall ist der "Pfad" an dem sich die Textur befindet. Dieser muss in einem GameObject angegeben werden damit die Kamera weiß welche Textur auf das GameObject angewendet werden soll.
Ein GameObject kann folgendermaßen erzeugt werden:

GameObject object = new GameObject(new Vector2(0, 0),"sky");

In diesem Fall sehen wir direkt, dass wir 2 Argumente für das GameObject beötigen. Das erste ist die Position des GameObjects. Dieses wird als Vector2 angegeben, in diesem Fall befindet sich das Object bei 0 / 0.
Das zweite Argument ist die Textur des Objekts. Diese kann Nachträglich noch geändert werden, muss aber vorher der Kamera als referenz wie im vorherigen Schritt zugewiesen werden! Dieses sollte VOR der while-schleife erzeugt werden und der objects-Liste von vorhin hinzugefügt werden. Wenn wir dies nun tun wird dieses Objekt auf dem Bildschirm erscheinen.

Der volle Code sieht nun so aus:

public static void main(String[] args){
    Camera camera = new Camera(new ArrayList<>());
    camera.start();

    Texture texture = new Texture(Resources.getResource("textures/skyTexture.png"));
    camera.addTexture(texture,"sky");

    GameObject object = new GameObject(new Vector2(0, 0),"sky");

    List<GameObjectData> objects = new ArrayList<>();
    List<Shader> shaders = new ArrayList<>();

    objects.add(object);

    while (!camera.shouldWindowClose()) {
        camera.render(objects, shaders);
        camera.setTitle(camera.getFps() + " FPS");
    }
}

2 Input

2.1 Keyboard Listener

Um Tastatureingaben auszulesen muss lediglich ein KeyboardListener erstellt werden.

KeyboadListener keyboadListener = new KeyboadListener(camera);

Dieser muss bei der Erzeugung der Kamera zugewiesen werden.

Jetzt kann innerhalb der Gameloop mithilfe von z.B.

if(keyboadListener.isKeyDown(GLFW.GLFW_KEY_W)){
    System.out.println("Hello World!");
}

Hello World! ausgeben, SOLANGE die Taste W gedrückt ist.

Hier gibt es allerdings unterschiede in den Funktionen des Listeners.

isKeyDown()

Diese Methode prüft ob die Taste AKTUELL gedrückt ist.

isKeyPressed()

Diese Methode prüft ob die Taste gedrückt wurde. Sie gibt nur 1 Mal true zurück bis die Taste erneut gedrückt wird.

isKeyReleased()

Das gleiche wie bei isKeyPressed(), allerdings beim loslassen der Taste.

2.2 Mouse Listener

Der MouseListener kann die Position des Mauszeigers abrufen. Der MouseListener kann NICHT prüfen ob eine Maustaste gedrückt ist, dafür wird ein MouseButtonListener benötigt.

Ein MouseListener kann folgendermaßen erzeugt werden:

MouseListener mouseListener = new MouseListener(camera);

Jezt kann man mithilfe der Methode .getLocation() kann jetzt ein Vector2 von der Position des Mauszeigers erhalten werden.

2.3 Mouse Button Listener

Mit einem Mosuse Button Listener kann man auf interaktion von Tasten auf der Maus Prüfen. Er kann folgendermaßen erzeugt werden:

MouseButtonListener mouseButtonListener = new MouseButtonListener(camera);

Dieser listener hat die Methode isKeyDown(), diese gibt true zurück, solange die Taste gedrückt ist.

3 Setup der Kamera

Wichtig! Die folgenden Methoden können erst vewendet werden nachdem die Kamera mit

camera.start();

initialisiert wurde!

3.1 VSync

VSync ist standardmäßig bei der Erzeugung der Kamera aktiviert. Um es zu deaktiveren, bzw. später wieder zu aktivieren kann

camera.setVsync(true);

bzw.

camera.setVsync(false);

verwendet werden.

3.2 Position

Die Position der Kamera kann mit folgenden Funktionen gesetzt bzw. abgefragt werden:

camera.setCameraPositon(new Vector2(0, 0));
camera.getCameraPositon(); //Gibt einen Vektor2 zurück

3.3 Mouse Enabled

Um die Maus auf den Frame nicht anzuzeigen kann

camera.setMouseEnabled();

verwendet werden.

3.4 Titel

Um den Titel des Frames zu bearbeiten kann

camera.setTitle("Hello World!");

verwendet werden.

3.5 Texturliste

Um die Texturliste nachträglich zu setzen kann

camera.setTextureList();
camera.getTextureList(); //GIbt die aktuelle Liste zurück

verwendet werden. Diese Methode nimmt eine HashMap<String,Texture>.

3.6 Fullscreen

Um den Vollbildmodus zu wechseln kann

camera.toggleFullscreen();

verwendet werden.

3.7 Größe

Um die größe des Fensters abzufragen können die Methoden

camera.getWidth();
camera.getHeight();

verwendet werden.

3.8 Fenster ID

Die Methode

camera.getWindow();

gibt die LWJGL windowID zurück. Diese ist in fortgeschritteneren Anwendungen wichtig.

3.9 Delta Time

Mit

camera.getDeltaTime();

kann die aktuelle deltaTime abgefragt werden. Diese ist wichtig, dass z.B. Bewegungen bei unterschiedlichen Bildraten gleich sind.

3.10 FPS

Um die aktuelle Bildate abzufragen kann

camera.getFps();

verwendet werden.

3.11 Anzahl gerenderte Objekte

Die aktuelle Anzahl der gerenderten Objekte kann mit

camera.getObjectsOnScreen();

abgefragt werden.