Requirements

• Operative System: Windows 11, Windows 10, Windows 8.1, Windows 7 Service Pack 1.
• RAM: 2GB or above
• Graphic Card: Any video Card 1 GB VRAM or Above.
• CPU: Any Processor 2.4 GHz or Above.
• DirectX Jun 2010 Redistributable: Download here
• Visual C++ 2022 Redistributable: Download (32 bits) Or Download (64 bits)

How to Install

• Unzip/UnRar Game
• Run the executable located in Program32/Program64
• Add Song groups to /Songs/ Folder or put the SongPack Zip File into /SongPackages/

StepF2 Simfiles conversion

You don't longer need an external converter, we have an in-built converter now. You just need to place your Song groups from STEPF2 into /Songs/ folder just like another common group. Once you start the game, these files are going to be converted and leave a backup file from the original simfile. Keep in mind that these converted simfiles will not be compatible with STEPF2 after conversion.

Game Configuration

Configuration

• Press F3 to open PumpSanity Configuration: Use this section to edit almost every option in this game.
• On PumpSanity Configuration: Use your arrows to navigate and press Enter to select.
• Press F1 to open the service Menu: This is the same as PumpSanity configuration, but with less options.
• On Service Menu: Press F1 to navigate, and F2 to select an option.

Profiles

1. Create a new profile to save your stats. Go into PumpSanity configuration > Profiles > Create New.
2. Enter a new name profile, press Enter to confirm and exit the screen with Escape key.
3. To select a profile, use DownLeft or DownRight in the Title Screen.

Calibration/Sync

• Go into PumpSanity configuration > Calibration/Sync.
• If you think you made a bad calibration, delete the file Preferences.ini from /Save/ folder.
• Deleting the file Preferences.ini will delete every option that you changed from PumpSanity Configuration.

Video Card Configuration

Nvidia

1. Open Nvidia Control Panel
2. Select 'Manage 3D settings' from 3D Settings
3. Search for 'Low Latency Mode' and set it to On
4. If you are under low graphic card and/or old video driver, search 'Maximum pre-rendered frames' and set it to 1

File Compatibility

• SSC: Stepmania 5 Sim File
• UCS: User Custom Step File (Pump it Up)
• SMA: Stepmania AMX File
• SM: Stepmania file (old)
• KSF: Kick it Up File
• BMS: BMS File
• DWI: Kilgamayan - Daisuke File

.ssc.ext Files (PumpSanity UCS extensions)

You can now create new steps and share only your step with your friends. This only works if you are using our SongPack (JUMP, MOBILE,RIO,PRO,PRO2,INFINITY,1STPERFECT,EXTRA-PREX3,EXCEED ZERO,NX-NXA,FIESTA,FIESTAEX,FIESTA2,PRIME,PRIME2,XX,PUMPSANITY) , once you create the step from the editor, the game will create a file in the song folder with an extension file (*.SSC.EXT) that you can send to your friends. Your friends should also use our SongPack.

*.UCS File support

We are giving support to *.UCS files converting it to our UCS EXT format. In order to avoid problems you should follow these steps. Your original ucs file will not be edited or deleted by the game.

Steps:

• Copy your *.ucs file to the song folder that you are looking for. (Example: Toccata from NX-NXA)
• Start the game. Once the first load finished, the game will create a ssc.ext file based on your UCS. The game will now use the extension ssc file (*.ssc.ext), if its not. Reload Songs from PumpSanity Options
• Open Step Editor, and now you can edit the chart and their properties. Remember to delete the *.UCS file to avoid overwritten issues

PIUIO support

We have an experimental PIUIO internal driver that you can try. In order to make it work you should follow these steps:

Steps

1. Uninstall IO2Key (In case you have it)
2. Download Zadig from here
3. Select your correct input device and select “WINUSB Driver”
4. Click “Install Driver”.
5. Once you start PumpSanity, the game should connect automatically to the dance

Double Display Perspective

Both StepMania and K-Pump draw note arrows in 3D space. The effect of this isn't visible in basic gameplay, but it can be seen clearly when mods that move the arrows alongside the Z axis are activated (sink, rise, nx, bumpy etc.)

Unfortunately, StepMania and K-Pump draw note movement alongside the Z axis differently. Since PumpSanity needs to simulate both StepMania and K-Pump based games, this causes a problem. Using K-Pump method to draw notes means that StepMania mods will look incorrectly. And similarly, using StepMania method will do the same to K-Pump mods.

To solve this:

#DISPLAYPERSPECTIVE ssc tag can be added to any chart to indicate which drawing method it should use.

1. #DISPLAYPERSPECTIVE:PUMP; - means that K-Pump drawing method should be used (this is the default).
2. #DISPLAYPERSPECTIVE:PRO; - means that StepMania drawing method should be used.

