From 6d8412c7e618d92a9456fcd9fa3af49eb4b61487 Mon Sep 17 00:00:00 2001
From: Chris Danford <chrisdanford@users.sourceforge.net>
Date: Sun, 7 Nov 2004 06:51:00 +0000
Subject: [PATCH] restore comments

---
 stepmania/Themes/default/metrics.ini | 101 +++++++++++++++++----------
 1 file changed, 66 insertions(+), 35 deletions(-)

diff --git a/stepmania/Themes/default/metrics.ini b/stepmania/Themes/default/metrics.ini
index be5f3b55dd..201cfca6a2 100644
--- a/stepmania/Themes/default/metrics.ini
+++ b/stepmania/Themes/default/metrics.ini
@@ -431,6 +431,8 @@ GainFocusItemCommand=glowshift;effectperiod,0.5
 LoseFocusItemCommand=stopeffect
 HideItemCommand=linear,0.2;diffusealpha,0
 ShowItemCommand=stoptweening;linear,0.2;diffusealpha,1;zoom,1.0;
+# This just selects the type of tweening used for scrolling the list; it shouldn't actually
+# queue any commands.
 ScrollTweenCommand=stoptweening;linear,0.2;
 
 [MusicList]
@@ -492,10 +494,10 @@ CDTitleFrontCommand=spin;effectmagnitude,0,90,0;cullmode,back
 CDTitleBackCommand=spin;effectmagnitude,0,90,0;cullmode,front;diffuse,#333333
 CDTitleOnCommand=addx,-SCREEN_WIDTH*0.6;bounceend,0.5;addx,SCREEN_WIDTH*0.6
 CDTitleOffCommand=bouncebegin,0.5;addx,-SCREEN_WIDTH*0.6
-CharacterIconP1Y=SCREEN_CENTER_Y+759
-CharacterIconP1X=SCREEN_CENTER_X+679
-CharacterIconP2Y=SCREEN_CENTER_Y+759
-CharacterIconP2X=SCREEN_CENTER_X+679
+CharacterIconP1Y=-1000
+CharacterIconP1X=-1000
+CharacterIconP2Y=-1000
+CharacterIconP2X=-1000
 CharacterIconP1OnCommand=hidden,1
 CharacterIconP2OnCommand=hidden,1
 CharacterIconP1OffCommand=
@@ -564,6 +566,8 @@ ScoreP2X=SCREEN_CENTER_X+200
 ScoreP2Y=SCREEN_CENTER_Y+46
 ScoreP2OnCommand=addx,SCREEN_WIDTH*0.6;bounceend,0.5;addx,-SCREEN_WIDTH*0.6
 ScoreP2OffCommand=bouncebegin,0.5;addx,SCREEN_WIDTH*0.6
+# Don't use relative motion here.  It's usually possible to change the
+# sort again while this command is still executing.
 ScoreP1SortChangeCommand=stoptweening;decelerate,0.128;x,920;sleep,0.128;accelerate,0.25;x,520
 ScoreP2SortChangeCommand=stoptweening;decelerate,0.128;x,920;sleep,0.128;accelerate,0.25;x,520
 ScoreFrameP1SortChangeCommand=stoptweening;decelerate,0.128;x,920;sleep,0.128;accelerate,0.25;x,520
@@ -849,10 +853,10 @@ ScrollingListX=SCREEN_CENTER_X+0
 ScrollingListY=SCREEN_CENTER_Y+0
 ScrollingListRotation=0
 BannerRotation=0
-MeterP1X=SCREEN_CENTER_X+679
-MeterP1Y=SCREEN_CENTER_Y+759
-MeterP2X=SCREEN_CENTER_X+679
-MeterP2Y=SCREEN_CENTER_Y+759
+MeterP1X=-1000
+MeterP1Y=-1000
+MeterP2X=-1000
+MeterP2Y=-1000
 SpeedIconP1X=SCREEN_CENTER_X-280
 SpeedIconP2X=SCREEN_CENTER_X+280
 SpeedIconP1Y=SCREEN_CENTER_Y-40
@@ -873,18 +877,18 @@ HiddenIconP1X=SCREEN_CENTER_X-280
 HiddenIconP2X=SCREEN_CENTER_X+280
 HiddenIconP1Y=SCREEN_CENTER_Y+0
 HiddenIconP2Y=SCREEN_CENTER_Y+0
