diff --git a/stepmania/Docs/readme.html b/stepmania/Docs/readme.html new file mode 100644 index 0000000000..f59b5a5a87 --- /dev/null +++ b/stepmania/Docs/readme.html @@ -0,0 +1,288 @@ + + + + +StepMania Readme + + + +

StepMania Documentation

+ +
+
+
+

 

+ +

1. What is StepMania?

+

StepMania is a music/rhythm game. The player presses different buttons in time to the music and to note patterns that scroll across the screen. Features 3D graphics, visualizations, support for gamepads/dance pads, a step recording mode, and more!
+ 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 Paradise. In the future, it will support games similar to BeatMania, Guitar Freaks, DrumMania, and more. + +The games played by StepMania are rhythm games. Notes scroll up from the bottom of the screen, and the player must hit the corresponding button on the 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.

+ +

2. System Requirements

+ +

3. Installation

+

3a. Installing StepMania

+

To install StepMania on Windows 98/ME/2000/XP:

+
    +
  1. Point your web browser to the StepMania Sourceforge.net project files page at http://sourceforge.net/project/showfiles.php?group_id=37892
  2. +
  3. Download the file stepmania-X.Y-Z.exe where X, Y, and Z are version numbers, and save it to your hard drive.
  4. +
  5. Double click Stepmania-X.Y-Z.exe, and follow the instructions on screen.
  6. +
  7. After installation, add songs, themes, noteskins, etc to their appropriate directories (see section 5)
  8. +
  9. To run StepMania, click the Start button, select Programs or All Programs, select StepMania (or Stepmania CVS) and click Play Stepmania.
  10. +
+

To install on Linux/Unix using the binaries:

+
    +
  1. Point your web browser to the StepMania Sourceforge.net project files page at http://sourceforge.net/project/showfiles.php?group_id=37892
  2. +
  3. Download stepmania-X.Y-Z-linux.tar.gz (where X.Y-Z are version numbers) to a folder on your hard drive.
  4. +
  5. Extract the archive using tar -zxvf stepmania-X.Y-Z-linux.tar.gz
  6. +
  7. Add songs/themes/noteskins/etc. to the appropriate folders (see Section 5)
  8. +
  9. To Start StepMania, run ./stepmania from the installation folder.
  10. +
+

To compile/install StepMania from a source tarball:

+
    +
  1. Point your web browser to the StepMania Sourceforge.net project files page at http://sourceforge.net/project/showfiles.php?group_id=37892
  2. +
  3. Download stepmania-X.Y-Z-linux-src.tar.gz to a location in your hard drive
  4. +
  5. Extract the archive using tar -zxvf stepmania-X.Y-Z-linux-src.tar.gz
  6. +
  7. In the extracted folder, type ./configure
  8. +
  9. Finally, type make (or gmake) to build StepMania
  10. +
+

To install StepMania on Mac OSX:

+

TODO

+

3b. Adding songs, themes, characters, etc

+

To add songs to StepMania:

+
    +
  1. Open your StepMania installation directory, and the folder called "Songs"
  2. +
  3. Create subdirectories for each song group (game the songs came from, step artist, etc). These will appear as groups on the song wheel.
  4. +
  5. Create folders for each song you want in the group.
  6. +
  7. Place inside the folder: +
      +
    1. the DWI or SM step file
    2. +
    3. the song's music file
    4. +
    5. a background (optional)
    6. +
    7. a banner (optional
    8. +
    + .
  8. +
+

Themes, BG Animations, Characters, Note skins, and announcers should be placed in subdirectories of their respective folders.

+

For Example, the files for the Foo announcer would reside in Announcers/Foo/

+

Alternatively, some StepMania addons come in .SMZIP format. This special archive contains all the files for an addon. Simply double-click it to install the files in the right places.

+

4. Using StepMania

+

Once you start Stepmania, you will be presented with the Stepmania Title Screen

+

+

Hit the Start or Back buttons (Enter or Esc by default) to go to the main menu. (Note that in Freeplay or Pay mode, the main menu is disabled)

+

+

4a. Starting the Game

+

From the Main Menu, select Game Start. After the warning screen appears, you will be presented with the Select Style screen.

+

+

Select one of the five styles to continue:

+ +

Once you select a style, you are presented with the Select Difficulty screen.

+

+

Select a difficulty to continue, or scroll right past Heavy to show the Challenge/Oni screen.

+

+

These modes are more difficult than the standard game modes.

+

Once you select a difficulty, you are presented with the song wheel.

+

+

Select a song with the Menu Left and Menu right keys (see Section 4c to define them)

+

Once you select a song, you are presented a variety of information about this song.

+
    +
  1. This is the currently selected song's banner.
  2. +
  3. This is the speed (in Beats Per Minute) of the currently selected song.
  4. +
  5. This is the Groove Radar. It shows how much Freeze, Chaos, Voltage, Air, and Stream a song has.
  6. +
  7. This is the feet rating. It shows how difficult overall a song is.
  8. +
  9. This is the song wheel. Rotate it to select a song with Menu Left and Menu Right, or Pad left and Pad right (see section 4c)
  10. +
  11. This shows how the songs on the song wheel are sorted. To change the sort press Up, down, up, and down on the pad or keyboard to display the list of choices for song sorting. Select one with Start.
  12. +
  13. This shows the current stage number. "Event" is displayed in Event mode.
  14. +
+

To Start a song, select it, and press start. Depending on your options, you may also press start within a second or two after that to enter the Song Options menu.

+

4b. Song options

+

The song options menu contains a variety of options to alter the way the game is played. These include

+

+ +

Once you press Exit on the second screen, the game will start.

+

4c. Game Options

+

Select Options from the main menu to get to the Options menu.

+

+

Below are descriptions of available SM options.

+ +

4d. The Stepmania Editor

+

TODO

+

5. Using smpackage

+

smpackage is a simple suiite of tools for managing your Stepmania installation. It contains smzip archives tools, theme tools

+

6. Supported Controllers or Controller Adapters

+For a list of controllers and conroller adapters supported by StepMania, see http://www.stepmania.com/stepmania-old/adapter.php7. SMConvert +

Comming soon!

+

7. Getting Help/Contact

+

There are a variety of ways to get help with StepMania. If you have thoroughly read this manual (emphasis on thoroughly), and still require help, you can either:

+ +

8. Changelog

+

May-1-2005: Initial Rewrite.

+ +