From 575c4a0be17f632c3cbe1e09079c6d135dd85c02 Mon Sep 17 00:00:00 2001 From: Chris Danford Date: Sun, 12 Oct 2003 18:52:38 +0000 Subject: [PATCH] change doc formatting --- stepmania/README-FIRST.html | 214 +++++++++++++++++++++++++----------- 1 file changed, 149 insertions(+), 65 deletions(-) diff --git a/stepmania/README-FIRST.html b/stepmania/README-FIRST.html index 417a226ba3..28b094e218 100644 --- a/stepmania/README-FIRST.html +++ b/stepmania/README-FIRST.html @@ -6,14 +6,14 @@ -

StepMania X.X Readme

+

StepMania X.X Readme

-

©2001-2003, StepMania team, All rights reserved.
+

©2001-2003, StepMania team, All rights reserved.
http://www.stepmania.com

-Table of Contents
- +Table of Contents
+
About StepMania
Minimum Requirements
@@ -47,9 +47,12 @@ See the file NEWS for version history.
See the file COPYING.txt for license information.

 + -
About StepMania (top)
- +
 + +About StepMania (top)
+
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.

 + -
Minimum Requirements (top)
- +
 + +Minimum Requirements (top)
+
* Windows 98, Windows ME, Windows 2000, or Windows XP
* Pentium II, Pentium III, Celeron, Athlon, or compatible processor, 266MHz @@ -78,18 +84,24 @@ minimum (400 MHz recommended)


 + -
DirectX (top)
- +
 + +DirectX (top)
+
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.

 + -
Installation (top)
- +
 + +Installation (top)
+
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'.

 + -
Controls (top)
- +
 + +Controls (top)
+
Use the "Config Key/Joy" 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:
* F9 = Toggle title translations

 + -
How StepMania Loads Songs (top)
- +
 + +How StepMania Loads Songs (top)
+
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:
@@ -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.

 + -
Connecting Dance Pads (top)
- +
 + +Connecting Dance Pads (top)
+
There are several devices that allow you to connect PlayStation dance pads to your PC.
@@ -234,9 +255,12 @@ is NTPad XP 1.x or PSXPAD.  For the latest versions of these drivers, visit StepMania now natively supports USB Pump It Up pads.

 + -
Compatibility Issues (top)
- +
 + +Compatibility Issues (top)
+
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.

 + -
FAQ / Troubleshooting (top)
- +
 + +FAQ / Troubleshooting (top)
+
* The error "Cannot find Dinput8.dll" appears when launching the game.

@@ -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).

 + -
StepMania Packages - .smzip (top)
- +
 + +StepMania Packages - .smzip (top)
+
The StepMania package format was created to make the distribution of songs and other add-ons very easy.  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.

 + -
Questions, Bugs, Suggestions, -and Help (top)
- +
 + +Questions, Bugs, Suggestions, +and Help (top)
+
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 StepMania developers listChris.

 + -
The StepMania editor (top)
- +
 + +The StepMania editor (top)
+
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:
* R - Record over current selection (if no selection, record whole song)

 + -
The .SM file format (top)
- +
 + +The .SM file format (top)
+
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. "60=falling,80=flower".  When StepMania a backgound, it searches in this order:
    -
  1. Looks for a movie with file name = "bg name" in the song folder. You must +
  2. Looks for a movie with file name = "bg name" in the song folder. You must include the file extension in "bg name". e.g. "60=falling.avi,80=flower.mpg".
    3. -
  3. Looks for a BGAnimation folder with the name "bg name" in the song folder.
    4. -
  4. Looks for a movie with file name "bg name" in the RandomMovies folder. You +
  5. Looks for a BGAnimation folder with the name "bg name" in the song folder.
    6. +
  6. Looks for a movie with file name "bg name" in the RandomMovies folder. You must include the file extension in "bg name". e.g. "60=falling.avi,80=flower.mpg".
    7. -
  7. Looks for a BGAnimation with file name "bg name" in the BGAnimations folder.
    8. -
  8. Looks for a Visualization with the file name "bg name" in the Visualizations +
  9. Looks for a BGAnimation with file name "bg name" in the BGAnimations folder.
    10. +
  10. Looks for a Visualization with the file name "bg name" in the Visualizations folder. For example, suppose you have a song B4U and special B4U-specific BGAnimations called "robot" and "electric". 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 "robot" or "electric".