-InfoFrameX=SCREEN_CENTER_X+679
-InfoFrameY=SCREEN_CENTER_Y+759
+InfoFrameX=-1000
+InfoFrameY=-1000
 GroupNameX=SCREEN_CENTER_X+0
 GroupNameY=SCREEN_CENTER_Y-185
 TitleX=SCREEN_CENTER_X+0
 TitleY=SCREEN_CENTER_Y-160
-SubTitleX=SCREEN_CENTER_X+679
-SubTitleY=SCREEN_CENTER_Y+759
-ArtistX=SCREEN_CENTER_X+679
-ArtistY=SCREEN_CENTER_Y+759
-DifficultyRatingX=SCREEN_CENTER_X+679
-DifficultyRatingY=SCREEN_CENTER_Y+759
+SubTitleX=-1000
+SubTitleY=-1000
+ArtistX=-1000
+ArtistY=-1000
+DifficultyRatingX=-1000
+DifficultyRatingY=-1000
 DifficultyRatingOrientation=0
 DifficultyRatingSpacing=40.0
 PreviewMusicMode=0 // 0 = play music as you select, 1 = no music plays, select once and preview music plays, select again for confirm, 2 = no music plays at all, 3 = play music as select, press twice to confirm, 4 = static menu music plays, no confirm
@@ -906,26 +910,29 @@ NextScreen2=screen,ScreenStage
 [ScreenStage]
 NextScreen=ScreenGameplay
 PrevScreen=ScreenBranchSelectSongOrCourse
+// This is the minimum delay after the "in" transition before the
+// "out" transition will begin.  (NextScreen is loaded during this
+// time.)
 MinimumDelay=3
 ShowBanner=0
-CharacterIconP1X=SCREEN_CENTER_X+679
-CharacterIconP2X=SCREEN_CENTER_X+679
-CharacterIconP1Y=SCREEN_CENTER_Y+759
-CharacterIconP2Y=SCREEN_CENTER_Y+759
+CharacterIconP1X=-1000
+CharacterIconP2X=-1000
+CharacterIconP1Y=-1000
+CharacterIconP2Y=-1000
 CharacterIconP1OnCommand=hidden,1;
 CharacterIconP2OnCommand=hidden,1;
 CharacterIconP1OffCommand=hidden,1;
 CharacterIconP2OffCommand=hidden,1;
 SongTitleOnCommand=hidden,1
 SongTitleOffCommand=hidden,1
-SongTitleX=SCREEN_CENTER_X+679
-SongTitleY=SCREEN_CENTER_Y+759
+SongTitleX=-1000
+SongTitleY=-1000
 ArtistOnCommand=hidden,1
 ArtistOffCommand=hidden,1
-ArtistX=SCREEN_CENTER_X+679
-ArtistY=SCREEN_CENTER_Y+759
-BannerY=SCREEN_CENTER_Y+759
-BannerX=SCREEN_CENTER_X+679
+ArtistX=-1000
+ArtistY=-1000
+BannerY=-1000
+BannerX=-1000
 BannerOnCommand=hidden,1
 BannerOffCommand=hidden,1
 BackgroundOnCommand=
@@ -950,16 +957,16 @@ InitialBackgroundBrightnessOni=1
 InitialBackgroundBrightnessEndless=1
 InitialBackgroundBrightnessBattle=1
 InitialBackgroundBrightnessRave=1
-BPMDisplayX=SCREEN_CENTER_X+679
-BPMDisplayY=SCREEN_CENTER_Y+759
+BPMDisplayX=-1000
+BPMDisplayY=-1000
 BPMDisplayOnCommand=zoom,0
 BPMDisplayOffCommand=
-SongTitleX=SCREEN_CENTER_X+679
-SongTitleY=SCREEN_CENTER_Y+759
+SongTitleX=-1000
+SongTitleY=-1000
 SongTitleOnCommand=zoom,0
 SongTitleOffCommand=
-MaxComboX=SCREEN_CENTER_X+679
-MaxComboY=SCREEN_CENTER_Y+759
+MaxComboX=-1000
+MaxComboY=-1000
 MaxComboOnCommand=zoom,0
 MaxComboOffCommand=
 LifeFrameX=SCREEN_CENTER_X+0
