minor doc updates

This commit is contained in:
Glenn Maynard
2003-03-27 06:40:27 +00:00
parent c49a516c8d
commit 24d65ada6e
+25 -20
View File
@@ -404,12 +404,12 @@ The .SM song file format was created to be one file format that supports all
game types that StepMania can play (dance, pump, beat, guitar, etc). The syntax game types that StepMania can play (dance, pump, beat, guitar, etc). The syntax
of a .SM is similar to .DWI and .KSF except that some tags are different.<br> of a .SM is similar to .DWI and .KSF except that some tags are different.<br>
<br> <br>
(Note that StepMania can load images can be in png, gif, jpg, or bmp format, and Note that StepMania can load images in PNG, GIF, PJG, and BMP formats, and
can load sounds in ogg, mp3, or wav format.)<br> can load sounds in OGG, MP3, and WAV formats.<br>
<br> <br>
Any text field in an SM file can contain UTF-8 characters.<br>
<br> <br>
#TITLE:...; - The &quot;main title&quot; of the song. Supports for UTF-8 foreign #TITLE:...; - The &quot;main title&quot; of the song.<br>
characters.<br>
#SUBTITLE:...; - This text will appear underneath the main title of the song on #SUBTITLE:...; - This text will appear underneath the main title of the song on
the Select Music screen. e.g. &quot;~Dirty Mix~&quot; or &quot;(remix)&quot;.<br> the Select Music screen. e.g. &quot;~Dirty Mix~&quot; or &quot;(remix)&quot;.<br>
#ARTIST:...; - The artist of the song.<br> #ARTIST:...; - The artist of the song.<br>
@@ -684,8 +684,8 @@ CRS files define the courses used in the Nonstop, Oni, and Endless modes.&nbsp;
files must reside in the &quot;Courses&quot; folder in the StepMania program folder.&nbsp; files must reside in the &quot;Courses&quot; folder in the StepMania program folder.&nbsp;
These rules determine which of the three modes a course will appear in:<br> These rules determine which of the three modes a course will appear in:<br>
<br> <br>
Nonstop: Will appear if #LIVES=-1 and #REPEAT=OFF.<br> Nonstop: Will appear if there is no #LIVES tag and #REPEAT is OFF.<br>
Oni (Challenge): Will appear if #LIVES &gt; 0 and #REPEAT=OFF.<br> Oni (Challenge): Will appear if there is a #LIVES tag and #REPEAT is OFF.<br>
Endless: Will appear if #REPEAT is ON.<br> Endless: Will appear if #REPEAT is ON.<br>
<br> <br>
#COURSE:...; - name of the course<br> #COURSE:...; - name of the course<br>
@@ -798,14 +798,21 @@ in the folder &quot;NoteSkins\&lt;Game Name&gt;\&lt;Note Skin Name&gt;&quot;. No
to a particular game (dance, pump, etc). In the note skin folder, you must to a particular game (dance, pump, etc). In the note skin folder, you must
implement the folling files for each note:<br> implement the folling files for each note:<br>
<br> <br>
&lt;NoteName&gt; receptor (2x1).png<br> &lt;NoteName&gt; receptor (3x1).png<br>
&lt;NoteName&gt; tap parts (2xN).png<br> &lt;NoteName&gt; tap note (NxN).png<br>
&lt;NoteName&gt; tap explosion bright (NxN).png<br> &lt;NoteName&gt; tap explosion bright.png<br>
&lt;NoteName&gt; tap explosion dim (NxN).png<br> &lt;NoteName&gt; tap explosion bright.png<br>
&lt;NoteName&gt; note color part (NxN).png<br> &lt;NoteName&gt; hold explosion.png<br>
&lt;NoteName&gt; note gray part (NxN).png<br> &lt;NoteName&gt; down hold topcap active.png.png<br>
&lt;NoteName&gt; hold parts (4x2).png<br> &lt;NoteName&gt; down hold topcap inactive.png.png<br>
&lt;NoteName&gt; hold explosion (NxN).png<br> &lt;NoteName&gt; down hold head active.png.png<br>
&lt;NoteName&gt; down hold head inactive.png.png<br>
&lt;NoteName&gt; down hold body active.png.png<br>
&lt;NoteName&gt; down hold body inactive.png.png<br>
&lt;NoteName&gt; down hold tail active.png.png<br>
&lt;NoteName&gt; down hold tail inactive.png.png<br>
&lt;NoteName&gt; down hold bottomcap active.png.png<br>
&lt;NoteName&gt; down hold bottomcap inactive.png.png<br>
&lt;NoteName&gt; tap.colors<br> &lt;NoteName&gt; tap.colors<br>
<br> <br>
&quot;&lt;NoteName&gt;&quot; must be the name of the note (e.g. &quot;left&quot;, &quot;upright&quot;, &quot;snare&quot;).&nbsp; &quot;&lt;NoteName&gt;&quot; must be the name of the note (e.g. &quot;left&quot;, &quot;upright&quot;, &quot;snare&quot;).&nbsp;
@@ -814,8 +821,7 @@ each game.<br>
<br> <br>
Most of the note skin elements can use any number of frames. For example, the Most of the note skin elements can use any number of frames. For example, the
element &quot;tap exposion bright&quot; could have 4 frames (2x2), 2 frames (1x2), or just element &quot;tap exposion bright&quot; could have 4 frames (2x2), 2 frames (1x2), or just
a single frame. The exception to this rule is &quot;tap parts&quot; which must be 2 frames a single frame. The exception to this rule is &quot;receptor&quot;, which must have 3 frames.<br>
wide, and hold parts which must be 4x2.<br>
<br> <br>
For more information on about textures with multiple frames, see the section For more information on about textures with multiple frames, see the section
&quot;How StepMania Loads Textures&quot; in this document.<br> &quot;How StepMania Loads Textures&quot; in this document.<br>
@@ -835,7 +841,7 @@ Themes\&lt;ThemeName&gt;\Fonts\<br>
Themes\&lt;ThemeName&gt;\Graphics\<br> Themes\&lt;ThemeName&gt;\Graphics\<br>
Themes\&lt;ThemeName&gt;\Numbers\<br> Themes\&lt;ThemeName&gt;\Numbers\<br>
Themes\&lt;ThemeName&gt;\Sounds\<br> Themes\&lt;ThemeName&gt;\Sounds\<br>
Themes\&lt;ThemeName&gt;\metrics.ini\<br> Themes\&lt;ThemeName&gt;\metrics.ini<br>
<br> <br>
The 5 possible folders in a theme hold &quot;theme elements&quot;. A theme element is The 5 possible folders in a theme hold &quot;theme elements&quot;. A theme element is
simply a little piece of the theme that can be changed. Each of the 5 folders simply a little piece of the theme that can be changed. Each of the 5 folders
@@ -845,8 +851,7 @@ BGAnimations: This folder contains BGAnimation elements for the different
screens. Since all backgrounds for all the menus in the game are generated using screens. Since all backgrounds for all the menus in the game are generated using
BGAnimations, any screen in the game can have an animating background. Also, BGAnimations, any screen in the game can have an animating background. Also,
BGAnimations can contain movie layers. For more information about BGAnimations, BGAnimations can contain movie layers. For more information about BGAnimations,
see the section &quot;BGAnimations Format&quot; in <br> see the section &quot;BGAnimations Format&quot; in this document.<br>
this document.<br>
<br> <br>
Fonts: This folder contains graphics and font width data used by the font Fonts: This folder contains graphics and font width data used by the font
system. Font graphics and width files are generated using the program &quot;Bitmap system. Font graphics and width files are generated using the program &quot;Bitmap
@@ -1004,7 +1009,7 @@ image.<br>
<br> <br>
However, paletted PNGs have a couple limitations:<br> However, paletted PNGs have a couple limitations:<br>
- they support you to only &quot;on/off&quot; alpha.<br> - they support you to only &quot;on/off&quot; alpha.<br>
- they support a maxiumum of 256 colors. This can make smooth gradients - they support a maximum of 256 colors. This can make smooth gradients
look ugly. <br> look ugly. <br>
<br> <br>
Alternatively, inserting "dither" into filenames will instruct StepMania Alternatively, inserting "dither" into filenames will instruct StepMania