Custom Music Train

MusicTrain is an special song that contains a list of songs and steps that will be playable consecutively, up to 100! Creating a list is easier than you think; remember to follow these steps to make it work properly:

Requirements:

• Preview Banner file: Resolution (464x264), PNG/JPEG Format
• Preview Audio File: MP3/WAV/OGG Format, 12 sec length or less
• Preview Video File: MPG/MP4 Format (Optional) Max Resolution(640x360)
• Our SongPack (Recommended) or the Song Pack that you are sharing with the current musictrain.

Steps:

1. Create a folder in MUSICTRAIN folder (The folder name will be shown in the game)
2. Put your files (Banner,Audio, Video) in this folder
3. Create an INI file called MUSICTRAIN with a suffix in the MUSICTRAIN folder (IE: musictrain_First.ini). If you dont know how to create an INI File, open notepad and save the textfile with ini extension

MUSICTRAIN_* INI STRUCTURE (open your Musictrain_First.ini):

SONGS must have GroupFolder and the SongFolder to work properly. IE, if you want to add Desaparecer from XX, then you should write: 13.XX/16D0 – Desaparecer. If you are using a custom folder or custom song, then you should write the path from it

STEPS must have the step type, meter, and the label from the step. For example, if you want to use the Double 23 from Desaparecer, you should write, D23 or D23 NORMAL. If you want to use an UCS, then you should add D23 UCS

Songs and Steps Lists are sort manually, if the first song value in SONGS is Latino Virus, then the First value in STEPS must be a valid step from Latino Virus Song only. Same with the rest of the songs and steps.

This is the result of the first music train, if everything is good, you will be able to play it.

Custom Sort Channel

Custom Sort will give you a way to make a new Sort for songs from your Group Folder. Be aware that once you use custom Sort, the game will not play the category sound, and this custom sort will be only available when you enter your channel.

Create a new text file called sort in the Song group Folder and open it:

(1) PE328 - Gargoyle
(1) PE325 - Electrock
(1) PE327 - Frozen
(1) PE326 - EternuS	

Your Group Folder now will looks customized sorted

Favorites Channel

In this channel, your favorite’s songs are saved.
Hold the Center button when choosing the song to set it as Favorite. You will see a label (Red or Blue) that works as a favorite reference. You can save up to 300 songs in this channel. To delete a song from favorites, you need to repeat the sequence.

Coop Assist Mode

You wake up, turned on the PC and want to play some coop charts with your f... oh, so you don't have friends. We got you! On Select Music Screen, while choosing the coop step, press F8 to enable/disable the coop Assist Mode. How does it works? You can select what PlayerSide (NoteSkin) play, and the other side will be played automatically. Yes. You can play Tribe Attacker Co-Op X4 like a lone wolf just playing the 4th PlayerSide or Pink Fuzzy Bunnies Coop alone like a fricking psycho.

Coop Assist Mode activated for Player 1 NoteSkin. Player 2 noteskin is being pressed automatically and the color its less brigth

Stream Helper Integration

We are giving a dynamic tool for streamers, currently there are some features included on it, but we can still add more

Features

• Viewers can send song requests
• Viewers can send attacks to your current gameplay
• Viewers can react, and their reactions will be shown in gameplay

Installation

You need to use the tool, that will work as a bridge between the game and the stream service. We called it 3SL and it's open source. Before using this tool, you need to have Node.js installed. Download Node.js Here (Recommended: v18.12.1)

The current tool support Youtube and Twitch.Youtube and Twitch have no huge delay.

1. Download 3SL version 0.3a, you can download the tool here. Unzip the file in a new folder.
2. Open the file config.ini and complete the configuration, based on what service you are going to use. (Read Below)
3. Search the key: GamePath. And set the value with the Path of PumpSanity Game. (This is for reactions in game)
4. Always run the file runclient.bat after you executed Pumpsanity.
5. If connection is successful, you will recieve a Bonjour message, and a notification will be shown in the game.
6. Open PumpSanity Configuration in game, and select 'Client Helper Options' or 'Opciones de Ayudante del cliente' to change the settings of current features.

• Service Configuration

Twitch

1. Open the file config.ini and search the Twitch Section
2. Get the OAuth Password from your channel
3. Set your OAuth Password in config.ini - [Twitch] > 'OAuth' Key
4. Set your channel name in config.ini - [Twitch] > 'ChannelName' Key

[Twitch]
ChannelName=MyChannelName
OAuth=oauth:undefined
Username=undefined

Youtube

1. Open the file config.ini and search the Youtube Section.
2. Open the Studio Section on Youtube.
3. In Livestreaming section, extract the code from the url. (Check image below)
4. Set your LiveId in config.ini - [Youtube] > 'LiveId' Key.

Song Request Configuration

