Stats.xml or simply.training jsons?
Enable GrooveStats to Yes in the GrooveStats Options submenu of Options.
Sign Up.
Then log in and go to the Edit Profile page to generate and/or copy an API Key.
GrooveStats.ini file inside your profile's directory.
If you need help locating your profile, see Locating Game Settings section of this manual.
The file must have the following contents:
[GrooveStats]
ApiKey=your API key from groovestats.com
IsPadPlayer=1
Make sure that there are no spaces around the pasted API Key and that IsPadPlayer is set to 1,
otherwise the game will only fetch scores without ability to send them.
You don't have to create any accounts, just configure the game using this guide and start playing. If you don't have a GrooveStats integration in your ITGmania, please start with Join and Enable GrooveStats section. There's a common configuration needed no matter what theme you use.
First you need to allow ITGmania to make network requests to BoogieStats address.
Make sure to turn your game off before modifying the configuration.
Locate your Preferences.ini file in the configuration directory.
Find the line that starts with HttpAllowHosts= and append ,boogiestats-staging.andr.host.
Make sure that there are no extra spaces or protocol, just the address after a comma.
It's important to keep GrooveStats in the list to allow downloads of unlockable songs in the contests held on GrooveStats.
HttpAllowHosts=*.groovestats.com
HttpAllowHosts=*.groovestats.com,boogiestats-staging.andr.host
Now pick the theme-specific instructions that apply to you.
If you start with a fresh ITGmania installation and don't know what to choose, zmod offers the best BoogieStats user experience at the moment.
Zarzob's fork of Simply Love, commonly referred to as zmod, has an extended support for BoogieStats.
You can download it from the project's GitHub page.
If you run already have a recent version of zmod, just
set Use BoogieStats to Yes in the Zmod Options submenu of Options.
Simply Love theme to redirect requests from api.groovestats.com to this BoogieStats instance.
Find and modify ITGMANIA_PATH/Themes/Simply Love/Scripts/SL-Helpers-GrooveStats.lua — change line that starts with local url_prefix from:
local url_prefix = "https://api.groovestats.com/"
local url_prefix = "https://boogiestats-staging.andr.host/"
Make sure that the trailing forward slash (/) is included and that there are no extra spaces on either end of the address.
There's a chance that if your current theme supports automatic score submissions from ITGmania without GrooveStats Launcher, the method described for Stock Simply Love theme could also be adapted for your theme, but it's not been tested.
When you completed all required configuration you can just start playing. All songs will now appear as "ranked" in game.
If you use zmod theme, the leaderboards will display the source of scores (either GS or BS).
After you play and pass any song and your score is not disqualified locally by the game, your
score will appear on the recent scores page.
Make sure that the bottom of the result screen in game says Submitted!.
If for any reason the score is disqualified, the panel with QR code should give you more details.
When the score has been submitted by game, a BoogieStats player profile will be created automatically.
If you chose to play a GS-ranked song, the profile will already have your nickname and machine tag pulled from GS,
otherwise they will remain randomly generated until you complete a GS-ranked song or set them manually on the Edit Profile page.
Use your GrooveStats API Key to log in (you can paste the whole key, it will be automatically cut to the limit inside the form), the same one that's been set in GrooveStats.ini file.
You can also disable the automatic name and tag updates on that page.
Edit Profile also allows you to choose rivals. Historically you could only set up to 3 rivals but BoogieStats currently allows you to choose as many as you want. All of them will be shown on your BoogieStats profile with option to open the comparison page, but only the top 3 scores of your rivals on a given chart will be displayed on the leaderboards in the game. If you don't like this in-game behavior, just set up to 3 rivals.
If you ever need to change your GS API Key, Edit Profile page will also allow to update it in your BoogieStats account. If you submit a score with a new GS API Key without updating it first there, a new account will be created. See Q&A section for details.
GAME_INSTALLATION_DIR/Save directory.
INSTALLATION_DIR/Save/Preferences.ini
INSTALLATION_DIR/Save/LocalProfiles/
%appdata%/ITGmania/Save directory (paste this path to a navigation bar of file explorer and hit enter).
%appdata%/ITGmania/Save/Preferences.ini
%appdata%/ITGmania/Save/LocalProfiles/
~/.itgmania/Save directory.
~/.itgmania/Save/Preferences.ini
~/.itgmania/Save/LocalProfiles/
~/Library/Preferences/ITGmania directory.
Please note that by default it might be hidden in Finder.
You can display Library directory by navigating to your home directory, pressing Cmd+J and checking Show Library Folder.
~/Library/Preferences/ITGmania/Preferences.ini
~/Library/Preferences/ITGmania/LocalProfiles/
LocalProfiles directory, they are usually named using consecutive ids,
for example: Save/LocalProfiles/00000000/.
If you have more than one profile, you can check the Editable.ini inside a profile to make sure that
you picked the correct one.
This BoogieStats instance has a search feature that allows you to search songs that have already been played. Please note that this is still an experimental feature and might not work in all the cases. Additionally, the used search engine (RediSearch) imposes several limitations on the queries but on the other hand brings some features for power-users.
Below you can find a list of example queries with explanations which can help you figure out how the search works. You can use multiple special terms in a single query.
barbie gurl will match
barbie girl song. [example]
-term to the query.
[example]
jump would also match a lot of pump occurrences.
[example]
warning query would fail to find WARNINGxWARNINGxWARNING song. Adding a star on
either end of the word will try to match more characters on that end. However, an extra single quote mark
is needed at the beginning of the term. [example]
translit
suffix because that's how the charts store the info. [example]
- character. [example]
Stats.xml or simply.training jsons? #
New GrooveStats API key field and click Update. You can now send scores using the new API Key.
#bs-announcements channel is updated in English and can be subscribed to another Discord server (using the built-in subscribe feature by a user with web-hook permissions on the target server) for automatic updates cross-posting.
andrzej_. Please note that I'm based in Europe so our "active hours" overlap might be limited. No hello and Don't ask to ask, just ask are your friends in async communication ;) If you don't need my personal assistance, consider posting a message publicly on the #bs-general channel on PDGC Discord server.