A game based on KShootMania and SDVX.
Download latest Windows build
Skinning Documentation
Demo Videos:
Current features:
- Completely skinnable GUI
- OGG/MP3 Audio streaming (with preloading for gameplay performance)
- Uses KShoot charts (
*.ksh
) (1.6 supported) - Functional gameplay and scoring
- Saving of local scores
- Autoplay
- Basic controller support (Still some issues with TC+)
- Changeable settings and key mapping in configuration file
- Skinning support
- Supports new sound FX method (real-time sound FX) and old sound FX method (separate NOFX & sound effected music files)
- Song database cache for near-instant game startup (sqlite3)
- Song database searching
- Linux/Windows/macOS support
Features currently on hold / in progress:
- Song select UI/Controls to change HiSpeed and other game settings
The folder that is scanned for songs can be changed in the "Main.cfg" file (songfolder = "path to song folder"
).
Make sure you use a plain text editor like Notepad, Notepad++ or gedit; NOT a rich text editor like Wordpad or Word!
If something breaks in the song database, delete "maps.db". Please note this will also wipe saved scores.
Controls
Default bindings (Customizable):
- Start: [1]
- BTN (White notes , A/B/C/D): [D] [F] [J] [K]
- FX (Yellow notes, L/R): [C] [M]
- VOL-L (Cyan laser, Move left / right): [W] [E]
- VOL-R (Magenta laser): [O] [P]
Song Select:
- Use the arrow keys or knobs to select a song and difficulty
- Use [Page Down]/[Page Up] to scroll faster
- Press [F2] to select a random song
- Press [F8] demo mode (continuously autoplay random songs)
- Press [F9] to reload the skin
- Press [F11] to open the the currently selected chart in the editor specified by the
EditorPath
setting - Press [F12] to open the directory of the currently selected song in your file explorer
- Press [Enter] or [Start] to start a song
- Press [Ctrl]+[Start] to start song with autoplay
- Press [FX-L] to open up filter select to filter the displayed songs
- Press [Start] when selecting filters to toggle between level and folder filters
- Press [FX-L] + [FX-R] to open up game settings (Hard gauge, Random, Mirror, etc.)
- Press [TAB] to open the Search bar on the top to search for songs
How to run:
Just run 'usc-game' or 'usc-game_Debug' from within the 'bin' folder. Or, to play a chart immediately:
{Download Location}/bin> usc-game {path to *.ksh chart} [flags]
Command line flags (all are optional):
-notitle
- Skips the title menu launching the game directly into song select.-mute
- Mutes all audio output-autoplay
- Plays chart automatically, no user input required-autobuttons
Like autoplay, but just for the buttons. You only have to control the lasers-autoskip
- Skips beginning of song to the first chart note-convertmaps
- Allows converting of*.ksh
charts to a binary format that loads faster (experimental, feature not complete)-debug
- Used to show relevant debug info in game such as hit timings, and scoring debug info-test
- Runs test scene, for development purposes only
How to build:
Clone the project and then run git submodule update --init --recursive
to download the required submodules.
Windows:
It is not required to build from source. A download link to a pre-built copy of the game is located at the beginning of this README. The recommended Visual Studio version is 2017, if you want to use a different version then you will need to edit the 'GenerateWin64ProjectFiles.bat' if you want to follow the guide below.
- Install CMake
- Install vcpkg
- Install the packages listed in 'build.windows'
- Run 'GenerateWin64ProjectFiles.bat' from the root of the project
- If this fails, try using the
-DCMAKE_TOOLCHAIN_FILE=[VCPKG_ROOT]\scripts\buildsystems\vcpkg.cmake
flag that vcpkg should give you on install
- If this fails, try using the
- Build the generated Visual Studio project 'FX.sln'
- Run the executable made in the 'bin' folder
To run from Visual Studio, go to Properties for Main > Debugging > Working Directory and set it to '$(OutDir)' or '..\bin'
Linux:
- Install CMake
- Check 'build.linux' for libraries to install
- Run
cmake .
and thenmake
from the root of the project - Run the executable made in the 'bin' folder
macOS
- Install dependencies
- Homebrew:
brew install cmake freetype libvorbis sdl2 libpng jpeg libarchive
brew link -f libarchive
- Homebrew:
- Run
cmake .
and thenmake
from the root of the project. - Run the executable made in the 'bin' folder.