Add SM5 migration guide

This commit is contained in:
Martin Natano
2022-05-28 11:21:13 +02:00
parent 15b77ee278
commit 08896f0cc1
2 changed files with 43 additions and 3 deletions
+39
View File
@@ -0,0 +1,39 @@
StepMania 5.1 to ITGmania Migration Guide
=========================================
This guide explains how to migrate from StepMania 5.1 to ITGmania without losing access to your settings and songs.
The steps are as follows:
1. Install ITGmania.
2. Copy over songs, settings, profiles and other user data. (See detailed instructions below.)
If you don't intend on keeping StepMania 5.1 the data can be moved instead of copying.
3. (skip for portable builds) ITGmania ships with Simply Love and the Club Fantastic song packs included. Duplicates of them can be removed from the user data directory.
4. Uninstall StepMania 5.1 (optional).
If you choose to do so you can also uninstall the GrooveStats launcher as ITGmania has network functionality built in and doesn't need an external tool for that. This is currently only supported by the Simply Love theme though, so users of other themes will still have to use the Launcher.
5. Make sure to enable GrooveStats integration in the operator menu if you want to use it.
6. You are all set!
If you want to keep StepMania 5.1 alongside ITGmania you can save some space by using the `AdditionalSongFolders` setting to point both installations to the same songs folder.
## Portable builds (all platforms)
Create a file after installation called Portable.ini at the root directory of the install to create a portable build.
Copy over `Announcers/`, `Characters/`, `Courses/`, `NoteSkins/` and `Songs/` to the ITGmania folder.
Make sure to remove any copy of the Simply Love theme from the `Themes` folder before copying it over. ITGmania ships with it's own version of Simply Love.
## Windows
Copy `%APPDATA%/StepMania 5.1/` to `%APPDATA%/ITGmania/`.
## macOS
On macOS the user data folder and the save folder are separate, so you have to copy both of them.
Copy `~/Library/Application Support/StepMania 5.1/` to `~/Library/Application Support/ITGmania/`.
Copy `~/Library/Preferences/StepMania 5.1/` to `~/Library/Preferences/ITGmania/`.
## Linux
Copy `~/.stepmania-5.1/` to `~/.itgmania/`.
+4 -3
View File
@@ -22,7 +22,7 @@ ITGmania is a fork of [StepMania 5.1](https://github.com/stepmania/stepmania/tre
For those that do not wish to compile the game on their own and use a binary right away, be aware of the following issues:
* Windows users are expected to have installed the [Microsoft Visual C++ x86 Redistributable for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145) prior to running the game. For those on a 64-bit operating system, grab the x64 redistributable as well. Windows 7 is the minimum supported version.
* Mac OS X users need to have Mac OS X 10.6.8 or higher to run ITGmania.
* macOS users need to have macOS 11 (Big Sur) or higher to run ITGmania.
* Linux users should receive all they need from the package manager of their choice.
### From Source
@@ -31,8 +31,9 @@ ITGmania can be compiled using [CMake](http://www.cmake.org/). More information
## Resources
* Website: https://www.itgmania.com/
* Lua for ITGmania: https://itgmania.github.io/lua-for-itgmania/
* [ITGmania Website](https://www.itgmania.com/)
* [StepMania 5.1 to ITGmania Migration Guide](Docs/Userdocs/sm5_migration.md)
* [Lua for ITGmania](https://itgmania.github.io/lua-for-itgmania/)
* Lua API Documentation can be found in the Docs folder.
## Licensing Terms