Crimson Rush

This project was created with the intention of learning scripting with a defined engine built in C++. Pairing this with ECS (Entity Component System) and exposing it to a scripting language like Lua the game related part of the application can be built using already defined functions from C++.

The rendering side of the application uses Raylib, the ECS is defined using EnTT and bridging between C++ and Lua is done with the Lua source code.

Features

List of functions that are exposed to and used in the Lua scripts

• Entity creation and removal
• Adding/removing/getting/setting components to entities. List of components:
  • Transform
  • Mesh
  • UI Element (text, colour, positions, size etc.)
  • Behaviour (init, update, collision. Called on C++ side of engine)
• Creation of Systems.
• Switching scenes
• Loading models and using strings to signify asset used (Resource manager)
• Getting input (keyboard, mouse)

Game implementation

Crimson Rush is a dungeon-crawler and rougelike inspired game all about exploring rooms and surviving as long as possible. The game is in top-down-view and the player has a pistol that is used to kill enemies encountered in the different rooms. When entering a room, the doors lock until the player has defeated all enemies. The player takes damage when coming in contact with an enemy

The map that is being explored by the player has a start and exit room. When the player reaches the exit room, the map is recreated and a new level has been reached. The player gets a little health boost as a reward. This is repeated until the player is dead and after a screen showing the level reached is shown.

Room creator

The game also comes with a room creator where the width, height and placement of doors and enemies can be decided. After deciding width and height a grid of tiles is created. The edges of the room are defined as walls and the rest floor. Left clicking the tiles changes the state of it. Floor tiles can change to enemy tiles and wall tiles can change to doors and vice versa. The colour of the tile represent the state of it.

Colours:

• ⬜ : Floor
• 🟥 : Enemy
• 🟦 : Wall
• 🟨 : Door

After saving a room, the contents is stored using a self defined file format called .room. This format use different characters to define the states of the tiles in the room.

Example:

----+----
---------
---------
-----*---
+-------+
---*-----
---------
---------
----+----

The plus symbol defines doors and the multiplication symbol enemies. The rest using the minus symbol are either floor or walls. When the game imports the room the position of the symbols in the .room file decides which tiles they affect.

Controls

• WASD - moving the player
• Mouse - rotating the player around the y-axis. Used for aiming
• Leftclick (Mouse) - shoot bullet
• P - pause/resume game

Building

Building the game is done using Visual Studio 2022 with the solution file provided. After building the application it can either be started using the "Local Windows Debugger" in Visual Studio or by starting the .exe file in the bin folder created.

(NOTE: If using the .exe file, make sure the folders Scripts/ and Resources/ also are added to the same folder. They are stored in the Application folder)