diff --git a/Themes/HelloWorld/Graphics/ScreenGuideMain header.lua b/Themes/HelloWorld/Graphics/ScreenGuideMain header.lua index 1504a5dcb4..f2abfa9b6a 100644 --- a/Themes/HelloWorld/Graphics/ScreenGuideMain header.lua +++ b/Themes/HelloWorld/Graphics/ScreenGuideMain header.lua @@ -13,7 +13,7 @@ local t = Def.ActorFrame{ InitCommand=cmd(zoomto,SCREEN_WIDTH*0.975,2;y,-32;diffuse,color("#111111FF");diffusetopedge,color("#11111188");shadowlength,-1;shadowcolor,color("#FFFFFF44");fadeleft,0.1;faderight,0.625); }; LoadFont("_frutiger roman 24px")..{ - Name="Header"; + Name="Explanation"; Text=THEME:GetString("ScreenGuideMain","Explanation"); InitCommand=cmd(x,-312;y,-24;align,0,0;diffuse,color("#111111FF");zoom,0.65;wrapwidthpixels,(SCREEN_WIDTH)); }; diff --git a/Themes/HelloWorld/Graphics/ScreenReferenceMain header.lua b/Themes/HelloWorld/Graphics/ScreenReferenceMain header.lua index d21e98ea0c..8eaf6439f7 100644 --- a/Themes/HelloWorld/Graphics/ScreenReferenceMain header.lua +++ b/Themes/HelloWorld/Graphics/ScreenReferenceMain header.lua @@ -13,7 +13,7 @@ local t = Def.ActorFrame{ InitCommand=cmd(zoomto,SCREEN_WIDTH*0.975,2;y,-20;diffuse,color("#111111FF");diffusetopedge,color("#11111188");shadowlength,-1;shadowcolor,color("#FFFFFF44");fadeleft,0.1;faderight,0.625); }; LoadFont("_frutiger roman 24px")..{ - Name="Header"; + Name="Explanation"; Text=THEME:GetString("ScreenReferenceMain","Explanation"); InitCommand=cmd(x,-312;y,-14;align,0,0;diffuse,color("#111111FF");zoom,0.65;wrapwidthpixels,(SCREEN_WIDTH)); }; diff --git a/Themes/HelloWorld/Graphics/_section Guide.png b/Themes/HelloWorld/Graphics/_section Guide.png index 18cd4a69a8..071f4e83e9 100644 Binary files a/Themes/HelloWorld/Graphics/_section Guide.png and b/Themes/HelloWorld/Graphics/_section Guide.png differ diff --git a/Themes/HelloWorld/Languages/en.ini b/Themes/HelloWorld/Languages/en.ini index b0daa03807..eeee7a548c 100644 --- a/Themes/HelloWorld/Languages/en.ini +++ b/Themes/HelloWorld/Languages/en.ini @@ -10,6 +10,8 @@ Tutorial=Tutorials Header=Guide Explanation=The Guide section is meant for beginners who may not know how the StepMania theming system works. It is also useful for themers coming from earlier versions of StepMania, as some things have changed in StepMania 5. +Beginning=Beginning +BeginningDesc=So you've decided to make a theme for StepMania 5. Metrics=Metrics MetricsDesc=Metrics and Languages (since they're similar). Fonts=Fonts diff --git a/Themes/HelloWorld/metrics.ini b/Themes/HelloWorld/metrics.ini index 903308c618..56b5b2846f 100644 --- a/Themes/HelloWorld/metrics.ini +++ b/Themes/HelloWorld/metrics.ini @@ -82,7 +82,8 @@ AllowRepeatingInput=true # modifying header position HeaderY=SCREEN_TOP+72 -ChoiceNames="Metrics,Fonts,Graphics,BGAnims,Sounds,Scripts,Other,NoteSkins,Announcers,Characters" +ChoiceNames="Beginning,Metrics,Fonts,Graphics,BGAnims,Sounds,Scripts,Other,NoteSkins,Announcers,Characters" +ChoiceBeginning="name,Beginning" ChoiceMetrics="name,Metrics" ChoiceFonts="name,Fonts" ChoiceGraphics="name,Graphics" @@ -93,7 +94,7 @@ ChoiceOther="name,Other" ChoiceNoteSkins="name,NoteSkins" ChoiceAnnouncers="name,Announcers" ChoiceCharacters="name,Characters" -DefaultChoice="Metrics" +DefaultChoice="Beginning" ShowScroller=true LoopScroller=false diff --git a/Themes/HelloWorld/readme.txt b/Themes/HelloWorld/readme.txt index 8cd60436cb..9c4226cbd3 100644 --- a/Themes/HelloWorld/readme.txt +++ b/Themes/HelloWorld/readme.txt @@ -14,6 +14,7 @@ Table of Contents Introduction [intro] Chapter List [chapt] Guide [guide] + Beginning [g_beg] Metrics [g_met] Fonts [g_fon] Graphics [g_gfx] @@ -21,6 +22,7 @@ Table of Contents Sounds [g_sfx] Scripts [g_scr] Other [g_oth] + Debug Menu [g_deb] NoteSkins [g_not] Announcers [g_ann] Characters [g_cha] @@ -51,6 +53,36 @@ NoteSkins, Announcers, and Characters) Guide [guide] This section covers the basics of theming for StepMania. +-------------------------------------------------------------------------------- +Beginning [g_beg] + +So you've decided to make a theme for StepMania 5. +This section will tell you how to get started. + +The most important rule: NEVER COPY THE DEFAULT THEME'S FOLDER. +This will only hurt you in the end, as the default theme is updated a lot, and +any changes made in it WON'T carry over to your theme. + +The recommended way is to make a blank folder and use the fallback system, +falling back on _fallback. If you are making an edit of the default theme, +then you can set the fallback value to default. This will be explained more +in the Metrics section. + +So hopefully by now you've decided to start from a blank folder. + +Make two blank text files: metrics.ini and ThemeInfo.ini. +Then make these folders: +BGAnimations/, Fonts/, Graphics/, Languages/, Other/, Scripts/, Sounds/ + +# ThemeInfo.ini +The ThemeInfo.ini file from the default theme looks like this: +[ThemeInfo] +DisplayName=Default +Author=Midiman + +It should be straightforward enough to follow and edit. +Once you've done this, you can move on to the next section. + -------------------------------------------------------------------------------- Metrics and Languages [g_met] @@ -91,6 +123,26 @@ Other [g_oth] Ever wonder what all those files in the Other folder are for? +-------------------------------------------------------------------------------- +Debug Menu and Shortcuts [g_deb] + +The debug menu will be your best friend when theming. + +Access the debug menu by holding F3. There are three sections of the menu +available: Main (F5), Theme (F6), and Profiles (F7). + +There are other shortcuts that will be helpful for theming: +Tab - speeds up animations. +`/~ - slows down animations. +Tab + `/~ - freezes animations. +F2 - Reloads theme and textures. +Shift + F2 - Reloads metrics only. +Ctrl + F2 - Reloads scripts only. +Ctrl + Shift + F2 - Reloads the overlay screens. +F1 - Insert Coin +Print Screen - Take a JPEG screenshot. +Shift + Print Screen - Take a PNG screenshot. + -------------------------------------------------------------------------------- NoteSkins [g_not]