@@ -1109,6 +1116,7 @@ LyricsX=SCREEN_CENTER_X+0
 LyricsY=SCREEN_CENTER_Y+160
 LyricsReverseX=SCREEN_CENTER_X+0
 LyricsReverseY=SCREEN_CENTER_Y-140
+# This is used if one player is in reverse and the other isn't.
 LyricsOneReverseX=SCREEN_CENTER_X+0
 LyricsOneReverseY=SCREEN_CENTER_Y-205
 LyricsDefaultColor=0,1,0,1
@@ -3342,7 +3350,7 @@ TextZoom=0.5
 Uppercase=1
 
 [OptionIconRow]
-SpacingX=320-282
+SpacingX=38
 SpacingY=0
 
 [TransitionOniFade]
@@ -3662,7 +3670,7 @@ SecondsPerPage=10
 PageFadeSeconds=1.0
 NoScoreName=STEP
 RowSpacingX=0
-RowSpacingY=240-180
+RowSpacingY=60
 ColSpacingX=0
 ColSpacingY=0
 StepsTypeColor1=0.6,0.6,1,1
@@ -3930,8 +3938,23 @@ Fallback=EditCoursesMenu
 Fallback=ScreenOptionsSubmenu
 NextScreen=ScreenTitleMenu
 PrevScreen=ScreenTitleMenu
+# "Rows" sets the number of rows; this field is required.
+#
+# "Together" forces the vertical cursor to move together for both
+# players.
+#
+# "Explanations" enables per-item help text.
+#
+# "ForceAllPlayers" enables all players when the screen loads.
+# This should be enabled for menus used outside of gameplay.
+#
+# "SMNavigation" forces the START button to end the screen.  This is needed
+# when using entries that change the screen; otherwise, the only way to
+# exit the screen when in regular mode is "exit".
+
 LineNames=1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
 OptionMenuFlags=together;forceallplayers;smnavigation
+# This NextScreen is only used for the "exit" choice.
 Line1=list,Appearance Options
 Line2=list,Background Options
 Line3=list,Bookkeeping
@@ -4119,7 +4142,7 @@ TextsColorNormal=1,1,1,1
 TextsX=SCREEN_CENTER_X+160
 TextsY=SCREEN_CENTER_Y+0
 TextsSpacingX=0
-TextsSpacingY=240-210
+TextsSpacingY=30
 TextsZoom=0.5
 NextScreen=ScreenRanking
 
@@ -4172,6 +4195,7 @@ PrevScreen=ScreenTitleMenu
 NextScreen=ScreenBranchSelectSongOrCourse
 
 [BeginnerHelper]
+# All X,Y coordinates are relative to the HelperX,Y
 Player1_X=-125
 Player2_X=SCREEN_CENTER_X-195
 PlayerAngle=40
@@ -4180,6 +4204,7 @@ HelperX=SCREEN_CENTER_X+0
 HelperY=SCREEN_CENTER_Y+80
 
 [ScreenOptionsMaster]
+# Player options
 Speed=11
 SpeedDefault=mod,1x
 Speed,1=mod,0.25x;name,x0.25
@@ -4268,6 +4293,8 @@ Persp,2=mod,overhead;name,Overhead
 Persp,3=mod,space;name,Space
 Persp,4=mod,hallway;name,Hallway
 Persp,5=mod,distant;name,Distant
+
+# Song options
 LifeType=2,together
 LifeTypeDefault=
 LifeType,1=mod,bar;name,Bar
@@ -4326,6 +4353,8 @@ SaveScores=2,together
 SaveScoresDefault=
 SaveScores,1=mod,no savescore;name,Off
 SaveScores,2=mod,savescore;name,On
+
+# ScreenOptionsMenu
 Appearance Options=1,together
 Appearance OptionsDefault=
 Appearance Options,1=screen,ScreenAppearanceOptions;name,AppearanceOptions
@@ -4397,6 +4426,8 @@ Network OptionsDefault=
 Network Options,1=screen,ScreenNetworkOptions;name,NetworkOptions
 
 [DancingCharacters]
+#2D Character X/Y positions in relation to the center
+#of the screen
 2DCharacterXP1=-220
 2DCharacterYP1=0
 2DCharacterXP2=220