Skip to content

bmjoy/uRetroEngine

 
 

Repository files navigation

uRetroEngine

Unity retro game framework with lua support

FEATURES:

  • user defined screen size (limitation is only performance)
  • defined screen origin (top-left / bottom-left)
  • load color palette from image (default 16)
  • load sprite sheet from image (limitation is only memory)
  • load font from image (limitation is only memory)
  • create tilemap
  • for scripting is used NLua for unity
  • you can import module/dll in main.lua code (UnityEngine included)
  • command line argents
  • build-in console with commands to manage cartridge
  • build-in code profiler (user defined start/end places, more in wiki)
  • you can create retro game and build to PC/MAC/Linux/Androis or Mac using uRetro classes
  • or create universal player and via lua script create game outside of unity

BUILD:

  1. Open scene Assets\uRe-Runner-LUA\Scenes\Test-uRetroEngine-LUA.unity
  2. Select scene object uRetroEngineCanvas-LUA
  3. Press button [Build RetroeEngine] from inspector on uRetroEngine_Runner_LUA component
  4. Optional: Press button [Move cartridges] from inspector when you made any changes from editor

EXECUTE:

Start game from expanded cartridge (from folder):

uRetroEngine.exe -game LuaGame -resolution 1280 800 false

*- load folder LuaGame and set resulution*

> Start game from cartridge only:

uRetroEngine.exe -cartridge LuaGame -resolution 1280 800 false

*- load cartridge and run game in defined resolution*

Start engine without game

uRetroEngine.exe

*- press F1*
*- press enter and write to console cmd help*

Create new cartridge folder tmeplate:

uRetroEngine.exe -create LuaGame

*- create cartridge folder template*

License:

Licensed under the Microsoft Public License (MS-PL) License. See LICENSE file in the project root for full license information. The code supplied is totally free for either personal or commercial use, with no warranties.

uRetroEngine is Copyright (c) 2017 Ondrej Kollar. All rights reserved.

About

uRetroEngine is Unity retro game framework with integrated LUA as scripting language

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 97.3%
  • Lua 2.2%
  • Other 0.5%