An open-source 2D game engine made with Odin programming language and Lua as scripting language, inspired by Love2D and Godot Engine.

Website/Documentation | Discord

• Render images and texts with GPU acceleration (using native libraries like D11X, Metal, OpenGL)
• Audio playback and manipulation
• Input handling (keyboard, mouse)
• Gamepad support
• Scene management
• Lua scripting
• Cross-platform support (Windows, macOS, Linux)
• Simple and intuitive file system for asset management
• Simple Custom Shader support

• More animation features
• Network multiplayer support
• Particle system
• Maybe 3D support in the future
• Support with Tiled
• Native call support for C/C++ functions

• 🔩 What is Sucata?
• 🔧 Installation
• 📝 Getting Started
• 🌱 Examples
• 📚 Libraries
• 🙏 Special Thanks
• 🤔 FAQ

Sucata game engine is a 2D game engine made to be simple and easy to use, with a lot of features to make your game development experience better.

The goal is to make a create game experience similar good and smooth using only Lua scripting language.

curl -fsSL https://raw.githubusercontent.com/gumpdev/sucata/refs/heads/main/install_unix.sh | sh

irm https://raw.githubusercontent.com/gumpdev/sucata/refs/heads/main/install_windows.ps1 | iex

1. Install the sumneko lua extension on your favorite IDE
2. Open the Addon Manager
3. Search for 'sucata' and install

You can see the manual instalation here

Sucata game engine is data-driven, which means that you can create your game using only Lua scripts. The engine will load the scripts and run them, and you can create relational entities that will interact with each other.

An entity is a table that contains functions that will be called by the engine. The most important functions are:

• init(self): Called when the scene is loaded
• update(self): Called every frame to update the entity
• draw(self): Called every frame to draw the entity
• free(self): Called when the scene is unloaded

self parameter is a reference to the entity itself, so you can store variables in it.

Entity when spawned will have an id property that can be used to identify the entity.

Sucata works with classic by default

A scene is a pool of entities that will be loaded and unloaded together. You can load a scene using the sucata.scene.load_scene(entities) function, where entities is an array of entities.

By default Entities don't have childrens and parents, but you can create your own system to manage that with ids.

You can find entities by:

sucata.scene.find_by_id(id) -- Find entity by id sucata.scene.get_entities() -- Get all entities in the scene

You can spawn and destroy entities at runtime using the following functions:

sucata.scene.spawn(entity_or_id) -- Spawn a new entity sucata.scene.spawns(entities_or_ids) -- Spawn new entities sucata.scene.destroy(entity_or_id) -- Destroy an entity sucata.scene.destroys(entities_or_ids) -- Destroy entities 

You can add tags to entities to categorize them. To add a tag to an entity, just add a tags property to the entity table, which is an array of strings.

sucata.scene.add_tag(entity_or_id, tag) -- Add a tag to an entity sucata.scene.remove_tag(entity_or_id, tag) -- Remove a tag from an entity sucata.scene.get_entities_by_tag(tag) -- Get entities by tag

In Sucata, you can draw a rect or a text using the sucata.graphic module. Here are some examples:

sucata.graphic.draw_rect({ -- Draws a rectangle x = 100, -- X position y = 100, -- Y position width = 50, -- Width of the rectangle height = 50, -- Height of the rectangle color = "#ff0000" -- Color of the rectangle texture = "path/to/texture.png" -- Optional texture }) sucata.graphic.draw_text({ -- Draws a text x = 200, -- X position y = 200, -- Y position text = "Sucateado", -- Text to draw font_size = 24, -- Font size color = "#00ff00" -- Color of the text font = "path/to/font.ttf", -- Optional font })

In Sucata we have some prefix to access some paths easily:

src:// - Path to the source folder of the project

data:// - Path to the data folder of the user

Windows: %appdata%

Linux: ~/.local/share

macOS: ~/Library/Application Support

build:// - Path to the project build folder (where the executable is located)

To create a simple white square on the screen, you can use the following code:

sucata.window.set_window_size(512, 512) -- Defines the window size sucata.window.set_window_title("Empty Sucata") -- Sets the window title sucata.window.set_keep_aspect(true) -- Maintains the aspect ratio sucata.window.show_debug_info(true) -- Shows debug information local white_square = { init = function(self) -- Called when the scene is loaded self.x = 200 self.y = 200 self.width = 100 self.height = 100 end, draw = function(self) -- Called every frame to draw the entity sucata.graphic.draw_rect({ -- Draws a rectangle x = self.x, y = self.y, width = self.width, height = self.height, color = "#ffffff"	}) end } sucata.scene.load_scene({ white_square }) -- Loads the scene with the white square entity

To run your Sucata project, use the following command in your terminal:

sucata run . 

Will run the default project file there is main.lua in the current directory.

You also can run an specific entity to test only it:

-- Sucata Entity File Example local Object = require("classic") local Meteor = Object:extend() function Meteor:new() self.x = math.random(16, 496) self.y = -16 self.speed = math.random(100, 200) self.health = math.random(1, 5) end function Meteor:init() sucata.scene.add_tag(self, "meteor") end function Meteor:update() local dt = sucata.time.get_delta() self.y = self.y + self.speed * dt if self.y > 528 then Life = Life - 1 sucata.scene.destroy(self) end end function Meteor:draw() sucata.graphic.draw_rect({ x = self.x, y = self.y, width = 32, height = 32, texture = "src://sprites/meteor.png", origin = 0.5, atlas_size = 8, atlas_x = self.health - 1	}) end return Meteor

sucata run . --entity entity_file_name

entity_file_name needs to be in the lua require format, for example: entities.player for entities/player.lua file.

To build your Sucata project, use the following command in your terminal:

sucata build . 

Will build the project for the OS you are currently using.

The build files will be located in the build/ folder inside your project directory.

The project assets will be bundle to assets.sucata file inside the build folder.

Windows builds needs the lua54.dll and SDL3.dll file to run the project

A game inspired by the classic Asteroids game, where you need to survive as long as possible avoiding meteors.

Link

Some libraries used in Sucata Game Engine:

• odin - Programming language used to build the engine
• lua - Scripting language used in the engine
• sokol - Cross-platform development libraries for graphics, audio, and input handling
• sokol-tools - Cross-platform shader tools for building shader
• miniaudio - Single file audio playback and capture library
• lz4 - Fast compression algorithm for asset compression
• SDL3 - Simple DirectMedia Layer for gamepad support

• Ellora
• ThornDuck
• Randy

• I Found a BUG! Click here and open an issue
• Can I help with the project? Sure! just send your PR or idea
• Can I contact you? Yep, send email to contact@gump.dev