The core of the Uranium Template
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Jill 912bb8f234
input: fix uranium.call typo
1 week ago
docs fix missing image 9 months ago
stdlib input: fix uranium.call typo 1 week ago
uranium input: fix uranium.call typo 1 week ago
.gitignore release info setup 8 months ago
README.md update distribution script instructions 9 months ago
actors.xml further actorframe cleanup 9 months ago
main.xml split code a lil better 1 month ago
nop.frag shader support!! 9 months ago
nop.vert shader support!! 9 months ago
typings.lua avoid leaking uranium stuff into globals 1 month ago

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.

If you're on Linux or have MSYS2/WSL/similar installed, you can use the distribution script.

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