Sitelet https://github.com/Slushi-Github/HxNotITG
Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HxNotITG

HxNotITG Logo

Now Haxe is on NotITG too, why not? :3

So... yeah, this is a small template along with a special library to create modcharts with Haxe in NotITG, once again taking advantage of the wonders of Reflaxe, this time from Reflaxe/Lua, and from Mirin Template to be able to use conventional Lua in NotITG instead of its XML-based Lua.

See the TODO list for future features.

See the CHANGELOG for changes in the past.

Caution

This library is in alpha state, it is extremely experimental and can very easily generate invalid code or behave incorrectly, modcharts in NotITG are something I don't know much about!.

Please keep something in mind, this project is made for a very specific purpose, if you are not already familiar with Haxe or it is not your favorite or main language, honestly, use Mirin Template directly with Lua, which is an easier language to understand and learn. Don't criticize the project or anyone who tries to use it just because they prefer something that seems more “difficult” at first; some of us are more used to Haxe than to Lua...

Due to the apparent structure of a song in NotITG, I cannot fully cover the use of Haxe for everything, there will be things that you will probably still have to do in Lua or XML.

Installation and usage

Assuming you already have Haxe installed...

In the folder where you will create your new song in NotITG, for example Songs/Slushi/Haxe test, first of all we need Mirin Template, this is the base of this project, download it from here (or from the GitHub "Code" button) and copy the contents of what you downloaded into your song folder (or follow the official guide)

Now you need this template, same thing, download it from here (or again, from the GitHub "Code" button) and copy the contents (you can skip copying the docs, .gitignore and .gitattributes TODO.md, and folders/files like that if you want) into your song folder, it will usually ask you to replace files, do it!

Now you need the library used with this template, you have two ways to get it:

Get it from haxelib (not available yet):

haxelib install hxnotitgframework

Or from GitHub:

haxelib git hxnotitgframework https://github.com/Slushi-Github/HxNotITGFramework.git

Finally, you need Reflaxe and Reflaxe/Lua:

haxelib git reflaxe https://github.com/SomeRanDev/reflaxe.git
haxelib git reflaxe.lua https://github.com/Davvex87/reflaxe.lua.git

And that's it! now you can edit haxeSrc/HaxeResult.hx to create your modchart, and convert it to Lua using haxe build.hxml in your song directory, and that's it, you have your modchart in Lua working in NotITG! Remember to run haxe build.hxml every time you make a change in your Haxe code.

Documentation

This part is still being planned, it's best to check Mirin Template stuff on its website, such as the modifiers list

Credits

  • Mirin Template: The base of this project and a good way to use NotITG with Lua easily.

  • Reflaxe: An incredible library to use Haxe in unexpected places hehe.

  • Reflaxe/Lua: Without this, I wouldn't be able to generate truly functional and independent Lua code compared to what Haxe originally generates.

License

This project is under the MIT license.

About

Now you can use Haxe on NotITG, just what we needed, right?

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages