RayTheater

A Wrapper around RayLib, written in C++. Providing a Framework to take off some unfun burdens of Software development. Like:

• Automatic handeling of Window-Scaling.
• Switching between different Application-States / Views.
• Handeling Entities / Entity Components

Why does this exists?

Just because. :-)

(Also, so I can dust of my old C++ Books and maybe produce something that is reusable for other projects for once.)

How to add this to your own Project.

1.) this is depended on RayLib (https://www.raylib.com/) So make sure, you follow their Setup-Guide here first RayLib - Build and Installation

2.) Just copy the RayTheater.hpp into your own Project.

2a.) Copy any Additions, you want to have into the same folder

That is it. No further steps needed. The Setup-Process is pretty much inspired by the OneLoneCoder PixelGameEngine (https://github.com/OneLoneCoder/olcPixelGameEngine) (Always loved how simple it is to integrate into existing projects, so I wanted to mimik that)

Compiler Flags

All you need is at least C++11 and the IncludePath to your RayTheater.hpp. Since this is using RayLib, you obviously also need ot add flags to that lib and headers as well.

-std=c++11 -I/Path/To/Your/RayTheaterHPP -L/Path/To/RayLib/Lib -I/PathToRayLib/Headers -lraylib

How to use it in Code.

1.) Include the File

#include "RayTheater.hpp"

int main() {
    // ...

2.) define a Scene.

#include "RayTheater.hpp"
// Since RayTheater is just a RayLib addon, you have also
// access any function that RayLibs provides natively.
#include <raylib.h>

class MyScene : public Theater::Scene {
public:
    void OnStageDraw(Theater::Play p) {
        // Inside any of the "...Draw" method of RayTheater,
        // you can use RayLibs native Draw function
        DrawText("Hello World", 8, 8, 20, GREEN);
    }

    void OnStart(Theater::Play p) { /* Optional override */ }
    void OnUpdate(Theater::Play p) { /* Optional override */ }
    void OnWindowDraw(Theater::Play p) { /* Optional override */ }
    void OnEnd(Theater::Play p) { /* Optional override */ }
};


int main() {
    // ...

3.) Build the Stage and Play the Scene in your main - function

#include "RayTheater.hpp"
#include <raylib.h>

class MyScene : public Theater::Scene {
//...
};

int main() {
    MyScene ms;

    Theater::Builder(
        480, // Pixel width of the stage
        320, // Pixel height of the stage
        2    // Initial Window Scale (2x)
    )
        .Title("RayLib - Window 🎉") // Giving the Window
        .Play((Theater::Scene*)&ms);

    return 0;
}

Here is the full version of that code. You can just copy and paste it into your main.cpp, to check if your project setup works.

#include "RayTheater.hpp"
#include <raylib.h>

class MyScene : public Theater::Scene {
public:
    void OnStageDraw(Theater::Play p) {
        DrawText("Hello World", 8, 8, 20, GREEN);
    }
};

int main() {
    MyScene ms;

    Theater::Builder(480, 320,  2)
        .Title("RayLib - Window 🎉")
        .Play((Theater::Scene*)&ms);

    return 0;
}

Documentation

• Theater::Builder
  the entrypoint to your application.

• Theater::Scene
  is used to manage various actors within the application.

• Theater::Play
  Is proveded to The Scene and All Actors while the Scene is running.

  • Theater::Stage
    Provided through Theater::Play and is used to Add, Read, Remove or Modify Actors on the Stage.

• Theater::Actor
  These are the small entities that make up your Application

  • Components

    • Theater::Colliders
      Components, that describe an Actors shape for the Collision check.

    • Theater::Visible
      Allows an Actor to visually show up on the stage.

    • Theater::Ticking
      Allows an Actor to interact with the stage, even when not visible.

    • Theater::Transform2D
      [!todo] Allows other Actors or the Scene to manipulate the actors positioning on the stage.

  • Attributes [!todo]

Advanced Techniques (Pre-Compiler Magic)

• Custom-Attributes

Additions

RayTheaterUI.hpp

Contains predefined Actor-Classes, that can play UI-Components like Buttons and Labels
goto Documentation

• Buttons
• Labels
• Theming/Styling