UshFramework - Simple 2D Game Framework

Why UshFramework?

Easy to Use

Write simple Lua code in a single main.lua file. No complicated setup, just start creating.

Packed with Features

Graphics, sound, input, animations, and scenes—all in a lightweight package for your 2D games.

Smooth Performance

Powered by SDL2, UshFramework ensures fast rendering and smooth gameplay.

Start Creating in Minutes

Try this simple example: move a square with arrows or WASD and press space for a sound.

local x, y = 400, 300
local speed = 200

function init()
    load_sound("click", "click.wav")
    set_volume("sound", 75)
    log("Game started")
end

function update(dt)
    if is_pressed("space") then
        play_sound("click")
    end
    if is_down("left") or is_down("a") then
        x = x - speed * dt
    end
    if is_down("right") or is_down("d") then
        x = x + speed * dt
    end
    x = math.max(0, math.min(x, width() - 50))
end

function draw()
    clear({r=20, g=20, b=40})
    rect(x, y, 50, 50, {r=255, g=100, b=100})
    text("Move with arrows or A/D, space for sound", 10, 10, 16, white)
    text("FPS: " .. get_fps(), 10, height() - 20, 16, yellow)
end

Steps to Start:

Download ush-installer.exe.
Create a main.lua file with the code above.
Add click.wav to your project folder.
Run ush run in your terminal.

Read the Full Docs

What’s New?

UshFramework v0.2.0

Released: May 26, 2025

Version 0.2.0 brings a big upgrade with a switch to SDL2, plus new features to make game development even easier.

Big Updates

Switched to SDL2: Better performance and compatibility for graphics, input, audio, and window management.
Updated rendering with SDL_Renderer for smoother 2D graphics.
New input system using SDL_GetKeyboardState and SDL_GetMouseState.
Added SDL_ttf for fonts and SDL_mixer for audio.

New Features

Camera: Move and zoom with camera_move and camera_zoom.
Scenes: Switch between game states using set_scene and register_scene.
Physics: Basic collision detection with create_body and get_collision.
Audio: Play sounds and music with play_sound and play_music.
Text: Render text with load_font and text.
Debug: Show FPS and physics outlines with show_debug.
Textures: Load and render with load_texture and sprite.
Timers: Schedule animations with timer.
Save Data: Store game progress with save and load.

Fixes & Improvements

Fixed input mapping with SDL_Scancode.
Improved error logging for scripts, fonts, and audio.
Optimized the main loop for better performance.

Note

Older Lua scripts (v0.1.x) need updates for SDL2 APIs. The Breakout game example is updated for v0.2.0.

Download v0.2.0

Make 2D Games, Simply