enginemachiner/beat4sprite

It's a library for Outfox or StepMania 5+

beat4sprite

beat4sprite is a library to draw different things in the StepMania engine inspired by the classic DDR PSX backgrounds and sprite sheet animations.

beat4sprite has been tested through from StepMania 5.0.12 to 5.3 / OutFox.

beat4sprite on Youtube

How to install

0. Make sure you have tapLua.

OutFox

1. Copy the beat4sprite folder into the Modules folder of fallback.
2. Load the tapLua and beat4sprite module once in OutFox through fallback's first screen.
   

For example the ScreenInit overlay script should look like this using LoadModule():

StepMania

1. Copy the beat4sprite folder in your "Stepmania/Scripts" folder.
2. Reload scripts once at first screen if something goes wrong.

How to create

If you want to create your own animations you can check the Wiki.

Origin

beat4sprite began as a personal project in 2013.
I used to play with simple BGAnimations or RandomMovies ( Gameplay backgrounds ) on StepMania 3.9, mostly stuff from DDR or ITG. I was interested in the structure of the sprites and how the game read them.

I got inspired and I wanted to use the retro PSX animations so I tried making videos of them and that didn't blend that well with the song beat.

Then I considered video encoding, quality and file size not being the best so I moved to scripting and writing code (visually scripting) so I could draw my own animations.

Examples made with this library can be found through my repositories.
For more information about the API check the Wiki.

CREDITS

• Project Moondance developers
• RenTheHumanCat
• MadkaT
• leadbman
• Retrozaid

beat4sprite's Issues

Renaming parameters of the templates to similar same ones.

Like mainAngle, StaticAngle and SpinAngle in LineXY.lua compared to StaticAngle, SpinSprite and mainRotation in RoundTrace.lua.

Implement models (Def.Model) to be compatible

Kaleidescope texture scaling is still inaccurate

The texture is not 640x480 when there's different images with different resolutions.

Corruptions idea or Random sets of BGAs created with assets dropped by the user

.

The Kaleidoscope names have been changed to each Nth game.

K0X -> NthK0X

Need to check the BGChanges

Stop using arguments and use more commands if possible.

Some ActorFrames have too many arguments that are just to run certain functions. It would be better to just use a command and play it on the frame.

Quads scrolling might desync eventually

Sort mpg videos for each game

Implement loadfile()

Spin command on bitEye previews is off.

In Tile.lua

Slower effects or scripts

Some Scripts (effects) are more slower than they actually are in the original game.

Using ".." in the dir or path for params.File crashes the game.

For now I'll avoid using using ".." in dir or paths of params.File

When using X/Y_coords just add/sub (+-1) the X/Y_num parameters directly in TileTool.lua

That way there's no need to change X/Y_num on each Nth default.lua file when you change the orientation.

Redo Particles.lua and LineXY.lua as a radial system with polar coordinates.

.

Some actors don't reset upon calling the BGAnimation.

Some BGAs reset when they are called many times in BGChanges.

Example: 5thBG010

WallBumps.lua sprites get stuck occasionally

The Kaleidoscope effect can be recreated through AFTs to avoid the texture stretching

Not sure because AFT's are OpenGL only.
Or might as well add both OpenGL and D3D versions.

Remove scripts per game and just use one.

Do it whenever possible.