This commit is contained in:
Glenn Maynard
2003-02-12 03:02:44 +00:00
parent 25011c8639
commit f224c20e09
+113 -149
View File
@@ -1,21 +1,18 @@
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<title>New Page 1</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
</head>
<body>
<p>StepMania 3.0 final<br>
(c)2001-2003, StepMania team, All rights reserved.<br>
&copy;2001-2003, StepMania team, All rights reserved.<br>
<a href="http://www.stepmania.com">http://www.stepmania.com</a></p>
<p>************************************************************<br>
Table of Contents<br>
************************************************************<br>
<p>
<hr>
Table of Contents
<hr>
<br>
<a href="#About StepMania">About StepMania</a><br>
<a href="#Minimum Requirements">Minimum Requirements</a><br>
@@ -44,10 +41,9 @@ and Help</a> <br>
<br>
See the file <a href="NEWS">NEWS</a> for version history.<br>
<br>
<br>
************************************************************<br>
<hr>
<a name="About StepMania">About StepMania</a><br>
************************************************************<br>
<hr>
<br>
StepMania is capable of playing many game types. Currently, it supports games
similar to Dance Dance Revolution, Pump It Up, EZ 2 Dancer, and Para Para
@@ -60,48 +56,45 @@ controller in time to the. All games can be played using the keyboard, but the
real fun comes when using specially designed controllers, like a dance pad or
hand sensors.<br>
<br>
<br>
************************************************************<br>
<a name="Minimum Requirements">Minimum Requirements</a><br>
************************************************************<br>
<hr>
<a name="Minimum Requirements">Minimum Requirements</a>
<hr>
<br>
* Windows 98, Windows ME, Windows 2000, or Windows XP<br>
* Pentium II, Pentium III, Celeron, Athlon, or compatible processor, 266MHz
minimum (400 MHz recommended)<br>
* 64 MB of RAM<br>
* Video card that supports High Color (16-bit color) and has 16MB video RAM<br>
* DirectX 8.1 compatible video card with drivers<br>
* Video card with OpenGL drivers<br>
* DirectX 8.1 compatible sound card with drivers<br>
* DivX 5 video codec for movie visualizations (www.divx.com)<br>
<br>
<br>
************************************************************<br>
<a name="DirectX">DirectX</a><br>
************************************************************<br>
<hr>
<a name="DirectX">DirectX</a>
<hr>
<br>
DirectX 8.1 is required before installing StepMania. If DirectX 8.1 is not
DirectX 8.0 is required before installing StepMania. If DirectX 8.0 is not
installed on your computer, the StepMania installer will display a warning and
abort the installation.<br>
<br>
<br>
************************************************************<br>
<a name="Installation">Installation</a><br>
************************************************************<br>
<hr>
<a name="Installation">Installation</a>
<hr>
<br>
To install StepMania, download the file stepmania300.exe to a known location on
your hard drive, then double-click the file icon to begin the installation. The
installer may prompt you to remove an older version of the program if one is
present. The default installation directory is 'C:\Program Files\StepMania'.<br>
<br>
<br>
************************************************************<br>
<a name="Controls">Controls</a><br>
************************************************************<br>
<hr>
<a name="Controls">Controls</a>
<hr>
<br>
Use the &quot;Config Key/Joy&quot; option from the Title Menu to configure your keyboard,
dance pad, or other game controller. This menu allows you to map up to 2
keyboard/joystick buttons to each function in the game. The third column is the
default key mapping, and cannot be changed. However, you can override a&nbsp;
default key mapping, and cannot be changed. However, you can override a
default keyboard key by simply assigning it to another function. The mappings
for player 1 are on the left half of the screen, and the mapping for player 2
are on right half.<br>
@@ -112,7 +105,7 @@ The following is a list of special keys:<br>
Any time:<br>
* F1 = insert coin for player 1<br>
* F2 = insert coin for player 2<br>
* F4 = toggle fullscreen<br>
* Alt-Enter or F4 = toggle fullscreen<br>
* F5 = take screenshot (saves to program directory as &quot;screenNNNN.bmp&quot;)<br>
* Hold Tab = increase game speed 4x (useful for moving through menus quickly)<br>
* Hold Tilde (~) = decrease game speed to 1/4x<br>
@@ -149,9 +142,12 @@ In editor:<br>
* P - Play back current selection (if no selection, play whole song)<br>
* R - Record over current selection (if no selection, record whole song)<br>
<br>
************************************************************<br>
<a name="How StepMania Loads Songs">How StepMania Loads Songs</a><br>
************************************************************<br>
In the music select screen:<br>
* F9 = Toggle title translations<br>
<br>
<hr>
<a name="How StepMania Loads Songs">How StepMania Loads Songs</a>
<hr>
<br>
All files for a specific song (data file, music file, banner, background) must
reside in a single folder. This folder must have the following path:<br>
@@ -184,12 +180,11 @@ graphic in the song folder that contains the words &quot;cdtitle&quot;. If that
fails, StepMania will guess which image is most appropriate.<br>
<br>
If there is exactly one movie in the song folder, StepMania will insert a
background change to that movie at the moment the music starts.<br>
background change to that movie at beat 0.<br>
<br>
<br>
************************************************************<br>
<a name="Connecting Dance Pads">Connecting Dance Pads</a><br>
************************************************************<br>
<hr>
<a name="Connecting Dance Pads">Connecting Dance Pads</a>
<hr>
<br>
There are several devices that allow you to connect PlayStation dance pads to
your PC.<br>
@@ -214,7 +209,7 @@ not require special drivers and require no configuring.<br>
* Semi-Recommended: PlayStation-&gt;Parallel adaptor<br>
<br>
PlayStation-&gt;Parallel converters do not have the simultaneous button problem
that USB converters do. The disadvantage of these adaptors is that home-made <br>
that USB converters do. The disadvantage of these adaptors is that home-made
drivers are required to use these devices. These drivers are often finicky and
incompatible with some sound cards. PlayStation-&gt;Parallel adaptors can be
purchased from the StepMania web site or any importer.<br>
@@ -225,11 +220,10 @@ is NTPad XP 1.x or
<a href="http://www.psxpad.com/download/downcnt.php?name=psxp_a020606b">PSXPAD</a>.<br>
<br>
StepMania now natively supports USB Pump It Up pads.<br>
&nbsp;</p>
<p><br>
************************************************************<br>
<a name="Compatibility Issues">Compatibility Issues</a><br>
************************************************************<br>
<br>
<hr>
<a name="Compatibility Issues">Compatibility Issues</a>
<hr>
<br>
Some video card/driver combinations have visual errors when running StepMania.
If you experience any visual errors, please visit your video card manufacturer's
@@ -252,31 +246,14 @@ Symptom: Various graphical glitches.<br>
Explanation: These problems are most often caused by buggy video card drivers
bugs. Please upgrade to the latest drivers, which will hopefully fix the errors.<br>
<br>
<br>
************************************************************<br>
<a name="FAQ / Troubleshooting">FAQ / Troubleshooting</a><br>
************************************************************<br>
<hr>
<a name="FAQ / Troubleshooting">FAQ / Troubleshooting</a>
<hr>
<br>
* The error &quot;Cannot find Dinput8.dll&quot; appears when launching the game.<br>
<br>
You need to download DirectX 8.1. http://www.microsoft.com/directx<br>
<br>
* StepMania reports &quot;Direct3DCreate failed&quot;.<br>
<br>
You need to download DirectX 8.1. http://www.microsoft.com/directx<br>
<br>
* StepMania reports &quot;Direct3DCreateDevice failed&quot;.<br>
<br>
This error means that your video card or drivers do not support Direct3D 8.
Download the latest drivers for your video card. If your video card is older
than 2 or 3 years, Direct3D 8 drivers may not be available. Sorry.<br>
<br>
* Music rates of over 100% do not work on my computer. Why?<br>
<br>
Some very old sound cards do not support sound playback rates that are greater
than the original sample rate. This problem is likely to be corrected by newer
sound card drivers.<br>
<br>
* Im looking to purchase a video card. What works well with StepMania?<br>
<br>
Just about any video card manufactured in the last year will run StepMania
@@ -299,10 +276,9 @@ Nope, Sorry. It's gotten me in trouble before.<br>
The reasons I won't tell is because: a) I don't know yet, and b) I don't want to
make anyone angry if it takes longer than expected (it usually does).<br>
<br>
<br>
************************************************************<br>
<a name="StepMania Packages - .smzip">StepMania Packages - .smzip</a><br>
************************************************************<br>
<hr>
<a name="StepMania Packages - .smzip">StepMania Packages - .smzip</a>
<hr>
<br>
The StepMania package format was created to make the distribution of songs and
other add-ons very easy. &nbsp;StepMania package files have the extension '.smzip'
@@ -324,19 +300,18 @@ will take all of the selected items and make one package that contains them all.
&quot;Export Individual&quot; will create one separate package for each selected item in
the list.<br>
<br>
<br>
************************************************************<br>
<hr>
<a name="Questions, Bugs, Suggestions, and Help">Questions, Bugs, Suggestions,
and Help</a><br>
************************************************************<br>
and Help</a>
<hr>
<br>
If you have a question about or problem with StepMania, please first ask your
question a StepMania message board. For a list of StepMania message boards, see
the web site - http://www.stepmania.com.<br>
the <a href="http://www.stepmania.com">web site</a>.<br>
<br>
If you have found a bug, please file a bug report into the SourceForge bug
tracking system (http://sourceforge.net/tracker/?group_id=37892&amp;atid=421366).
This will allow the developers to track and fix bugs much more efficiently. &nbsp;<br>
This will allow the developers to track and fix bugs much more efficiently.<br>
<br>
* In a bug report, please specify your video card brand and model, and your OS
version (Win98, WinXP, etc).<br>
@@ -349,17 +324,15 @@ SourceForge's feature request system</a> to enter new feature requests. Also,
please discuss feature ideas on the
<a href="http://www.ddrmaniax.net/ddrmaniax/boards/index.php?act=SF&f=17">
StepMania message board</a> or the
<a href="mailto:[email protected]">StepMania <br>
developers list</a>. &nbsp;<br>
<a href="mailto:[email protected]">StepMania developers list</a>. &nbsp;<br>
<br>
If you would like to help with development of StepMania, please send an email to
the <a href="mailto:[email protected]">StepMania developers list</a>
or to <a href="mailto:[email protected]">Chris</a>.<br>
<br>
<br>
************************************************************<br>
<a name="The StepMania editor">The StepMania editor</a><br>
************************************************************<br>
<hr>
<a name="The StepMania editor">The StepMania editor</a>
<hr>
<br>
The StepMania editor allows you to edit, record, synchronize, and play back note
patterns. When you choose 'Save', your song will be saved in both the .SM format
@@ -379,10 +352,9 @@ the editor:<br>
* P - Play back current selection (if no selection, play whole song)<br>
* R - Record over current selection (if no selection, record whole song)<br>
<br>
<br>
************************************************************<br>
<a name="The .SM file format">The .SM file format</a><br>
************************************************************<br>
<hr>
<a name="The .SM file format">The .SM file format</a>
<hr>
<br>
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
@@ -433,22 +405,22 @@ the background should begin playing a new background named 'bg name'. 'beat' is
a fractional value value and 'bg name' is a string. Different bg changes are
separated by commas. e.g. &quot;60=falling,80=flower&quot;.&nbsp; When StepMania looks for
a backgound, it searches in this order:<br>
- Looks for a movie with file name = &quot;bg name&quot; in the song folder. You must
include the file extension in &quot;bg name&quot;. e.g. &quot;60=falling.avi,80=flower.mpg&quot;.<br>
- Looks for a BGAnimation folder with the name &quot;bg name&quot; in the song folder.<br>
- Looks for a movie with file name &quot;bg name&quot; in the RandomMovies folder. You
must include the file extension in &quot;bg name&quot;. e.g. &quot;60=falling.avi,80=flower.mpg&quot;.<br>
- Looks for a BGAnimation with file name &quot;bg name&quot; in the BGAnimations folder.<br>
- Looks for a Visualization with the file name &quot;bg name&quot; in the Visualizations
<ol>
<li>Looks for a movie with file name = &quot;bg name&quot; in the song folder. You must
include the file extension in &quot;bg name&quot;. e.g. &quot;60=falling.avi,80=flower.mpg&quot;.</li>
<li>Looks for a BGAnimation folder with the name &quot;bg name&quot; in the song folder.</li>
<li>Looks for a movie with file name &quot;bg name&quot; in the RandomMovies folder. You
must include the file extension in &quot;bg name&quot;. e.g. &quot;60=falling.avi,80=flower.mpg&quot;.</li>
<li>Looks for a BGAnimation with file name &quot;bg name&quot; in the BGAnimations folder.</li>
<li>Looks for a Visualization with the file name &quot;bg name&quot; in the Visualizations
folder. For example, suppose you have a song B4U and special B4U-specific
BGAnimations called &quot;robot&quot; and &quot;electric&quot;. First, move the robot and electric
BGAnimation folders into the B4U song folder (e.g. Songs\4th Mix\B4U\robot and
Songs\4th Mix\B4U\electric). Then, using the editor, insert a new background
change at each point in the song where you to switch to a new BGAnimation. When
prompted for the name of the background change, you could type either &quot;robot&quot; or
&quot;electric&quot;.<br>
<br>
<br>
&quot;electric&quot;.</li>
</ol>
<br>
Each pattern of notes has the same basic format:<br>
<br>
@@ -460,10 +432,10 @@ NotesType: Must be one of the currently supported types in StepMania:
<br>
Description: This will be displayed on the gameplay screen. This can be any
text, but is most commonly:<br>
&quot;Basic&quot;, &quot;Another&quot;, &quot;Trick&quot;, &quot;Standard&quot;, &quot;SSR&quot;, &quot;Maniac&quot;, &quot;Heavy&quot;, &quot;Challenge&quot;,
&quot;Beginner&quot;, &quot;Basic&quot;, &quot;Another&quot;, &quot;Trick&quot;, &quot;Standard&quot;, &quot;SSR&quot;, &quot;Maniac&quot;, &quot;Heavy&quot;, &quot;Challenge&quot;,
&quot;SManaic&quot;<br>
<br>
DifficultyClass: This value must be &quot;easy&quot;, &quot;medium&quot;, or &quot;hard&quot;. These values
DifficultyClass: This value must be &quot;beginner&quot;, &quot;easy&quot;, &quot;medium&quot;, &quot;hard&quot;, or &quot;challenge&quot;. These values
correspond the levels of difficulty on the Select Difficulty screen.<br>
<br>
DifficultyMeter: The difficulty of these notes as a bar rating. The value must
@@ -532,9 +504,9 @@ Example:<br>
0000<br>
;<br>
<br>
************************************************************<br>
<a name="Backgrounds">Backgrounds</a><br>
************************************************************<br>
<hr>
<a name="Backgrounds">Backgrounds</a>
<hr>
<br>
StepMania supports three different modes of backgrounds. The default background
mode can be set in the Graphic Options menu.<br>
@@ -560,10 +532,9 @@ computers.<br>
Sample animations, visualizations, and random movies can be found at
<a href="http://www.stepmania.com">www.stepmania.com</a>.<br>
<br>
<br>
************************************************************<br>
<a name="BGAnimations Format">BGAnimations Format</a><br>
************************************************************<br>
<hr>
<a name="BGAnimations Format">BGAnimations Format</a>
<hr>
<br>
The BGAnimations folder in the StepMania program directory may contain several
BGAnimation folders.<br>
@@ -650,10 +621,9 @@ TileFlipY,<br>
TilePulse,<br>
- Tiles zoom in and out.<br>
<br>
<br>
************************************************************<br>
<a name="The .CRS File Format">The .CRS File Format</a><br>
************************************************************<br>
<hr>
<a name="The .CRS File Format">The .CRS File Format</a>
<hr>
<br>
CRS files define the courses used in the &quot;Oni&quot; Nonstop Challenge mode. All CRS
files must reside in the &quot;Courses&quot; folder in the StepMania program folder.<br>
@@ -680,26 +650,23 @@ norecover, suddendeath, power-drop, death<br>
0.7xmusic, 0.8xmusic, 0.9xmusic, 1.0xmusic, 1.1xmusic, <br>
1.2xmusic, 1.3xmusic, 1.4xmusic, 1.5xmusic<br>
<br>
<br>
************************************************************<br>
<a name="Extra Stages">Extra Stages</a><br>
************************************************************<br>
<hr>
<a name="Extra Stages">Extra Stages</a>
<hr>
<br>
You can manually specify extra stages for each song group by creating .CRS files
called &quot;extra1.crs&quot; and &quot;extra2.crs&quot; and placing them in the song group folder
(e.g. Songs\MAX2\extra1.crs). When it comes time to play an extra stage the
first song in the .crs file will be used. Don't forget to specify modifiers -
see the &quot;CRS File Format&quot; section of this document for more information. If a
CRS file is not found or is invalid, the program will choose an appropriate
song, notes, and modifiers.<br>
CRS file is not found or is invalid, appropriate song, notes, and modifiers will be chosen.<br>
<br>
Don't forget: extra stage CRS files belong in the song group folder (e.g.
&quot;Songs/DDRMAX/&quot;), not in &quot;Courses&quot;.<br>
<br>
<br>
************************************************************<br>
<a name="Creating an Announcer">Creating an Announcer</a><br>
************************************************************<br>
<hr>
<a name="Creating an Announcer">Creating an Announcer</a>
<hr>
<br>
Announcers folders must reside in the &quot;Announcers&quot; folder inside the StepMania
program directory (e.g. &quot;Announcers\DDRMAX\&quot;). An announcer folder contains
@@ -716,10 +683,9 @@ trigger folder is missing, then no sound will be played for that trigger.<br>
For a complete list of announcer trigger names, see the example announcer packs
that are available at <a href="http://www.stepmania.com">www.stepmania.com</a>.<br>
<br>
<br>
************************************************************<br>
<a name="Creating a Note Skin">Creating a Note Skin</a><br>
************************************************************<br>
<hr>
<a name="Creating a Note Skin">Creating a Note Skin</a>
<hr>
<br>
Note skins allow you to customize the way notes appear. Note skins must reside
in the folder &quot;NoteSkins\&lt;Game Name&gt;\&lt;Note Skin Name&gt;&quot;. Note skins are specific
@@ -748,10 +714,9 @@ wide, and hold parts which must be 4x2.<br>
For more information on about textures with multiple frames, see the section
&quot;How StepMania Loads Textures&quot; in this document.<br>
<br>
<br>
************************************************************<br>
<a name="Creating a Theme">Creating a Theme</a><br>
************************************************************<br>
<hr>
<a name="Creating a Theme">Creating a Theme</a>
<hr>
<br>
All themes must reside in the Themes folder below the StepMania program
directory. Inside a theme folder, you will all or only a few of the items below:<br>
@@ -810,7 +775,7 @@ the right size, try increasing this value. If not specified, StepMania will use
0 for this value.<br>
AddToAllWidths=&lt;0..32&gt;: The value in this line will be added to the width of
every character in the font. Increase this value to increase character spacing
in your font. This feature is also useful if you wish to add a black border the
in your font. This feature is also useful if you wish to add a border to the
characters of your font. If not specified, StepMania will use 0 for this value.
ScaleAllWidthsBy=&lt;0.0...2.0&gt;: The width of every character in the font be
multipled by this value. If not specified, StepMania will use 1 for this value.<br>
@@ -834,7 +799,7 @@ this folder must be 5 frames by 3 frames (5x3) and follow the standard layout
<br>
Sounds: This folder contains sounds. Sounds may be in OGG, MP3, or WAV format.<br>
<br>
metrics.ini: A metric is simply a values that can alter the appearance of the
metrics.ini: A metric is simply values that can alter the appearance of the
game. metrics.ini is a large list of values that will allow you to alter things
like the position of elements in the menus, and the order of menu screens. There
is no documentation or explaination of these values other than the value name.
@@ -852,7 +817,7 @@ found in this folder, StepMania then look for the theme element in the theme
folder called &quot;default&quot;. The theme &quot;default&quot; is a base theme and guaranteed that
a theme is usable even if it is missing elements. <br>
<br>
This &quot;fallback&quot; system has other advantages too. User-created themes, can
This &quot;fallback&quot; system has other advantages too. User-created themes can
override as many or as few theme elements as the author pleases. For example,
you could create a theme called &quot;MySuperTheme&quot; which does nothing more than
override the title menu logo. Here's how you would create this theme:<br>
@@ -864,10 +829,9 @@ Graphics folder &quot;Themes\MySuperTheme\Graphics&quot;. <br>
- Edit your new title menu graphic to be whatever you want.<br>
- Start StepMania, go to Appearance Options, and change your theme to &quot;MySuperTheme&quot;.<br>
<br>
<br>
************************************************************<br>
<a name="How StepMania Loads Textures">How StepMania Loads Textures</a><br>
************************************************************<br>
<hr>
<a name="How StepMania Loads Textures">How StepMania Loads Textures</a>
<hr>
<br>
* What are textures?<br>
<br>
@@ -918,7 +882,7 @@ DelayNNNN is the time in seconds to show the state.<br>
<br>
* My graphics show ugly banding or look washed out. What can I do?<br>
<br>
Change your PNG images to use &quot;palette mode&quot; instead of &quot;RGB mode&quot;.&nbsp;
Change your PNG images to use &quot;palette mode&quot; instead of &quot;RGB mode&quot;.
Paletted images have three advantages:<br>
- StepMania can load paletted images with higher color precision than RGB
images.<br>
@@ -928,9 +892,12 @@ image.<br>
<br>
However, paletted PNGs have a couple limitations:<br>
- they support you to only &quot;on/off&quot; alpha.<br>
- they support a maxiumum of 256 colors.&nbsp; This can make smooth gradients
- they support a maxiumum of 256 colors. This can make smooth gradients
look ugly. <br>
<br>
Alternatively, inserting "dither" into filenames will instruct StepMania
to dither the image when loading.
<br>
<br>
* Why do the graphics look so blurry?<br>
<br>
@@ -939,10 +906,9 @@ greater in size than 256x256. If a texture is larger than the card's maximum
texture size, the image will scaled down internally resulting in output that
looks blurry.<br>
<br>
<br>
************************************************************<br>
<a name="Building StepMania from CVS source">Building StepMania from CVS source</a><br>
************************************************************<br>
<hr>
<a name="Building StepMania from CVS source">Building StepMania from CVS source</a>
<hr>
<br>
CVS is the repository that manages the StepMania source code. Our CVS server is
graciously provided by SourceForge. You can get the absolute-latest bleeding
@@ -1066,22 +1032,20 @@ and put &quot;ssh.bat&quot; into the editbox. <br>
<br>
* All done!&nbsp; Congrats.<br>
<br>
<br>
************************************************************<br>
<a name="Thanks">Thanks</a><br>
************************************************************<br>
<hr>
<a name="Thanks">Thanks</a>
<hr>
<br>
Thanks to:<br>
redcrusher for help on ez2 graphics<br>
Dj Slash &amp; Tony Thai for the caution graphic<br>
Kyle &quot;KeeL&quot; Ward for his awesome menu music (www.ampcast.com/keel)<br>
<br>
<br>
************************************************************<br>
End of document<br>
************************************************************<br>
&nbsp;</p>
<hr>
End of document
<hr>
</p>
</body>
</html>
</html>