5panel.dance
↙️↖️⏺️↗️↘️
GitHub • YouTube • BlueSky • Discord • Ko-Fi
Info
- This page is a work in progress!
- Information here is subject to change. If you find inaccuracies or have suggestions, contact me!
- "Simulator" vs. "Emulator"
- Simulators recreate an experience from scratch using original code (eg. StepMania); emulators run the original code on platforms it was not made for (eg. running PIU Exceed PS2 in PCSX2)
Page Directory
5panel.dance/
└── guide/
└── Pump it Up Simulator Guide
├── Simulators
└── Simfiles
What Is a Simulator, and What Does it Do?
In terms of rhythm games, a simulator is a program that simulates the gameplay loop and mechanics of a given game. Simulators are generally free to play, and can either look entirely unique, or can visually resemble the game they're made to simulate.
Drawbacks of Using a Simulator
Simulators are built from the ground up to resemble the gameplay and mirror the core mechanics of a particular game. They're rarely (if ever) perfect, and most have noticeable flaws that can detract from the experience. This is true of all simulators.
When it comes to Pump it Up simulators specifically, the question of chart accuracy also comes into play. Most charts from 1st Dance Floor up to and including PRIME 2015 are decrypts. Decrypt charts are near identical to the originals, as they were converted to a simfile format from decrypted data originating from the official game. Everything including and after PRIME 2 2017 are recreations made by hand.
I'll go into more detail regarding simfiles, as well as particular pros and cons for each commonly used simulator, further down this page.
Remember:
Simulators aren't a replacement for official titles! Support Andamiro, and support PUMP IT UP!
Some Terminology
You might see some terms that you may not already be familiar with later on down this page. Here are a couple and what they mean!
Simfile: A file containing chart data for a simulator. Generally also used to refer to a complete bundle including audio and graphics.
SSC: The most widespread simfile format for Pump-style charts, made standard by StepMania 5. Modern simulators tend to use a slightly modified version.
BGA: Short for "Background Animation", refers to videos or sequences that display in the background during gameplay.
Disclosure
- Affiliation & Bias
- There are projects in this list that I am affiliated with, and there may be cases where my own personal experiences with particular projects and/or the people behind them may influence my feedback. I will do my best to make these cases clear for each entry, and highlight where those biases may be present. Only factual information will be listed in the pros and cons for each entry.
Noteworthy Simulators
There are a ton of simulators out there, and it can get confusing. Here's a (roughly) chronological list of modern, commonly used ones that you'll see mentioned frequently online. Every one has different quirks and features, which I'll be covering later.
Legend:
Recommended: Holds up for modern day use. Works with most content released today, or still has content being frequently released specifically for it. Recommend comparing with others that have this tag.
Maintained: Actively receiving bug fixes, features, or other improvements/updates.
Unique: A fun, standalone option that can play Pump charts without issue, but is otherwise its own thing.
Deprecated: No longer in development, and succeeded by a different program from the same developer or team.
Not Recommended: Works, but not very well. Buggy and/or inaccurate to the game's mechanics.
Discontinued: No longer in development, with no successor from the same developer or team.
Unmaintained: Not in active development, but not officially discontinued. May still eventually be updated.
Click any of the following to jump to its section:
- StepMania Not Recommended
The original dance game simulator. Simulates many different games. - StepF2 Deprecated
The first to accurately recreate a somewhat modern PIU experience. Developed by xMAx. - StepPrime Deprecated
The first public simulator themed after Pump it Up: PRIME 2015. Developed by the late PumpSanity team. - Infinitesimal Maintained Recommended
An original theme inspired by Pump it Up: Infinity. Uses the Project OutFox engine. Developed by Team Infinitesimal. - StepP1 Discontinued Recommended
The official successor to StepF2, themed after Pump it Up: PRIME 2015. Developed by xMAx. - StepPXX Deprecated
The successor to StepPrime. Themed after Pump it Up: XX 20th Anniversary Edition. Developed by the late PumpSanity team. - PumpSanity Discontinued Not Recommended
The successor to StepPXX. Includes Pump it Up: PRIME 2015 and XX themes, plus an original theme. Developed by the late PumpSanity team. - StepP1+ Maintained Recommended
A decrypted and community-maintained spinoff of StepP1. Includes Pump it Up: Phoenix scoring and other QoL improvements. Developed by rayden-61. - piured Maintained Recommended
A web-based simulator, one of the few on this list that is not based on StepMania. Requires a WebGL-compatible browser. Developed by piulin. - piuGBA Maintained Unique
A Pump simulator written from scratch for the GameBoy Advance. Works in emulators and on real hardware. Developed by afska. - Rave It Out Unmaintained Unique
A standalone, 5 panel dance game with a unique aesthetic, tighter timing, and a focus on pop music. Developed by the Rave it Out team. - FiveSteps Unique
A Pump simulator for Android devices! Supports StepF2/StepP1 simfiles, online leaderboards, and other neat features. - Jump to the Current Top Recommendation
StepMania
Not Recommended
StepMania was released in 2001 as a simulator for Konami's Dance Dance Revolution games. Over time, the codebase was expanded to add support for other gamemodes, including Pump. Every other simulator listed below is built on top of some version of StepMania 5.x, with extremely thorough and heavy-handed changes to fix bugs, issues, and inaccuracies, as well as to add features not present in the base StepMania 5.x engine.
Base StepMania (versions 4.x through 5.x) are not recommended for Pump simulation due to:
- Issues with hold notes and ticks not being counted or scored correctly;
- Incorrect hold note mechanics, where hold heds are subject to full tap note timing windows instead of just Perfect or Miss;
- Incorrect hold note mechanics, where hold heads cannot be held before reaching the receptors to count as a Perfect;
- A lack of accurate timing window scales;
- A lack of accurate lifebar mechanics;
- A lack of support for special notetypes widely used in Pump charts for visual effects, etc;
- An overall lack of maintainence regarding the "pump" gamemode, with no updates or fixes in a very long time
While custom charts made with these mechanics in mind do exist, they are exceptiomally rare, and the vast majority of players are not looking for this playstyle. Chart files made for other StepMania-based simulators will technically play in this engine, but they will not work correctly. Most official chart conversions are not playable on this engine.
Pros:
- Free
- Open source
- Large community
- Runs well on unmodified arcade hardware (MK9 and up)
Cons:
- Will not work properly for the majority of Pump content
- Essential mechanics are either entirely missing, or are not accurate to Pump
- Zero meaningful maintenance, fixes, or improvements for the "pump" engine in years
- Does not support PIUIO or cabinet lights, needs 3rd party driver to translate PIUIO to keyboard
- Cannot play PumpSanity simfiles
Platforms: Windows, Linux, Mac (<10.15)
StepF2
Deprecated
StepF2 is the first major modern Pump simulator to have been released. It is an accurate recreation of Pump it Up: Fiesta 2, using decrypted graphics and audio ripped from the official game. For many years, it was the most popular and widely used simulator available, and it defined the chart format still used by most modern simulators today. You basically have StepF2 to thank for the existence of most other modern simulators and content!
StepF2 is playable, performs well, and still holds up, but is deprecated, as it has been surpassed by StepP1 (which has, in turn, been surpassed by StepP1+).
Pros:
- Widespread content
- Includes official content up to PRIME 2015
- Large community
- Accurate mechanics and features up to PRIME 2015
- Runs well on unmodified arcade hardware (MK9 and up)
Cons:
- Somewhat dated, if that bothers you
- UI may be slightly confusing for players used to Pump it Up: XX or newer
- Missing adjustable AutoVelocity (AV)
- Hold timing is slightly more lenient than arcade
- Missing modern Phoenix-style scoring
- Does not support PIUIO or cabinet lights, needs 3rd party driver to translate PIUIO to keyboard
- Cannot play PumpSanity simfiles
Platforms: Windows
Download
StepF2 is bundled with StepP1 as its own executable.
StepPrime
Deprecated
StepPrime is weird. There are a lot of rumors to how this one started and where it originated. There are a lot of different projects that called themselves "StepPrime" and the history is really muddled. This will be focusing on the StepPrime released by the late PumpSanity team.
I don't know if StepPrime ever made it past the early alpha stage, but from my experience, it was very buggy and incomplete, though it's been long enough that I don't remember the specifics. It was functional, but definitely not the ideal experience. Most people I've talked to who tried it had a similar experience. It's easy enough to find references to it floating around the internet that I figure it's worth a mention in this list, but it's not worth seeking out. If you like the PRIME 2015 look, check out StepP1 or StepP1+.
StepPrime is deprecated and succeeded by StepPXX.
Pros:
- It looks like Pump it Up: PRIME 2015, if you're into that
Cons:
- Probably never made it past early alpha
- Multiple sources agree it was buggy and incomplete
- Missing adjustable AutoVelocity
- Very bootleggy
Platforms: Windows
Infinitesimal
Maintained Recommended
Infinitesimal is a theme for the Project OutFox engine, formerly known as StepMania 5.3. The visual style is inspired heavily by Pump it Up: Infinity, and the base game itself does not include any Pump it Up branding or copyrighted content. I started developing Infinitesimal in May of 2020. It gained traction over time as more contributors jumped on board, and as OutFox improved the "pump" gamemode engine, ironing out bugs and implementing new features.
For a while, OutFox was not as viable for Pump simulation due to long-standing problems with StepF2-style warps and issues with hold notes. As of November 28, 2024, the latest Alpha V test build fixed these issues. Warps and effects in charts like Conflict S22 will no longer instantly kill you, combos are counted accurately throughout effects, and most (if not all) charts previously considered unplayably work flawlessly. Accuracy will improve with time too, given this software is only in the alpha stage, and Infinitesimal will be bundled directly with future OutFox releases.
The project aims to recreate as much Pump functionality as possible plus tons of extra goodies, including but not limited to:
- Arcade-accurate, asymmetrical timing
- All timing window options available in PIU, plus extras
- Arcade-accurate lifebar with overflow
- Several types of speed mods, including arcade-accurate AV
- Options for classic or Phoenix-style scoring, letter grades & plates
- Chart previews on the difficulty select menu
- Options for experienced players (visualize lifebar overflow, accuracy, etc)
- All original UI/menu graphics and music
- USB profile support
- Pay mode support for fully legal public use (assuming you have the license or permission to use any added songs)
Infinitesimal is recommended and actively maintained.
Disclosure: I am the lead developer and designer behind Infinitesimal and have considerably involvement in the project. However, many major features were implemented by knowledgeable contributors, without whom it would not exist the way it does today!
Pros:
- Arcade accurate timing, lifebar, and scoring
- Options for Phoenix scoring, grades & plates
- Extra functionality for pros, or players who like seeing extra stats
- Compatible with most (if not all) StepF2/StepP1 charts (custom & official)
- Completely original graphics/music, not legally dubious
- Runs well on unmodified arcade hardware (MK9 and up)
- Multiplatform - supports Max and Linux, as well as ARM hardware
- Recent updates with several fixes mean that accuracy is at least on par with StepP1+
- Natively support for PIUIO/LXIO input devices means it's a nearly drop-in replacement on modern cabs
Cons:
- Setup is more involved than other simulators
- Engine is still in alpha, needs to be updated often
- Updates can sometimes cause weird crashes or bugs
- Some features are constrained by engine limitations
- OutFox's "pump" mode engine is incomplete and has some minor issues
- OutFox's "pump" mode engine does not yet support some visual effects found in many official songs
- Cannot play PumpSanity simfiles
Platforms: Windows, Linux, Mac
Download
Infinitesimal requires the Project OutFox Alpha V engine.
StepP1
Deprecated Recommended
StepP1 is the official successor to StepF2. It is a mostly accurate recreation of Pump it Up: PRIME 2015, using decrypted graphics and audio ripped from the official game. StepP1 was never fully completed and lacks features like basic mode, but being a continuation of StepF2's already rock solid engine, it holds up well and gameplay is very accurate. It only received one release, and is no longer being developed or maintained. There will be no future updates released by the original developer.
StepP1 is very playable, performs well, and holds up great, but is discontinued, as it has been improved upon with StepP1+.
Pros:
- Widespread content
- Includes official content up to PRIME 2015
- Large community
- Accurate mechanics and features up to PRIME 2 2017
- Includes PRIME 2-style adjustable AutoVelocity
- Runs well on unmodified arcade hardware (MK9 and up)
Cons:
- Stuck with any issues it currently has, due to being discontinued
- Hold note timing is slightly more lenient than arcade
- Missing modern Phoenix-style scoring
- Does not support PIUIO or cabinet lights, needs 3rd party driver to translate PIUIO to keyboard
- Cannot play PumpSanity simfiles
Platforms: Windows
StepPXX
Deprecated
StepPXX is the successor to StepPrime, developed by the late PumpSanity team, made to resemble Pump it Up: XX 20th Anniversary Edition. Not to be confused with StepXX, a different simulator also meant to resemble Pump it Up: XX, but never made it past extremely early development and was never quite playable. Pump it Up: XX has not been decrypted, and the graphics used are a mix of hand recreations and cropped sections from other media. Many sound effects and menu tracks don't quite line up, or suffer from poor audio quality.
StepPXX received infrequent updates and never really made it past the "early preview" stage, with a permanent watermark on the upper left corner. There were some attempts to implement an online matching feature, but it seems they were limited to a private build that was only distributed selectively, and I'm not sure it got a public release. StepPXX introduced a new simfile format, which accounted for some new modifiers that StepP1 did not support, but which rarely see widespread use. This new simfile format is an SSC versoin that is not compatible with StepP1 or any simulators made to use StepP1 simfiles, which pushed StepPXX simfiles into their own separate branch of the simulator community, starting a content accessibility divide that is still present today. Performance is also subpar on lower end machines, due to the security and encryption features present.
This was the first widespread simulator to include support for Mission or Quest zones from older mainline Pump it Up games, including the mission zones from Pump it Up: Infinity and Fiesta EX, and WorldMax from Pump it Up NXA.
Unlike other simulators themed around official releases, Pump it Up: XX was still actively supported and sold by Andamiro during the time of this project's release. Many freeplay arcades opted to install this software instead of purchasing a legitimate kit.
StepPXX is deprecated and succeeded by PumpSanity.
Pros:
- The first simulator to be themed after Pump it Up: XX
- Compatible with StepPXX simfiles (kinda goes without saying really)
- Somewhat widespread use, due to the novelty of looking like Pump it Up: XX
- Includes most modifiers present in the Pump it Up: XX command window
- Includes recreations of mission zones from previous Pump it Up titles
Cons:
- Hold notes are buggy and can cause seemingly random combo breaks
- Hold release timing is extremely strict and inaccurate
- Hold tick calculation is inaccurate
- Missing modern Phoenix-style scoring
- Security implementation is rather heavy, performace is poor on MK9 arcade hardware
- Extremely bootleggy, distributing a recreation of a current and supported game for free upon release
Platforms: Windows
PumpSanity
Discontinued Not Recommended
Oh boy, this one's got some history. Buckle up.
PumpSanity is the successor to StepPXX, developed by the late PumpSanity team. Its main attraction is the new "original" PumpSanity theme, which is primarily a reskin of the Prime theme with some extras added on. It also includes options for Pump it Up: PRIME 2015 and XX: 20th Anniversary Edition themes, recycled from StepPrime and StepPXX respectively, with some fixes and improvements.
PumpSanity received infrequent updates, and some content was paywalled behind their Patreon page. One big selling point for PumpSanity was its online matching feature, which differed from StepPXX's implementation by working via Discord integration, and requiring the player to be present in the official PumpSanity discord server to work. This feature no longer functions, and will cause the game to crash after finishing a song unless the player either closes Discord or blocks the application in the Windows Firewall settings. PumpSanity also continued and expanded upon their new simfile format, further branching off from StepF2's long-standing standard and widening the content accessibility divide; any charts made for PumpSanity will not function correctly in any other simulator.
Much of the game's built-in content was taken from the StepF2/StepP1 projects and redistributed with minor changes to fit the new engine. Other content was used without permission, such as simfile transcriptions (which I personally contributed to) meant to preserve the rare Pump it Up: The Fusion Sega Genesis port, and no credit was given to the original authors.
PumpSanity's use of copyrighted Pump it Up intellectual property became an issue when it was discovered that the Pump it Up: Infinity mission zone recreation was actually a near exact copy/paste of the actual mission zone code and graphical assets from a previously leaked development build. This led to a request issued by Team Infinity to remove any and all Pump it Up branding and intellectual property from the game, on behalf of Andamiro. The team was given the option to continue the PumpSanity project without this content, but they decided instead to discontinue the project of their own volition. There was originally planned to be a Linux-compatible build, including Phoenix scoring, but this would never be released.
Disclosure: I have had multiple personal run-ins with a member of the development team that were not positive, where past criticisms I made (i.e. describing inaccuracies, versus other inaccuracies in other simulators for the sake of comparison) were misinterpreted. More than once, I was pinged by this person in a private mutual Discord server with long-winded berating messages, phrased in such a way as to suggest that I was intentionally slandering or spreading misinformation about this project, which was not my intention. As a result, I am biased against using this project myself, and cannot in good faith recommend it to others.
Pros:
- Has a song search function, useful for large libraries
- Can recreate missions/quests a little more accurately
- Has an extra "rainbow Perfect" timing window
- The only accessible way to play StepPXX and PumpSanity simfiles
- Somewhat widespread use, due to the closed ecosystem of content & Pump it Up: XX theme
- Includes most modifiers present in the Pump it Up: XX command window
- Includes recreations of mission zones from previous Pump it Up titles
- Natively supports PIUIO
Cons:
- The game crashes after every song if Discord is open, unless you block it via Windows Firewall settings
- Hold notes are buggy and can cause seemingly random combo breaks
- Hold release timing is extremely inaccurate, though better than StepPXX
- Hold tick calculation is inaccurate
- Public builds are missing modern Phoenix-style scoring
- Includes content that was taken without author permission or credit
- Content exists in a closed ecosystem and locks out other established simulators
- Encryption and copy protection is rather heavy, performace is poor on MK9 arcade hardware
- May be a potential security risk due to janky and unmtained proprietary software integrations
- Extremely bootleggy, to the point where a takedown request was issued
Platforms: Windows (a Linux build was announced but never released)
StepP1+
Maintained Recommended
StepP1+ is a community-maintained successor to StepP1. It is an expansion of the Pump it Up: PRIME 2015, using decrypted graphics and audio ripped from the official game, with some extra assets borrowed from later games, and some original graphics. Some of the minor issues in StepP1 were fixed, including hold timing being made more accurate to arcade versions through hex editing. The theme and contents have also been decrypted, and are freely modifiable.
Many quality of life improvements have been added to the theme, such as:
- Phoenix-style scoring
- Phoenix-style letter grades & plates
- Profile level & experience points
- Customizable profile avatars
- Indicators for "tournament legal" charts
- Song title and progress indicators during gameplay
- And way more than will fit here - check out the full changelog!
StepP1+ is actively maintained and recommended.
Pros:
- Tons of compatible official and unofficial content
- Very stable, the only known crash being caused by having 0 songs
- Has an accompanying list of curated and maintained charts
- Available content up to Pump it Up: Phoenix
- Large community
- Accurate mechanics and features up to Pump it Up: Phoenix
- Includes PRIME 2-style adjustable AutoVelocity
- Runs well on unmodified arcade hardware (MK9 and up)
- Contains manu quality of life improvements over StepP1, especially for home use
Cons:
- Very minor hold note inaccuracies, which can't be fixed due to no engine source code availability
- Menus and UI are less accurate to official PRIME 2015, if that bothers you
- No option for old-style scoring and letter grades
- Incompatible with StepP1 high scores and profiles due to scorekeeping changes
- Limited Lua API, many SM5 functions were stripped from the engine (mainly affects developers)
- Does not support PIUIO or cabinet lights, needs 3rd party driver to translate PIUIO to keyboard
- Cannot play PumpSanity simfiles
Platforms: Windows
piured
Maintained Recommended
piured is a web-based simulator that runs entirely within your browser! It's the first of its kind, in that it was developed from the ground up without using StepMania, and without relying on borrowed source code from official games.
It does require an account to get started, but you can sign up directly on the webpage. It includes the vast majority of official songs, plus a few customs. There may be a small amount of content missing here or there, but piulin is very receptive to feedback; contact him if anything is missing! There are daily challenges available, where you can compete for a spot on the in-game leaderboard against other worldwide players, and you can check out content that's currently trending among the playerbase.
piured is recommended for anyone who wants to just jump right in and play without installing or downloading large amounts of content, and it's actively maintained!
Pros:
- Extremely accessible, only requiring a web browser that supports WebGL (most of them)
- Most (if not all) content is included, and piulin is great about adding whatever isn't
- Runs well on extremely low spec devices
- Very close to, if not exact, arcade accurate mechanics
- Open source
- Not StepMania!
Cons:
- Requires an account
- Requires a keyboard and mouse for menus, no pad controllable UI
- Loading times can be a little slow
- Requires an internet connection
- Relies on hosting for availability, and can periodically go down (potentially permanently, in the future)
Platforms: Anything with a WebGL-supported browser
piuGBA
Maintained Unique
piuGBA is written from the ground up in C/C++ for the GameBoy Advance. It supports the SSC format for charts, with features including:
- Normal, hold, and fake notes
- BPM, scroll, and speed changes
- Stops and delays
- Warps (both the #WARPS tag and high-BPM warps)
- HQ audio and background videos (flashcart only)
- Rumble
- I/O and SRAM LED sync
- PS/2 keyboard input
- Doubles/Vs/Co-Op play with another console via link cable
- Tons more, check out the GitHub page for more!
Different song packs are split into individual ROMs due to filesize limitations, but each ROM can contain plenty of songs. There are three types of ROMs: Campaign, Arcade, and Impossible. Campaign mode is kind of like mission zone, with unlock conditions for different songs. Arcade mode has all songs available for free play. Impossible mode throws fast-paced songs with hard to read modifiers at you, like blurring the screen and moving the notefield around.
Pros:
- Sick as hell
- Portable
- Works on emulators and real hardware
- Supports the majority of SSC features
Cons:
- GBA controls are a little limited
- Can cramp your hands
- Multiple ROMs can be unwieldy without a flashcart
Platforms: GameBoy Advance
GitHub
Information on obtaining pre-built ROMs is listed in the GitHub README file.
Rave It Out
Unmaintained Unique
Rave it Out is meant to be more of a standalone game of its own, rather than a Pump simulator. It has its own unique theme and features, timing windows, lifebar mechanics, scoring, and grading, and runs on a custom build of the StepMania engine, called SM-RIO. The game itself is themed around & prominently features North American pop music, but the engine has support built in for the StepF2 simfile standard, and can play most official converts.
Rave it Out is unique! It's unmaintained because it's essentially a finished project, for now. It's a lot of fun, and it feels polished and well made. There isn't really much else like it. Give it a shot if you're ever itching to change it up a bit and play for accuracy and score, or want to listen to something out of the ordinary.
Pros:
- Supports the StepF2 chart standard, so most conversions are playable with effects
- Visuals are clean, coherent, and stylish
- Refreshing change of pace, with varied mechanics and content compared to official Pump
- Made entirely with public domain assets & the theme is licensed as such, pay mode is OK
- Has a working hearts system
- Supports card readers, USB profiles, USB song loading, and addressable RGB lighting
Cons:
- Has a memory leak
- Doesn't support StepF2 co-op charts
Platforms: Windows, Linux
FiveSteps
Unique
FiveSteps is a Pump simulator for Android devices! I can't speak for this one personally, as I haven't used it before, but the project looks fantastic visually, and I've spoken to players who have very much enjoyed it. If you're looking to play PIU on the go, this is probably the next best thing from the official mobile game, which is long since discontinued.
I'm not sure how accurate FiveSteps' simulation of official arcade mechanics is. If anyone does know and/or has some sources for their information, please let me know and I'll update this entry!
Pros:
- Great for mobile devices
- Supports StepF2/StepP1 SSC files
- Cloud storage for your scores, etc
Cons:
- Touch controls can be iffy
- Not sure how accurate mechanics are
Platforms: Android
Okay, So What's the Best One?
That's the best part - there isn't! Every simulator has its own quirks, and everyone has their own preferences for what they're willing to sacrifice for the features they want. Below are my personal recommendations based on both my own experiences, and the options I have seen others choose using the information available to them. Keep in mind, there's nothing stopping you from trying more than one out to see what you think!
Stability: If you want something that is accurate, maintained, trusted, stable, and supports the widest range of content, then you want StepP1+.
Features: If you want something that is accurate and maintained with the most potential for customizability, despite occasional bugs and the fact that it's alpha software, then you want Infinitesimal.
Ease of Use: If you want to play RIGHT NOW without downloading a bunch of content, but don't mind some missing songs here and there with no ability to add your own, then you want piured.
What Are Simfiles?
"Simfile" can be a pretty loose term, but for our purposes, we can define a simfile as a file containing all of the chart data and metadata for a song.
This metadata includes all of the surface level information about a song (title, author, etc.), as well as paths to graphics, background/preview videos, and audio files for a single song.
One simfile can contain several charts. Simfiles are pretty much always accompanied by audio and graphics files. Collections of songs are released as simfile packs.
Here's an example of a typical simfile structure, using BRAIN POWER from the Pump it Up: XX simfile pack released by The Resistance Simfiles:
└── 1697 - BRAIN POWER/
├── 1697 - BRAIN POWER.ssc
├── 1697.mp3
├── 1697.png
├── 1697_B.png
├── 1697.mpg
├── 1697_P.mpg
└── 1697-wide.png
- 14 - XX: The simfile pack itself, containing several simfiles.
- 1697 - BRAIN POWER: The folder containing the simfile itself and other required assets.
- 1697 - BRAIN POWER.ssc: The simfile itself, in .ssc format.
- 1697.mp3: Audio for the song. Generally found in .ogg (preferred) or .mp3 format.
- 1697.png: The background image for the song, seen on the loading screen or in the background during gameplay.
- 1697_B.png: The banner image displayed on the song wheel on the song select screen.
- 1697.mpg: The background video, shown during gameplay. Generally found in .mpg format.
- 1697_P.mpg: The preview video, a cut-out section of the background video shown during song select. Generally found in .mpg format.
- 1697-wide.png: An alternate background image, but widescreen! Seen on the loading screen or in the background during gameplay.
Something important to keep in mind is that simfile layouts are very arbitrary.
It doesn't really matter what most of the files are called, aside from the extension, and not all of these have to be present. As long as there's a file that ends with ".ssc" that defines a path to a valid audio file, the simulator will recognize it and display it on the song select screen.- The majority of simfiles only include a handful of files, namely the SSC file itself, alongside a single background image, preview video, background video, and audio file. Simfiles from packs like the ones released by The Resistance are meant to be accurate to their arcade counterparts, and include song IDs that are as accurate as possible, to ensure they're sorted in the same order. Custom simfiles don't always try to adhere to this convention.
File Formats
Simulators support a variety of formats. Support differs slightly between many simulators, and some formats are generally preferred over others. Here's an overview.
Simfiles
-
SSC Recommended
The modern and most widely used simfile format. Developed by the Spinal Shark Collective for "sm-ssc", which eventually becamse StepMania 5. The SSC format has several revisions used for different simulators.
-
SM Outdated
The original simfile format used by StepMania in the early days, before sm-ssc. Much more limited and restricted than the SSC format. Used mainly for older games, like the Pump it Up: PRO series, which was built on StepMania 4 and used this format.
-
AMX Not Recommended
Made for StepMania AMX, a spinoff of StepMania 3.9 made by AldoMX. There isn't really a reason to use this anymore, but it's supported by select newer simulators, including StepF2/StepP1 and PumpSanity.
-
KSF Not Recommended
Made for Kick it Up, the first known Pump it Up simulator developed and released from 1999 to 2001. Kick it Up was technically an official project, developed by (at the time) members of the PIU development team! VERY outdated though, just including this because it's neat. StepF2/StepP1 support it, if you ever stumble across files for it!
-
UCS Limited
Not technically a simfile. UCS is a format used by official Pump it Up arcade titles, and stands for "User Custom Step." It's a very limited format, only really allowing for note placement and BPM changes. Included because most modern simulators technically support it.
Audio
-
OGG Recommended
An open, non-proprietary, patent/royalty-free compressed format. Highly recommended, due to widespread support and a lack of licensing/usage fees. Used in StepMania-based arcade games, like In the Groove.
-
MP3 Not Recommended
A proprietary, compressed format. Licensing, especially for commercial projects, is very restrictive. Size:Quality ratio is generally worse than OGG. Commonly used because of how well-known it is, but not recommeded.
-
WAV Not Recommended
A free-to-use, uncompressed format that doesn't require a license. Because it's uncompressed, filesizes can get rather large. Doesn't really provide any advantages over OGG for anyone that isn't playing exclusively with audiophile equipment.
Video
-
MPEG2
The most widely used codec, generally found in .mpg containers. Works the most consistly across all simulators.
-
MPEG4
More modern than MPEG2 and still widely used, generally found in .mp4 containers. Compatibility is hit or miss. For example, it tends to drift offsync in StepF2/StepP1/StepP1+ but plays back normally in Project OutFox.
-
AVI
An uncompressed format. Widely supported, but MASSIVE in filesize. Not recommended due to size.
Graphics
-
PNG
An compressed, lossless format. One of the two most widely used. Generally larger in size, but not enough to make a difference as long as you aren't bundling in unnecessarily large images.
-
JPG
A compressed, lossy format. One of the two most widely used. Very efficient on file size, without noticeable visual artifacts in most cases.
-
BMP
An uncompressed, lossless format. Contains its own colour palette for each individual image. Because each pixel is stored individually, filesizes can get quite large. Supported, but honestly just use PNG/JPG.
SSC Versions
This is a whole can of worms that I'll be getting into eventually. I'm leaving this as a stub for now until I have time to look further into it.
For now, the gist of it is that different simulators may use different revisions of the SSC format. For example, StepF2 uses SSC version 0.81, which is a version with slightly different behavior and specifications that was made and implemented for StepF2 by xMAx.
Some simulators, like Project OutFox, rely on this #VERSION tag to tell the engine how to interpret the chart, and whether it needs to handle specific things a specific way. StepF2 charts would not play back as expected in OutFox if the version number is not properly specified, because it's programmed to read StepF2 charts a little diferently from other "pump" charts.
Background Videos (BGAs)
Background videos, also known as BGAs, can sometimes trip up people who are new to simulation and/or charting.
My songs don't have BGAs! How can I add them?
The answer to this one is a little complicated - it depends on the simfiles.
Many simfile packs, such as the ones from The Resistance Simfiles, bundle the BGAs as part of a separate download. StepF2 and StepP1 simfiles also offer their BGAs as a separate download, which can be found on the official website. If the pack you use doesn't offer a separate download, it may be a lot more labour intensive to get them working; you may have to individually download BGAs online, and manually define and sync them in the SSCs by hand.
You will need to retrace your steps back to where you got your files, and see whether or not they have a separate download available. If so, you will likely have to download and extract the videos to the SongMovies folder. This folder should be present in the root of the simulator's install directory, beside the Songs folder. If you do not have a SongMovies folder, you can make it yourself and extract the files to it and it should work fine, it's nothing fancy!
Do I need BGAs? Can I remove them?
A common question is quether or not BGAs are necessary, and whether they can be deleted to save space. Typically, yes! You can delete BGAs if they take up too much room, and they are not a necessity to keep around. The majority of simulators have a default background animation or graphic that they display when dedicated files are not defined or present.
Most official simfiles store their BGAs in the SongMovies folder. If you're looking to free up some space, you can remove most of these - just do not remove Black.mpg or any equivalent! Other simfiles include their BGAs directly with the simfiles themselves, present in the same directory as the SSC file and such. These can also be deleted to free up space, but if you decide to do this, it's also a good idea to edit the SSC file directly in a text editor to remove any references to these files too.
What Is Lua?
Every once in a while you might encounter a simfile that contains .lua files. Lua is the scripting language used by StepMania for just about everything that isn't the engine itself.
In this case, the Lua files present in simfiles contain scripted modifiers that can do just about anything, from recreating effects found in official
Lua is way too in-depth and open-ended for me to be able to delve into here, but I'll at least provide some useful resources:
- Lua For SM5 by quietly-turning
- Modifier Files via Project OutFox wiki
- Introduction to Theming via Project OutFox wiki
Simfile Resources
Unfortunately, Pump simfiles are rather hard to come by nowadays. It's very difficult to compile a comprehensive list on a site like this, because of how spread out it all is. For now, here are the basics to get you started:
- The Resistance Simfiles: The go-to group for simfile pack recreations for Pump it Up: PRIME 2 and onward.
- PIU Simfile Hub: A Discord server I made for users to share their own work, and to link to others. Simfile creation support is also available!
- SMEditor: An up-and-coming, open source chart editor by tillvit. Available in-browser and as a download. Boasts some extremely cool features!
- ArrowVortex: A fantastic standalone editor, developed by Fietsemaker. It's much more intuitive than the built-in StepMania editor and has a ton of useful features.
I hate having to link to a Discord server instead of being able to provide these resources publicly without the need for an account, and for that I apologize. I would love to eventually be able to archive and make all of this information available without the need to join a server! I just don't have the time and resources available right now.
Gimmick Guides
I made a few gimmick guide videos a while back! I figure I should link them here as people have found them helpful. These are made using ArrowVortex, but the concepts work with any editor.