- +
Each pattern of notes has the same basic format:

@@ -533,9 +572,12 @@ Example:
;

 + -
Backgrounds (top)
- +
 + +Backgrounds (top)
+
StepMania supports three different modes of backgrounds. The default background mode can be set in the Graphic Options menu.
@@ -562,9 +604,12 @@ Sample animations, visualizations, and random movies can be found at www.stepmania.com.

 + -
BGAnimations Format (top)
- +
 + +BGAnimations Format (top)
+
The BGAnimations folder in the StepMania program directory may contain several BGAnimation folders.
@@ -652,9 +697,12 @@ TilePulse,
- Tiles zoom in and out.

 + -
The .CRS File Format (top)
- +
 + +The .CRS File Format (top)
+
CRS files define the courses used in the Nonstop, Oni, and Endless modes.  All CRS files must reside in the "Courses" folder in the StepMania program folder.  @@ -724,9 +772,12 @@ dark
1.2xmusic, 1.3xmusic, 1.4xmusic, 1.5xmusic

 + -
Extra Stages (top)
- +
 + +Extra Stages (top)
+
You can manually specify extra stages for each song group by creating .CRS files called "extra1.crs" and "extra2.crs" 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.
+ + + + Unlock System (top) + + + +
-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:

+ + +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:

Dance points (DP)
Song stays locked until a certain number of dance points are accumulated. A Perfect is worth 2 points, Great is 1, etc.

Arcade points (AP)
@@ -767,13 +828,17 @@ Song "the Legend of Max" is in roulette slot 3.

Song "Paranoia Survivor MAX" is locked either by clearing 30 stages, or by landing on it in roulette.

#UNLOCK:POP 4:CS=50;

Course Pop 4 is locked until 50 stages are cleared. (Stepmania doesn't distinguish between song and course titles yet.)

-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.

- +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.

+ -

Creating an Announcer (top)
- +
 + + + +Creating an Announcer (top)
+
Announcers folders must reside in the "Announcers" folder inside the StepMania program directory (e.g. "Announcers\DDRMAX\"). 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 www.stepmania.com.

 + -
Creating a Note Skin (top)
- +
 + +Creating a Note Skin (top)
+
Note skins allow you to customize the way notes appear. Note skins must reside in the folder "NoteSkins\<Game Name>\<Note Skin Name>". Note skins are specific @@ -829,9 +897,12 @@ For more information on about textures with multiple frames, see the section "How StepMania Loads Textures" in this document.

 + -
Creating a Theme (top)
- +
 + +Creating a Theme (top)
+
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:
@@ -948,10 +1019,12 @@ Graphics folder "Themes\MySuperTheme\Graphics".
- Start StepMania, go to Appearance Options, and change your theme to "MySuperTheme".

 -
Actor Commands (top) + +
 +Actor Commands (top)

- +
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:
@@ -1023,10 +1096,12 @@ additiveblend EnableAdditiveBlend( iParam(0)!=0 );


 

-
ScreenSelect (top) + +
 +ScreenSelect (top)

- +
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

 

+ -
How StepMania Loads Textures (top)
- +
 + +How StepMania Loads Textures (top)
+
* What are textures?

@@ -1143,10 +1221,13 @@ texture size, the image will scaled down internally resulting in output that looks blurry.

 + -
Building StepMania from CVS source +
 + +Building StepMania from CVS source (top)
- +
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 "ssh.bat" into the editbox.
* All done!  Congrats.

 + -
Thanks (top)
- +
 + +Thanks (top)
+
redcrusher (Michael Curry) for help on ez2 graphics
Dj Slash & Tony Thai for the caution graphic
@@ -1284,7 +1368,7 @@ Philip Hazel, and copyright the University of Cambridge, England.
-End of document +End of document