actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Updated notes on SORT parameter to indicate that it can actually be used with other parameters just fine, but the resutls can get kind of weird.

Browse Source
This commit is contained in:
Michael Votaw
2024-03-06 01:45:26 -08:00
committed by teejusb
parent f8ce3c7db2
commit ede0b53f2b
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/CourseFormat.txt
+7 -6
View File
@@ -96,8 +96,7 @@ Complete Course Template
-- The following parameters are available for selecting a song: -- The following parameters are available for selecting a song:
-- TITLE, GROUP, ARTIST, GENRE, DIFFICULTY, METER, BPMRANGE, DURATION, SORT -- TITLE, GROUP, ARTIST, GENRE, DIFFICULTY, METER, BPMRANGE, DURATION, SORT
-- With the exception of SORT, these can be used in any combination and order. -- These can be used in any combination and order.
-- (See the SORT parameter description below for a better explanation)
-- If none are specified, then a song and difficulty will be chosen completely at random. -- If none are specified, then a song and difficulty will be chosen completely at random.
-- If a combination is specified that results in no possible songs to select, -- If a combination is specified that results in no possible songs to select,
-- then that #SONGSELECT entry is skipped. -- then that #SONGSELECT entry is skipped.
@@ -198,16 +197,18 @@ Complete Course Template
-- by a comma. For example, SORT=MostPlays,1 selects the #1 most played song on -- by a comma. For example, SORT=MostPlays,1 selects the #1 most played song on
-- the machine, SORT=LowestGrades,10 selects the song that you've gotten your 10th -- the machine, SORT=LowestGrades,10 selects the song that you've gotten your 10th
-- worst score on. -- worst score on.
-- One possible use for this would be to create a course to force you to play songs
-- from certain groups that you likely haven't played before, by combining this with
-- the GROUP parameter, eg "#SONGSELECT:GROUP=In the Groove:SORT=FewestPlays,1;"
--
-- Notes: -- Notes:
-- - Like DIFFICULTY, there are several acceptable values that are equivalent to each other. -- - Like DIFFICULTY, there are several acceptable values that are equivalent to each other.
-- The old style values are Best, Worst, GradeBest, or GradeWorst. -- The old style values are Best, Worst, GradeBest, or GradeWorst.
-- For the sake of consistency and clarity, please consider using: -- For the sake of consistency and clarity, please consider using:
-- MostPlays, FewestPlays, TopGrades, or LowestGrades. -- MostPlays, FewestPlays, TopGrades, or LowestGrades.
-- - The number value can be between 1 and 500. -- - The number value can be between 1 and 500.
-- - As noted at the beginning of the description of #SONGSELECT, this parameter isn't -- - As of right now, the results from using this parameter aren't exactly accurate.
-- really intended to be used with other selection parameters. -- I can't quite work out how/why it makes the choices that it does.
-- It's not really accurate to say that it *can't* be used with them, but you're much
-- more likely to find yourself with an entry that can't select any songs.
-- Example: -- Example:
#SONGSELECT:SORT=MostPlays,4; #SONGSELECT:SORT=MostPlays,4;