Open the config.ini and change the value (in seconds) for CooldownSongReqPerUser in [Global] section, this will apply a cooldown per user. You can also toggle this option (Before joining to gameplay) using the key CTRL + F6 on Select Music Screen.
Every Song Request is located in Song Request Channel (From Game Interface). You can disable if songs can be requested in gameplay.

Attacks Configuration

Open the config.ini and change the value (in seconds) for CooldownAttackPerUser in [Global] section, this will apply a cooldown per user. You can also toggle this option (Before joining to gameplay) using the key CTRL + F7 on Select Music Screen. Attacks will be applied in Gameplay. And user will be on cooldown.

Attacks: WhiteList

In case you want to allow some attacks that viewers can send, open the file mod_whitelist.txt, and type in a new line the attack that you want to recieve in gameplay Check the attack list here.

Reaction Configuration

Open the config.ini and set the value of GamePath from [Global] section to your current game path. This will locate the 'Reacts' folder, read every picture file, and users can send a react based on the filename image, exm: (yes). Reactions will be shown in gameplay.

• User Interaction

Attacks

Type in chat !a (attack) to send any attack, you can also separate attacks by comma, example !a beat (This command will only work if Streamer has 'attacks reciever' enabled)

Song Requests

Type in chat !r (song name). You can use a comma to specify a comment/detail of request, example: !r yog sothoth, s9 please. Comments should be less than 20 characters (This command will only work if Streamer has 'song request reciever' enabled).

Reactions

You should just type the name of any filename from the 'Reacts' Folder in game. Example: kannapogg . Remember, streamer should have this option enabled and also configured.

SimFile Information

There are new values that you can edit/add on your simfile

Set Auto Velocity

You can set the AutoVelocity on Editor to View/Edit your Chart under this Scroll Velocity.

Key Shortcuts

Tap Note Types

Division Mode

Division Mode is a great feature that can improve your stepchart, it will switch your stepchart to another chart of the same steptype in realtime gameplay, its conditional so you need to use it carefully.

Division Mode is a conditional segment function. The game will detect how many specific tapnotes (Items/Taps) were pressed before the segmented row, and will switch to an specified step chart if the condition is true.

In Step Editor, press F5 to open the Division Menu, fill the sections and select 'Set Division Condition' to store the condition in the current second.

Static Division Set (aka Special Division)

Special Division is an extra function that will convert Groove or Wild TapNote into a stepchart switcher. If the player press Groove or Wild TapNote, it will automatically switch to the destination stepchart.

Press Shift + F5 to open the Special Division Menu. And write the chart name destination for the specified TapNote.

Wrap and Wrap0

Wrap and Wrap0 are tapnotes that will automatically be pressed once it reach the receptor and their actions are switch to another stepchart
Wrap will switch to a random stepchart (with the same steptype) or switch to a random stepchart with the labelype 'Division'.
Wrap0 will switch to the stepchart that you select first to play.

Step Editor Tricks

Here are some tricks that stepmakers can use in their charts to customize them.

Using custom receptor noteskin in chart

For single, double, and double perfomance charts with level 50 or above, you can set a custom receptor. Insert a TapNote with a custom skin in the first column/row, if this TapNote is not part of the chart, you can set it with Fake Layer and Hidden Display Layer.

Editor: TapNote with perfomance 2 noteskin with layer Fake and Hidden on first row/column

Result: Perfomance Skin 2 Receptor in coop chart (double-perfomance)

Creating Quest Channel (Mission)

Quest Mods

Creating Quest Goal

There are two ways to create a quest goal, it can be based on LUA or INI. INI is only for basic requisite, while LUA is more advanced. These files should be attached in the same folder of the Song, and they can't be activated at the same time. So choose wisely.

Song Folder should contain the INI File or the LUA file (Lua file can have any name, and ini file should be called "QuestConfig" )

[S1]
GRADE=SSS
[S2]
GRADE=SSS,SS,S,A
[S3]
MISS=<25
[S4]
FLAG=BREAKOFF,AUTOPLAY	

Multiple Values on Keys

• GRADE: SSS, SS, S, A, B, C, D, F
• FLAG: QuestMode doesnt allow autoplay or breakoff, because autoplay will give you a failed mission, and breakoff will give you the stagebreak screen with a failed mission. Add these flags to allow the game pass the quest.
  • AUTOPLAY: Declare this stepchart has autoplay mod
  • BREAKOFF: Declare this stepchart has breakoff mod

This is an example of QuestConfig.ini. STEP1 requires Grade A or S to pass, STEP2 requires to press less than 80 Mines and it has breakoff mod activated, STEP3 requires MAXCOMBO more or equal than 200000 and 40 Potions with a lifebar of 50% or less, STEP4 needs only survive until the end.

