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

change doc formatting

Browse Source
This commit is contained in:
Chris Danford
2003-10-12 18:52:38 +00:00
parent a9d3cc5017
commit 575c4a0be1
1 changed files with 149 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stepmania/README-FIRST.html
+149 -65
View File
@@ -6,14 +6,14 @@
<body>
<h1><font face="Courier New" size="2">StepMania X.X Readme</font></h1>
<h1><font size="2">StepMania X.X Readme</font></h1>
<p><font face="Courier New" size="2">&copy;2001-2003, StepMania team, All rights reserved.<br>
<p><font size="2">&copy;2001-2003, StepMania team, All rights reserved.<br>
<a href="http://www.stepmania.com">http://www.stepmania.com</a></font></p>
<p>
<hr>
<font face="Courier New" size="2"><a name="Table of Contents">Table of Contents</a></font><hr>
<font face="Courier New" size="2">
<font size="2"><a name="Table of Contents">Table of Contents</a></font><hr>
<font size="2">
<br>
<a href="#About StepMania">About StepMania</a><br>
<a href="#Minimum Requirements">Minimum Requirements</a><br>
@@ -47,9 +47,12 @@ See the file <a href="NEWS">NEWS</a> for version history.<br>
See the file <a href="COPYING.txt">COPYING.txt</a> for license information.<br>
<br>
</font>
<a name="About StepMania">
<font face="Courier New" size="2">
<a name="About StepMania"><hr>About StepMania</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
About StepMania</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -63,9 +66,12 @@ real fun comes when using specially designed controllers, like a dance pad or
hand sensors.<br>
<br>
</font>
<a name="Minimum Requirements">
<font face="Courier New" size="2">
<a name="Minimum Requirements"><hr>Minimum Requirements</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Minimum Requirements</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
* Windows 98, Windows ME, Windows 2000, or Windows XP<br>
* Pentium II, Pentium III, Celeron, Athlon, or compatible processor, 266MHz
@@ -78,18 +84,24 @@ minimum (400 MHz recommended)<br>
<br>
<br>
</font>
<a name="DirectX">
<font face="Courier New" size="2">
<a name="DirectX"><hr>DirectX</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
DirectX</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
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>
</font>
<a name="Installation">
<font face="Courier New" size="2">
<a name="Installation"><hr>Installation</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Installation</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -97,9 +109,12 @@ 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>
</font>
<a name="Controls">
<font face="Courier New" size="2">
<a name="Controls"><hr>Controls</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Controls</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -156,9 +171,12 @@ In the music select screen:<br>
* F9 = Toggle title translations<br>
<br>
</font>
<a name="How StepMania Loads Songs">
<font face="Courier New" size="2">
<a name="How StepMania Loads Songs"><hr>How StepMania Loads Songs</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
How StepMania Loads Songs</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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>
@@ -194,9 +212,12 @@ If there is exactly one movie in the song folder, StepMania will insert a
background change to that movie at beat 0.<br>
<br>
</font>
<a name="Connecting Dance Pads">
<font face="Courier New" size="2">
<a name="Connecting Dance Pads"><hr>Connecting Dance Pads</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Connecting Dance Pads</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
There are several devices that allow you to connect PlayStation dance pads to
your PC.<br>
@@ -234,9 +255,12 @@ is NTPad XP 1.x or PSXPAD.&nbsp; For the latest versions of these drivers, visit
StepMania now natively supports USB Pump It Up pads.<br>
<br>
</font>
<a name="Compatibility Issues">
<font face="Courier New" size="2">
<a name="Compatibility Issues"><hr>Compatibility Issues</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Compatibility Issues</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -268,9 +292,12 @@ 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>
</font>
<a name="FAQ / Troubleshooting">
<font face="Courier New" size="2">
<a name="FAQ / Troubleshooting"><hr>FAQ / Troubleshooting</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
FAQ / Troubleshooting</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
* The error &quot;Cannot find Dinput8.dll&quot; appears when launching the game.<br>
<br>
@@ -299,9 +326,12 @@ 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>
</font>
<a name="StepMania Packages - .smzip">
<font face="Courier New" size="2">
<a name="StepMania Packages - .smzip"><hr>StepMania Packages - .smzip</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
StepMania Packages - .smzip</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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,10 +354,13 @@ will take all of the selected items and make one package that contains them all.
the list.<br>
<br>
</font>
<a name="Questions, Bugs, Suggestions, and Help">
<font face="Courier New" size="2">
<a name="Questions, Bugs, Suggestions, and Help"><hr>Questions, Bugs, Suggestions,
and Help</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Questions, Bugs, Suggestions,
and Help</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -355,9 +388,12 @@ the <a href="mailto:[email protected]">StepMania developers list</a
or to <a href="mailto:[email protected]">Chris</a>.<br>
<br>
</font>
<a name="The StepMania editor">
<font face="Courier New" size="2">
<a name="The StepMania editor"><hr>The StepMania editor</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
The StepMania editor</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -378,9 +414,12 @@ the editor:<br>
* R - Record over current selection (if no selection, record whole song)<br>
<br>
</font>
<a name="The .SM file format">
<font face="Courier New" size="2">
<a name="The .SM file format"><hr>The .SM file format</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
The .SM file format</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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,13 +472,13 @@ separated by commas. e.g. &quot;60=falling,80=flower&quot;.&nbsp; When StepMania
a backgound, it searches in this order:<br>
</font>
<ol>
<li><font face="Courier New" size="2">Looks for a movie with file name = &quot;bg name&quot; in the song folder. You must
<li><font size="2">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;.</font></li>
<li><font face="Courier New" size="2">Looks for a BGAnimation folder with the name &quot;bg name&quot; in the song folder.</font></li>
<li><font face="Courier New" size="2">Looks for a movie with file name &quot;bg name&quot; in the RandomMovies folder. You
<li><font size="2">Looks for a BGAnimation folder with the name &quot;bg name&quot; in the song folder.</font></li>
<li><font size="2">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;.</font></li>
<li><font face="Courier New" size="2">Looks for a BGAnimation with file name &quot;bg name&quot; in the BGAnimations folder.</font></li>
<li><font face="Courier New" size="2">Looks for a Visualization with the file name &quot;bg name&quot; in the Visualizations
<li><font size="2">Looks for a BGAnimation with file name &quot;bg name&quot; in the BGAnimations folder.</font></li>
<li><font size="2">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
@@ -448,7 +487,7 @@ 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;.</font></li>
</ol>
<font face="Courier New" size="2">
<font size="2">
<br>
Each pattern of notes has the same basic format:<br>
<br>
@@ -533,9 +572,12 @@ Example:<br>
;<br>
<br>
</font>
<a name="Backgrounds">
<font face="Courier New" size="2">
<a name="Backgrounds"><hr>Backgrounds</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Backgrounds</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
StepMania supports three different modes of backgrounds. The default background
mode can be set in the Graphic Options menu.<br>
@@ -562,9 +604,12 @@ Sample animations, visualizations, and random movies can be found at
<a href="http://www.stepmania.com">www.stepmania.com</a>.<br>
<br>
</font>
<a name="BGAnimations Format">
<font face="Courier New" size="2">
<a name="BGAnimations Format"><hr>BGAnimations Format</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
BGAnimations Format</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
The BGAnimations folder in the StepMania program directory may contain several
BGAnimation folders.<br>
@@ -652,9 +697,12 @@ TilePulse,<br>
- Tiles zoom in and out.<br>
<br>
</font>
<a name="The .CRS File Format">
<font face="Courier New" size="2">
<a name="The .CRS File Format"><hr>The .CRS File Format</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
The .CRS File Format</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
CRS files define the courses used in the Nonstop, Oni, and Endless modes.&nbsp; All CRS
files must reside in the &quot;Courses&quot; folder in the StepMania program folder.&nbsp;
@@ -724,9 +772,12 @@ dark<br>
1.2xmusic, 1.3xmusic, 1.4xmusic, 1.5xmusic<br>
<br>
</font>
<a name="Extra Stages">
<font face="Courier New" size="2">
<a name="Extra Stages"><hr>Extra Stages</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Extra Stages</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -742,9 +793,19 @@ Don't forget: extra stage CRS files belong in the song group folder (e.g.
<font face="Courier New" size="2"><hr>
</font>
<font size="2">
<a name="Unlock System">Unlock System </a>(<a href="#Table of Contents">top</a>)
</font>
<font face="Courier New" size="2">
<hr>
Stepmania now supports an unlocking system. This means you can choose to make some songs or courses hidden from the selection interface until a certain condition has been met. Some of the methods implemented are:<p>
<font size="2">Stepmania now supports an unlocking system. This means you can choose to make some songs or courses hidden from the selection interface until a certain condition has been met. Some of the methods implemented are:<p>
Dance points (DP)<br>
Song stays locked until a certain number of dance points are accumulated. A Perfect is worth 2 points, Great is 1, etc.<p>
Arcade points (AP)<br>
@@ -767,13 +828,17 @@ Song "the Legend of Max" is in roulette slot 3.<p>
Song "Paranoia Survivor MAX" is locked either by clearing 30 stages, or by landing on it in roulette.<p>
#UNLOCK:POP 4:CS=50;<p>
Course Pop 4 is locked until 50 stages are cleared. (Stepmania doesn't distinguish between song and course titles yet.)<p>
A note about roulette seeds – Each entry to be locked via roulette must have its own seed – if multiple songs have the same seed and one of them is landed on, all of them become unlocked. A song locked by roulette does NOT need to be cleared in order to become unlocked.<p>
</font>
A note about roulette seeds – Each entry to be locked via roulette must have its own seed – if multiple songs have the same seed and one of them is landed on, all of them become unlocked. A song locked by roulette does NOT need to be cleared in order to become unlocked.</font></font><p>
<a name="Creating an Announcer">
<font face="Courier New" size="2">
<a name="Creating an Announcer"><hr>Creating an Announcer</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Creating an Announcer</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -791,9 +856,12 @@ 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>
</font>
<a name="Creating a Note Skin">
<font face="Courier New" size="2">
<a name="Creating a Note Skin"><hr>Creating a Note Skin</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Creating a Note Skin</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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
@@ -829,9 +897,12 @@ For more information on about textures with multiple frames, see the section
&quot;How StepMania Loads Textures&quot; in this document.<br>
<br>
</font>
<a name="Creating a Theme">
<font face="Courier New" size="2">
<a name="Creating a Theme"><hr>Creating a Theme</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Creating a Theme</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<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>
@@ -948,10 +1019,12 @@ Graphics folder &quot;Themes\MySuperTheme\Graphics&quot;. <br>
- Start StepMania, go to Appearance Options, and change your theme to &quot;MySuperTheme&quot;.<br>
<br>
</font>
<font face="Courier New" size="2"><a name="Actor Commands"><hr>Actor Commands</a> (<a href="#Table of Contents">top</a>)</font>
<a name="Actor Commands">
<font face="Courier New" size="2"><hr></font>
<font size="2">Actor Commands</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font>
<hr>
<p>
<font face="Courier New" size="2">
<font size="2">
<br>
In the old paradigm, you would define the position of an Actor with two
different metrics - one for the X position, and one for the Y. For example:<br>
@@ -1023,10 +1096,12 @@ additiveblend EnableAdditiveBlend( iParam(0)!=0 );<br>
<br>
<br>
&nbsp;</font></p>
<font face="Courier New" size="2"><a name="ScreenSelect"><hr>ScreenSelect</a> (<a href="#Table of Contents">top</a>)</font>
<a name="ScreenSelect">
<font face="Courier New" size="2"><hr></font>
<font size="2">ScreenSelect</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font>
<hr>
<p>
<font face="Courier New" size="2">
<font size="2">
<br>
ScreenSelect is a type of screen that presents the user with a list of choices.
The choices shown on these screens can be Styles, Difficulties, PlayModes, or
@@ -1065,9 +1140,12 @@ Choices=versus-arcade-medium,couple-arcade-medium,double-arcade-medium,single-ar
<br>
<br>
&nbsp;</font></p>
<a name="How StepMania Loads Textures">
<font face="Courier New" size="2">
<a name="How StepMania Loads Textures"><hr>How StepMania Loads Textures</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
How StepMania Loads Textures</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
* What are textures?<br>
<br>
@@ -1143,10 +1221,13 @@ texture size, the image will scaled down internally resulting in output that
looks blurry.<br>
<br>
</font>
<a name="Building StepMania from CVS source">
<font face="Courier New" size="2">
<a name="Building StepMania from CVS source"><hr>Building StepMania from CVS source</a>
<hr></font>
<font size="2">
Building StepMania from CVS source</font></a><font size="2">
(<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<font size="2">
<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
@@ -1271,9 +1352,12 @@ and put &quot;ssh.bat&quot; into the editbox. <br>
* All done!&nbsp; Congrats.<br>
<br>
</font>
<a name="Thanks">
<font face="Courier New" size="2">
<a name="Thanks"><hr>Thanks</a> (<a href="#Table of Contents">top</a>)</font><hr>
<font face="Courier New" size="2">
<hr></font>
<font size="2">
Thanks</font></a><font size="2"> (<a href="#Table of Contents">top</a>)</font><hr>
<font size="2">
<br>
redcrusher (Michael Curry) for help on ez2 graphics<br>
Dj Slash &amp; Tony Thai for the caution graphic<br>
@@ -1284,7 +1368,7 @@ Philip Hazel, and copyright the University of Cambridge, England.
<br>
</font>
<hr>
<font face="Courier New" size="2">End of document </font>
<font size="2">End of document </font>
<hr>
</p>