Skip to content

Configuring Text File Output

kokolihapihvi edited this page Feb 8, 2018 · 1 revision

To configure RockSniffers text file outputs to suit your needs, edit config/output.json with your favourite text editor

Inside the file, you will see a simple list of output files and their formats:

{
  "outputs": {
    "song_details.txt": "%SONG_ARTIST% - %SONG_NAME%",
    "album_details.txt": "%SONG_ALBUM% (%ALBUM_YEAR%)",
    "song_timer.txt": "%SONG_TIMER%/%SONG_LENGTH%",
    "notes.txt": "%NOTES_HIT%/%TOTAL_NOTES%",
    "accuracy.txt": "%CURRENT_ACCURACY%",
    "streaks.txt": "%CURRENT_STREAK%/%HIGHEST_STREAK%"
  }
}

The format for each output is: "filename.txt": "FORMAT STRING"

Inside the format string you can use any of the below mentioned output strings They will be replaced with data read from the game and written to the specified text file inside the output directory

NOTE: If you want an output to be across multiple lines, add \n where you want the new line to start, for example "%ARTIST_NAME%\n%SONG_NAME%" will output on two lines, the first line will be the artist name, the second will be the song name

Valid output strings are:

Song info:
%SONG_ARTIST% = Artist name
%SONG_NAME% = Song name
%SONG_LENGTH% = Song length

Album info:
%ALBUM_NAME% = Album name
%ALBUM_YEAR% = Album year

Accuracy info:
%NOTES_HIT% = Current number of notes hit
%NOTES_MISSED% = Current number of notes missed
%TOTAL_NOTES% = Total number of notes passed

%CURRENT_ACCURACY% = Current accuracy percentage

%CURRENT_STREAK% = Current number of notes hit in a row
%HIGHEST_STREAK% = Highest number of notes hit in a row

Other:
%SONG_TIMER% = Current song timer
Clone this wiki locally