Example: QuestConfig.ini

[S1]
GRADE=S,A
[S2]
MINE=<79
FLAG=BREAKOFF
[S3]
MAXCOMBO=>200000
POTION=40
LIFEBAR=<50
[S4]
						

Save the file, and test it in game to be sure its working.

LUA Goal

Creating a Quest Goal based on LUA could be difficulty, so you need to be careful of what are you doing here. if you are beginner we recommend you to start reading a manual from this language. LUA will help you IE to count Tap NoteSkins.
First at all you should create a text file with whatever name but with a LUA extension (Quest_Goal.Lua) in the song folder. And you need to link this file into the SimFile (ssc) You can add it from the StepEditor on #FGChanges, or add it manually opening the ssc file.

#FGChanges on Simfile, calling Quest_Goal.lua (should be located on Song Segment)

#FGCHANGES:-100.000=Quest_Goal.lua=1.000=0=0=1=====,;	

Open Quest_Goal.lua and define an Actor Frame as a return, and insert GameplayFinishMessageCommand

Quest_Goal.lua

local t = Def.ActorFrame
{
	GameplayFinishMessageCommand=function(self,params)
		local pnStageStats = STATSMAN:GetCurStageStats():GetPlayerStageStats(params.Player);
		pnStageStats:SetSuccess(true);
	end;
};
return t

This is a list of commands that will return a value, they are called from pnStageStats and after getting the values, you should set SetSuccess(true) command to make a MISSION SUCCESS otherwise it will get automatically MISSION FAILED.

This is an example of Quest_Goal.lua.
• STEP1 requires that PERFECT + GOOD + MISS less or equal than 100, 10 Hearts, LifeBar at 15%, MaxComboSkin of NXA Tap more than 30 and No StageBreak.
• STEP2 requires 10 Bad Old Noteskin tapnotes, 250 Perfects from Basic NoteSkin but it can allow BreakOff.
• STEP3 requires more than 35 Mines pressed, Grade S or Better, Score more or equal than 20000.
• STEP4 Only need to survive until the end.

Example: Quest_Goal.lua

local t = Def.ActorFrame 
{
	GameplayFinishMessageCommand=function(self,params)
	
		local pnStageStats = STATSMAN:GetCurStageStats():GetPlayerStageStats(params.Player);
		local bFailedAux = pnStageStats:GetFailedAux();
		
		local iPerfects = pnStageStats:GetTapNoteScores("TapNoteScore_W1") + 
				pnStageStats:GetTapNoteScores("TapNoteScore_W2") +
				pnStageStats:GetTapNoteScores("TapNoteScore_CheckpointHit");
		local iGood = pnStageStats:GetTapNoteScores("TapNoteScore_W4");
		local iMiss= pnStageStats:GetTapNoteScores('TapNoteScore_Miss') +
				pnStageStats:GetTapNoteScores("TapNoteScore_CheckpointMiss");
		
		local iHearts = pnStageStats:GetTapNoteScores("TapNoteScore_Heart");	
		
		local iNXAMaxCombo = pnStageStats:MaxComboSkin("nxa");
		local iLifePercent = pnStageStats:GetCurrentLife();
		
		if params.Label == "S1" then	-- STEP1
			local TotalRequire = iPerfects + iGood + iMiss;
			if not bFailedAux and TotalRequire <= 100 and iHearts == 10 and
				iLifePercent == 15 and iNXAMaxCombo > 30 then
				
				pnStageStats:SetSuccess(true);
			end;
		end;
		
		if params.Label == "S2" then	-- STEP2
			local iBadOlds = pnStageStats:GetTapNoteSkin("old", 'TapNoteScore_W5');
			local iBasicPerfects = pnStageStats:GetTapNoteSkin("basic", 'TapNoteScore_W1') +
					pnStageStats:GetTapNoteSkin("basic", 'TapNoteScore_W2') +
					pnStageStats:GetTapNoteSkin("basic", 'TapNoteScore_CheckpointHit');
					
			if iBadOlds == 10 and iBasicPerfects == 250 then
				pnStageStats:SetSuccess(true);
			end;
		end;
		
		if params.Label == "S3" then	-- STEP3
			local Grade  = pnStageStats:GetGrade();
			local iMines = pnStageStats:GetTapNoteScores("TapNoteScore_HitMine");
			local iScore = pnStageStats:GetScore();
			if iMines > 35 and iScore >= 20000 and not bFailedAux and
				(Grade == Grade_Tier3 or Grade == Grade_Tier2 or Grade == Grade_Tier1) then
				pnStageStats:SetSuccess(true);
			end;
		end;
		
		if params.Label == "S4" then	-- STEP4
			if not bFailedAux then
				pnStageStats:SetSuccess(true);
			end;
		end;
		
	end;
}

return t;