Skip to content
/ tiny Public

Tiny is a lightweight 2D game engine that allows developers to easily create games using the Lua programming language.

License

Notifications You must be signed in to change notification settings

minigdx/tiny

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

๐Ÿงธ Tiny Game Engine

๐ŸŽฎ Tiny is a lightweight, cross-platform game engine powered by Lua โ€” perfect for small games, game jams, and rapid prototyping.

Breakout created with Tiny Game Engine

GitHub release License: MIT


โœจ Features

  • ๐Ÿ–ฅ๏ธ & ๐ŸŒ Multiplatform โ€“ Runs on desktop and web
  • โœ๏ธ Lua scripting โ€“ Simple, flexible, and fast
  • ๐Ÿ”„ Hot reload โ€“ Instantly see your code changes
  • ๐Ÿชถ Lightweight โ€“ No bloat, just the essentials for small games

๐Ÿš€ Getting Started

Create your first game with just a few lines of Lua:

function _draw()
    -- draw a rectangle at {x: 10, y: 10} with the size {width: 100, height: 50} 
    shape.rectf(10, 10, 100, 50)
end

โžก๏ธ Read the Getting Started Guide to set up the engine and start creating!


โŒจ๏ธ CLI Commands

tiny-cli create <name>    # Create new game
tiny-cli run              # Run game
tiny-cli debug            # Run with debugger
tiny-cli serve            # Dev server with hot reload
tiny-cli export           # Export for web
tiny-cli palette          # Generate color palettes
tiny-cli sfx              # Sound effect editor
tiny-cli add              # Add resources to project

๐Ÿ“ฆ Download

Get the latest version from the Releases Page.


๐Ÿ“š Documentation

Full documentation is available on the Tiny website, including:

  • Engine setup
  • Lua API reference
  • Examples and tutorials

๐Ÿ—ฃ๏ธ A behind-the-scenes presentation was given at DroidKaigi 2024 โ€“ Tokyo:

Crafting Cross-Platform Adventures


๐ŸŽฎ Games Made With Tiny

Want to create games like these? Dive into the docs and start building:

Camping Type It Memory Pong One Light For Three Seconds Connect Me Meiro De Maigo 2 Freezming Gravity Balls Reflections


๐Ÿค Contributing

We welcome contributions!

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

๐Ÿ“„ License

๐Ÿงธ Tiny is open-source software licensed under the MIT License.

Use it freely in personal, jam, or commercial projects.


๐Ÿ› ๏ธ Tech Overview

Core Scripting Platforms License
Kotlin Multiplatform Lua Desktop, Web MIT