StepMania Song Manager
A cross-platform utility app for StepMania that downloads and automatically updates song ("simfile") packs hosted in Amazon S3 buckets (or any bucket that can interact with the S3 API).
Made with Electron and Vue.js via the Quasar framework.
Development
# Install dependencies
yarn
# Start app in development mode (hot-code reloading, error reporting, etc.)
yarn dev
# Lint files
yarn lint
# Build app for production
yarn build
Contributing
Want to help make the app better? Feel free to fork the repository, make changes, and create a pull request! Just make sure that your pull requests target the develop branch only.
Using the App
Adding Song Packs
Simply click on the + Add Songs button and select a bucket from the list. You can also add a new S3 bucket that is not already in the list, in which case the name of the S3 bucket is required. For buckets hosted outside of Amazon, the endpoint URL of the bucket is required as well.
Once selected, the chosen bucket will then be displayed on the main page where you can view the songs in the bucket, download all files in the bucket, or remove the bucket from the app.
Note: Removing a bucket from the app will only hide the songs from StepMania, and not delete any local files from your computer. This is to prevent re-downloading any files unnecessarily should you decide to re-add the bucket. If you want to completely remove the downloaded packs from your computer, you can manually delete the files and folders yourself.
Updating Song Packs
Once downloaded, all song packs will automatically be detected and playable in StepMania the next time you run the game (as the download path for each bucket is automatically added to the AdditionalSongFolders variable in StepMania's Preferences.ini file).
The packs will also be updated automatically as long as the app is open or running in the background. The app itself will check for and download updates periodically, or you can perform a manual update by clicking on the Update button for each bucket.
Settings
The settings page includes the following parameters, which are set to their default values when the app is launched for the first time. Any changes made to these settings will be saved automatically.
| Name | Default Value | Description |
|---|---|---|
Download Path |
(See below.) | The directory in which song packs will be downloaded. Only applies to newly added packs. |
Preferences.ini Path |
Paths to all Preferences.ini files automatically found/detected. |
The full path to the Preferences.ini file used by StepMania (or paths if multiple copies of StepMania are installed). |
Update Frequency |
1 hour |
How often the app will check for and download updates. |
Auto-Launch on Login |
false |
Whether or not to open the app when the computer starts. |
Language |
English (United States) |
Language of the app's user interface. |
Default download paths:
- Windows:
%APPDATA%/StepMania Song Manager/Songs - macOS:
~/Library/Application Support/StepMania Song Manager/Songs - Linux:
$XDG_CONFIG_HOME/StepMania Song Manager/Songs, or~/.config/StepMania Song Manager/Songs
Adding New Packs
If you want to upload your own simfile packs for others to freely download with the app, you can follow the steps for each cloud storage provider below.
Note: Regardless of the server to which you want to upload your packs, the files in the bucket must follow this directory structure:
/. Otherwise, StepMania will not be able to recognize the simfiles from the app./ /
Amazon S3
- Create an AWS account if you haven't already. Creating an IAM admin user is also recommended for interacting with AWS.
- Create a new bucket from the Amazon S3 web console. The name of the bucket must contain only lowercase letters, numbers, and hyphens.
- Configure the bucket to allow public access. From the Amazon S3 console, uncheck "Block all public access" and (optionally) re-check "Block public access to buckets and objects granted through [new & any] access control lists (ACLs)".
- Add the following JSON to the bucket policy, replacing
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "PublicRead",
"Effect": "Allow",
"Principal": "*",
"Action": [
"s3:GetObject",
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::" ,
"arn:aws:s3:::/*"
]
}
]
}
- Install and configure AWS CLI if you haven't already, using the Access Key ID and Secret Access Key of your IAM admin user account.
aws configure --profile <any-profile-name>
- Configure AWS CLI to prevent uploading large files in multiple parts.
aws configure set s3.multipart_threshold 128MB --profile <any-profile-name>
Feel free to change 128MB to whatever size you want, but make sure it is larger than the size of the largest file you intend to upload.
- Upload your files to the bucket:
aws s3 sync </path/to/packs> s3://<bucket-name> --delete --profile <any-profile-name>
Donate
Like the app? Please consider donating, which will help pay for the costs of hosting and downloading simfiles online.
License
See LICENSE for details.
5 Jul 27, 2022
7 Dec 8, 2022
10.2k Jan 2, 2023
0 Jan 15, 2022
47 Nov 25, 2022
4 Dec 14, 2022
8 Jul 31, 2022
10 Dec 3, 2022
3 Sep 2, 2022
0 Aug 30, 2022
138 Nov 21, 2022
5 Apr 5, 2022
2 Feb 10, 2022
2 Oct 11, 2022
2.9k Jan 4, 2023
1k Jan 1, 2023
4 Dec 6, 2022
12 Nov 8, 2022
4 Oct 28, 2022