geefr/itgmania

Fork of StepMania 5.1, improved for the post-ITG community

ITGClarity

This is the latest attempt by ITGaz (geefr) to rework the rendering code.

At least until it's done cooking, the following are licenced as GPL3:

• src/calm
• Data/Shaders/calm
• All other changes against ITGMania upstream

Please don't try to use it outside ITGMania yet, specifically the 'clarity' branch of https://github.com/geefr/ITGMania

Once functional and integrated relatively neatly the intention is to push upstream - This may be an alpha quality OpenGL 4 renderer, or a more robust framework touching on the subjects such as vulkan or openxr (unlikely in 2024).

Past that point we'll see what happens, it shoulld be portable to other forks in some form. Significant draw-path modifications are required, with extensive rework to RageDisplay to even consider a deferred render path.

See Calm Renderer Readme for more info, and dev notes as I go.

ITGMania

ITGmania is a fork of StepMania 5.1, an advanced cross-platform rhythm game for home and arcade use.

Changes to StepMania 5.1

• Built-in network functionality
• Reload new songs from within the song select screen
• The mine fix applied (courtesy of DinsFire64)
• Held misses tracked in the engine for pad debugging
• Fixed overlapping hold bug
• Per-player visual delay
• Per-player disabling of timing windows
• New preference to control note render ordering
• Increased the Stats.xml file size limit to 100MB
• Changed the default binding for P2/back from hyphen to backslash

Installation

From Packages

For those that do not wish to compile the game on their own and use a binary right away, be aware of the following issues:

• Windows 7 is the minimum supported version.
• macOS users need to have macOS 11 (Big Sur) or higher to run ITGmania.
• Linux users should receive all they need from the package manager of their choice.

From Source

ITGmania can be compiled using CMake. More information about using CMake can be found in both the Build directory and CMake's documentation.

Resources

• ITGmania Website
• StepMania 5.1 to ITGmania Migration Guide
• Lua for ITGmania
• Lua API Documentation can be found in the Docs folder.

Licensing Terms

In short- you can do anything you like with the game (including sell products made with it), provided you do not:

1. Sell the game with the included songs
2. Claim to have created the engine yourself or remove the credits
3. Not provide source code for any build which differs from any official release which includes MP3 support.

(It's not required, but we would also appreciate it if you link back to ITGmania as well as StepMania.)

For specific information/legalese:

• All of our source code is under the MIT license.
• Songs included within the 'StepMania 5' folder are under the CC-NC license.
• Simply Love is licensed under the GPLv3, or (at your option) any later version.
• The copyright for songs in the 'Club Fantastic' folders rests with the original authors. The content is explicitly NOT placed under a Creative Commons license (or similar license), but has been provided free of charge, for personal or public use, including online broadcasting, tournaments, and other purposes. Go to the Club Fantastic website for more information.
• The MAD library and FFmpeg codecs when built with our code use the GPL license.

Credits

ITGmania Team

• Martin Natano (natano)
• teejusb

Contributors

• Club Fantastic
• DinsFire64 (Mine Fix)
• EvocaitArt (Enchantment NoteSkin)
• jenx (Fast Profile Switching)
• LightningXCE (Cyber NoteSkin)
• MegaSphere (Note/Rainbow/Vivid NoteSkins)
• StepMania 5
• Old StepMania Team