oat
/
uranium-core
1
0
Fork 0
Code Issues Pull Requests Releases Activity
The core of the Uranium Template
31 Commits 1 Branch 0 Tags 181 KiB
Lua 99.4%
GLSL 0.6%
Go to file
Jill d8056408f4 further actorframe cleanup 2022-09-23 23:07:36 +03:00
docs fix missing image 2022-09-19 19:17:47 +03:00
stdlib mirin. module. mirin. module 2022-09-23 23:02:17 +03:00
README.md remove id from md doc 2022-09-20 17:21:50 +03:00
actors.xml further actorframe cleanup 2022-09-23 23:07:36 +03:00
main.xml further actorframe cleanup 2022-09-23 23:07:36 +03:00
nop.frag shader support!! 2022-09-21 15:53:22 +03:00
nop.vert shader support!! 2022-09-21 15:53:22 +03:00
typings.lua cleanup, add typings 2022-09-23 23:07:36 +03:00

README.md

This is the development-oriented README. If you're looking to learn how to install and use the template, see MANUAL.MD.


Uranium Template


Uranium Template is a Love2D-inspired NotITG game development template, focusing on keeping things as Lua-pure as possible with enough abstractions to make you feel like you're not dealing with Stepmania jank at all.

But you probably already knew that; how do you develop this darn thing?

Installation

Installation follows the same steps as the manual installation - extract as a modfile, run as a modfile.

Distribution

During distribution, there are a couple of files that should be left out:

  • This very README.md - keeping it will be a little confusing, I think!
  • The docs/ directory - it's here solely for the logo, and is already included in the template itself.
  • The README.md at the root of the template - it doesn't serve much purpose outside of a repository.

Development

Everything related to the core functionality - loading actors, callbacks - goes in template/main.xml. It's not the most convinient, but I want to eventually move this out to its own Lua file.

Everything related to the standard library should go into template/stdlib/ - all files there are required by the user, so be mindful of filenames