-
-
-
- StepMania LUA Information
-| Singletons | -Classes | -Namespaces | -Global Functions | -Enums | -Constants | -
|---|
- -
-
-
-
-
-
-Singletons
--
-
-
-
-
-
-
-
-Classes
-
-
-
-
-Namespaces
-
-
- 
- Class
-
- :
-
-
-
-
-
-
-
-
- Namespace
-
-
-
-
-
-
-Global Functions
-| Functions |
|---|
-
-
-
-
-Enums
-
-
-
- Enum
-
-
-
-
-
-
-
-
-Constants
-| Constant | -Value | -
|---|---|
-
-
-
-
-
+
+
+
+
+
+
+ WARNING: Bindings are subject to change at any time. This includes, but is not limited to: renaming, removal, changing of arguments/return types.
+ To generate this file yourself, pass
+ sm-ssc Lua Information
+ WARNING: Bindings are subject to change at any time. This includes, but is not limited to: renaming, removal, changing of arguments/return types.
+ To generate this file yourself, pass
--ExportLuaInformation as an argument to the sm-ssc executable.
+ | Sections | +|||||
|---|---|---|---|---|---|
| Singletons | +Classes | +Namespaces | +Global Functions | +Enums | +Constants | +
+
+
+ + +
+
+
+
+
+
+Singletons
+-
+
-
+
+
+
+
+
+Classes
+
+
+
+
+Namespaces
+
+
+
+ Class
+
+ :
+
+
+
+
+
+
+
+
+ Namespace
+
+
+
+
+
+
+Global Functions
+| Functions |
|---|
+
+
+
+
+Enums
+
+
+
+ Enum
+
+
+
+
+
+
+
+
+Constants
+| Constant | +Value | +
|---|---|
|
+
+ |
+
+
+
+
+
+color can be in
- hex ("#FFFFFFFF") or 0..1 values ("1.0,1.0,1.0,1.0"),
- in RGBA order.
- sAddress.
- fPercentDancePoints formatted as a percentage.
- true if Event Mode is turned on.
- true if connected to the Internet.
- true if connected to StepMania Online.
- true if Player pn is logged on to
- a SMOnline server.
- sPath. If sPath points to a Lua file, any additional arguments will be passed to that script.
- m as a localized string.
- m as a string.
- fSecs to Minutes:Seconds.Milliseconds format.
- sString.
- true if sClassName is a registered Class.
- [1] would be the
- string 'PlayerNumber_P1'.- The functions defined in the
Enum namespace are valid member
- functions of every Enum where the first argument is
- omitted and the name of the Enum is used in place
- of Enum. Instead of
- Enum.GetName(
- ) or
- Enum.Reverse(
- ), one can use
- :GetName() or
- :Reverse(), respectively.
- x and y need to be elements of the enumerated
- type e. Returns a value less than/greater than/equal to
- 0 corresponding to the numerical value of x being
- less than/greater than/equal to the numerical value of y as
- determined by
- Enum.Reverse( e ).
- e. For example,
- Enum.GetName( )
- will return the string 'PlayerNumber'.
- e. For
- example: local r =
- Enum.Reverse( );
- local n = r['PlayerNumber_P2'];- The value of
n in this case would be 1 corresponding
- to the 0-based indexing using in C++ and not 2 as might be
- expected for the 1-based indexing used in Lua.
- game.
- st.
- sString to log.txt. Aliased by
- .
- sString to info.txt and log.txt as
- a warning. Aliased by .
- pn.
- st) are playable.
- st) are playable.
- nil if it doesn't have one.
- b.
- fRate * fRate), where fRate is in seconds.
- xPos to the Actor's current x position.
- yPos to the Actor's current y position.
- zPos to the Actor's current z position.
- h and v are in the range 0..1.
- true, cull the Actor's back faces. See also: .
- fAlpha, where fAlpha is in the range 0..1.
- rot.
- rot.
- rot.
- zoom.
- zoom.
- percent of the Actor from the bottom where percent is in the range 0..1.
- percent of the Actor from the left where percent is in the range 0..1.
- percent of the Actor from the right where percent is in the range 0..1.
- percent of the Actor from the top where percent is in the range 0..1.
- mode.
- fRate) * (1-fRate)), where fRate is in seconds.
- c.
- fAlpha, where fAlpha is in the range 0..1.
- c.
- c, ignoring any alpha value in c.
- c.
- c.
- c.
- c.
- c.
- c.
- c.
- iOrder, where larger values display first.
- s.
- c.
- c.
- fTime.
- fTime.
- percent of the Actor from the bottom where percent is in the range 0..1.
- percent of the Actor from the left where percent is in the range 0..1.
- percent of the Actor from the right where percent is in the range 0..1.
- percent of the Actor from the top where percent is in the range 0..1.
- true if the Actor has a command named sCmdName.
- fAlign which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See for the common case.
- align. See for fractional alignment.
- factor.
- fRate is in seconds.
- sName.
- sCommandName.
- sCommandName to be played.
- fAlign.
- fAlign.
- fAlign.
- iNewState.
- c.
- fLength.
- fLength.
- fLength.
- fAmount.
- fSeconds before executing the next command.
- fAlign which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See for the common case.
- align. See for fractional alignment.
- xPos.
- yPos.
- zPos.
- zoom scale.
- zoomX and zoomY.
- zoom height. See also: .
- zoom width. See also: .
- zoom scale on the X axis.
- zoom scale on the Y axis.
- zoom scale on the Z axis.
- sName.
- fRate.
- a.
- fWidth by fHeight pixels.
- fSecs.
- fSeconds.
- - A value of
0 means the scroller will not scroll.
- fItemHeight.
- fItemWidth.
- - *
SupportPan - Let the sound pan from side to side.- *
SupportRateChanging - Let the sound change rate and pitch.
- sPath.
- SupportPan = true on load.
- attr to the string at position
- iPos.- The attribute is a table that must contain
Length
- which specifies how many (multi-byte) characters the attribute
- is to apply. If Length=-1, then the attribute applies
- until another attribute overrides it.- If the table contains
Diffuse, then the color value
- is applied to the range of text.- If the table contains
Diffuses, then it should be
- an array of 4 colors which specify the diffuse color for the
- top left, top right, bottom left, and bottom right.- If the table contains
Glow, then the color value
- is applied as a glow to the range of text.- Example:
-
attr = { Length = 10; Diffuse = color("#AABBCC"); }
- bJitter is true, move each character of the string around by a small random amount.
- fHeight. If fHeight is 0, then there is no maximum height.
- fWidth. If fWidth is 0, then there is no maximum width.
- true, set each character of the text in turn to the rainbow colors in the metrics BitmapText::RainbowColor#.
- sText. This clears all attributes.
- c.
- true, make all text uppercase.
- iSpacing pixels of padding between lines of text.
- iWidth pixels. If you or by x and you want the text wrapped at width, then you should use wrapwidthpixels(width/x).
- sMetricsGroup.
- iIndex from the Course.
- true if the Course has modifiers.
- true if the Course has timed modifiers.
- true if the Course was automatically generated.
- true if the Course is Endless.
- sID.
- pn,
- then sets the DifficultyIcon's state from the difficulty of Steps pSteps
- pn,
- then sets the DifficultyIcon's state from the difficulty of Trail pTrail
- pn.
- fVolume for fDuration seconds.
- pn.
- sPath one time.
- true if any player has performed a feat worthy of ranking.
- sCommand
- for pn, if given. See .
- true if enough credits have been inserted to join.
- For example,
-
local credits = {GAMESTATE:GetCurrentStepsCredits()};- will make a table of the difficulties and descriptions. -
nil if
- it does not exist.
- nil
- if it does not exist.
- true if a freeze/stop is active in the song.
- true if the gameplay lead in is enabled. If
- false, gameplay begins immediately.
- true if the game is Multiplayer.
- pn.
- pn.
- pn.
- true if the song is currently in a freeze.
- true if the workout goal is complete.
- true if an extra stage was earned.
- true if this is an extra stage.
- true if any human player is using a memory card.
- true if playing in a Course mode.
- true if in Demonstration mode.
- true if the match was a draw.
- true if Event Mode is on, temporary or otherwise.
- true if this is the first extra stage.
- true if this is the second extra stage.
- true if player pn has completed the current Goal.
- true if player pn is human.
- true if player pn is enabled.
- true if player pn has joined the game.
- true if player pn is the winner.
- true if player pn is using modifier sModifier.
- true if players can join the game.
- course.
- song.
- pn to steps.
- trail.
- iFields
- pn to Difficulty dc.
- song.
- sGroup.
- so using ModsLevel m.
- bOn.
- bOn.
- sMetricsGroup.
- g.
- sMetricsGroup.
- pn to empty.
- pn from RadarValues rv
- fSeconds.
- tips (and optionally altTips).
- sTips using colons to separate new sections.
- true if failing.
- true if the LifeMeter is "hot".
- true if in danger.
- pn.
- fSeconds.
- bSilent.
- bStealth. If
- true, the timer will be invisible and silent.
- sMessage. The
- second argument is an optional table of parameters. It may be omitted or explicitly
- set to nil.
- sAniName at fPlayRate speed (default 1.0).
- fRate.
- sAnimation at fPlayRate speed (default 1.0).
- pn from the Metrics in group sMetricsGroup.
- sButton sElement.
- sButton sElement.
- pn.
- true if a full combo (TNS_W3 and up) was obtained.
- true if the player was disqualified from ranking.
- sPlayerOptions for the specified ModsLevel.
- sPreference.
- sPreference to value.
- sPreference to the default value.
- Course c, Trail t)
- s has been played with the profile.
- st.
- g on.
- g on.
- true if the player has passed any steps in the specified Song s.
- true if the specified code sUnlockEntryID is unlocked.
- iCals calories.
- iSecs seconds.
- gt.
- weightPounds.
- pn.
- true if the Profile for Player pn is persistent.
- rc from .
- sPath (relative to the StepMania root directory).-
iAccessType can be set to read (1), write (2), stream (4) or flush to disk on close (8).- These can also be combined with addition. For example, to set up read and write, set
iAccessType to 3 (1+2).
- str.
- sProperty to fVal. The supported properties depend on how the associated was loaded.
- fPitch. The associated have SupportsRateChanging = true on load.
- fSpeed. The associated must have SupportsRateChanging = true on load.
- {left, top, right, bottom}.
- bLoop.
- fPos.
- fRate.
- f.
- f seconds.
- sScreenMsg to the Screen.
- true if a single has its NoteField centered.
- pn.
- true if screen class s exists.
- true if screen s is prepared.
- s.
- true if Player pn backspaced successfully.
- true if Player pn was able to add sKey to their name.
- pn and returns true
- if successful.
- true if anyone is entering their name.
- true if anyone is still entering their name.- (As opposed to those who are Finalized; see ) -
true if Player pn is entering their name.
- true if Player pn is finished entering their name.
- pn.
- pn is on.
- true if we are going to PlayerOptions.
- true if there is a profile that can be loaded.
- true if there is a profile that can be saved.
- true
- if successful.
- pn to iProfileIndex.
- st.
- true if the song has steps for the specified difficulty in st.
- true if the song meets the criteria for a "Long Version".
- true if the song meets the criteria for "Marathon" length.
- true if the song only has Beginner steps.
- sCourse is found.
- sSong is found.
- c.
- s.
- st.
- sGroupName.
- Frames table consisting of iNumFrames frames lasting for a total of fSeconds seconds. This function is not a member function and should be used as Frames = Sprite.LinearFrames( 5, 2.6 ).
- sPath is nil, then unload the texture. Otherwise, load the texture at path sPath.
- sPath.
- sPath.
- song's background.
- song's banner.
- mode.
- texture.
- RageTexture:loop( bLoop ) on the texture.
- RageTexture:position( fPos ) on the texture.
- RageTexture:rate( fRate ) on the texture.
- fWidth and height fHeight clipping if the dimensions do not match.
- iNewState.
- true if everyone failed.
- mp.
- pn.
- true if at least one person passed.
- true if player pn has a high score.
- pn's final grade.
- iAgo rounds ago.
- pn. Use to grab a specific value.
- true if the steps were automatically generated.
- sMetricsGroup.
- pn.
- pSteps.
- iMeter, and Difficulty.
- pTrail.
- Element in Class from metrics.ini.
- ClassName Element in the BGAnimations folder.
- Element in Class for the currently loaded language.
- true if the TimingData contains stops.
- m_sEntryID.
- sCourseName.- Example:
course,"Driven"
- true if the UnlockEntry requires you to pass Hard steps.
- true if the UnlockEntry is locked.
- sModifier.
- sSongName.-
sSongName also requires the group.- Example:
song,"In The Groove/Pandemonium"
- - Example:
steps,"In The Groove/Pandemonium","expert"
- true if there are any unlocks to celebrate.
- sEntryID.
- sEntryID.
- iIndex.
- iIndex.
- iSongIndex.
- color can be in
+ hex ("#FFFFFFFF") or 0..1 values ("1.0,1.0,1.0,1.0"),
+ in RGBA order.
+ sAddress.
+ fPercentDancePoints formatted as a percentage.
+ true if Event Mode is turned on.
+ true if connected to the Internet.
+ true if connected to StepMania Online.
+ true if Player pn is logged on to
+ a SMOnline server.
+ sPath. If sPath points to a Lua file, any additional arguments will be passed to that script.
+ m as a localized string.
+ m as a string.
+ fSecs to Minutes:Seconds.Milliseconds format.
+ P1.
+ sString.
+ fSecs to Minutes:Seconds:Milliseconds format using two digits for each section.
+ fSecs to Minutes:Seconds.Milliseconds format using two digits for each section.
+ fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Milliseconds (uses 3).
+ fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Minutes (usese 1).
+ fSecs to Minutes:Seconds format.
+ path and returns its contents.
+ buf to the file at path.
+ true if sClassName is a registered Class.
+ [1] would be the
+ string 'PlayerNumber_P1'.+ The functions defined in the
Enum namespace are valid member
+ functions of every Enum where the first argument is
+ omitted and the name of the Enum is used in place
+ of Enum. Instead of
+ Enum.GetName(
+ ) or
+ Enum.Reverse(
+ ), one can use
+ :GetName() or
+ :Reverse(), respectively.
+ x and y need to be elements of the enumerated
+ type e. Returns a value less than/greater than/equal to
+ 0 corresponding to the numerical value of x being
+ less than/greater than/equal to the numerical value of y as
+ determined by
+ Enum.Reverse( e ).
+ e. For example,
+ Enum.GetName( )
+ will return the string 'PlayerNumber'.
+ e. For
+ example: local r =
+ Enum.Reverse( );
+ local n = r['PlayerNumber_P2'];+ The value of
n in this case would be 1 corresponding
+ to the 0-based indexing using in C++ and not 2 as might be
+ expected for the 1-based indexing used in Lua.
+ sString to log.txt. Aliased by
+ .
+ sString to info.txt and log.txt as
+ a warning. Aliased by .
+ pn.
+ st) are playable.
+ st) are playable.
+ nil if it doesn't have one.
+ b.
+ fRate * fRate), where fRate is in seconds.
+ xPos to the Actor's current x position.
+ yPos to the Actor's current y position.
+ zPos to the Actor's current z position.
+ h and v are in the range 0..1.
+ true, cull the Actor's back faces. See also: .
+ fAlpha, where fAlpha is in the range 0..1.
+ rot.
+ rot.
+ rot.
+ zoom.
+ zoom.
+ percent of the Actor from the bottom, where percent is in the range 0..1.
+ percent of the Actor from the left, where percent is in the range 0..1.
+ percent of the Actor from the right, where percent is in the range 0..1.
+ percent of the Actor from the top, where percent is in the range 0..1.
+ mode.
+ fRate) * (1-fRate)), where fRate is in seconds.
+ c.
+ fAlpha, where fAlpha is in the range 0..1.
+ c.
+ c, ignoring any alpha value in c.
+ c.
+ c.
+ c.
+ c.
+ c.
+ c.
+ c.
+ iOrder, where larger values display first.
+ s.
+ c.
+ c.
+ fTime.
+ fTime.
+ percent of the Actor from the bottom where percent is in the range 0..1.
+ percent of the Actor from the left where percent is in the range 0..1.
+ percent of the Actor from the right where percent is in the range 0..1.
+ percent of the Actor from the top where percent is in the range 0..1.
+ true if the Actor has a command named sCmdName.
+ fAlign which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See for the common case.
+ align. See for fractional alignment.
+ factor.
+ fRate is in seconds.
+ sName.
+ sCommandName.
+ sCommandName to be played.
+ fAlign.
+ fAlign.
+ fAlign.
+ iNewState.
+ c.
+ fLength.
+ fLength.
+ fLength.
+ fAmount.
+ fAmount.
+ fSeconds before executing the next command.
+ fAlign which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See for the common case.
+ align. See for fractional alignment.
+ xPos.
+ yPos.
+ zPos.
+ zoom scale.
+ zoomX and zoomY.
+ zoom height. See also: .
+ zoom width. See also: .
+ zoom scale on the X axis.
+ zoom scale on the Y axis.
+ zoom scale on the Z axis.
+ x,SCREEN_CENTER_X)
+ y,SCREEN_CENTER_Y)
+ sName.
+ c.
+ c.
+ c.
+ fRate.
+ a.
+ fWidth by fHeight pixels.
+ fNumItems items.
+ fSecs.
+ fSeconds.
+ + A value of
0 means the scroller will not scroll.
+ fItemHeight.
+ fItemWidth.
+ + *
SupportPan - Let the sound pan from side to side.+ *
SupportRateChanging - Let the sound change rate and pitch.
+ sPath.
+ bPause.
+ SupportPan = true on load.
+ attr to the string at position
+ iPos.+ The attribute is a table that must contain
Length
+ which specifies how many (multi-byte) characters the attribute
+ is to apply. If Length=-1, then the attribute applies
+ until another attribute overrides it.+ If the table contains
Diffuse, then the color value
+ is applied to the range of text.+ If the table contains
Diffuses, then it should be
+ an array of 4 colors which specify the diffuse color for the
+ top left, top right, bottom left, and bottom right.+ If the table contains
Glow, then the color value
+ is applied as a glow to the range of text.+ Example:
+
attr = { Length = 10; Diffuse = color("#AABBCC"); }
+ bJitter is true, move each character of the string around by a small random amount.
+ fHeight. If fHeight is 0, then there is no maximum height.
+ fWidth. If fWidth is 0, then there is no maximum width.
+ false.
+ true, set each character of the text in turn to the rainbow colors in the metrics BitmapText::RainbowColor#.
+ sText. This clears all attributes.
+ string.format(sFormat, ...).
+ c.
+ true, make all text uppercase.
+ iSpacing pixels of padding between lines of text.
+ iWidth pixels. If you or by x and you want the text wrapped at width, then you should use wrapwidthpixels(width/x).
+ sID.
+ sMetricsGroup.
+ iIndex from the Course.
+ true if the Course has modifiers.
+ true if the Course has timed modifiers.
+ true if the Course was automatically generated.
+ true if the Course is Endless.
+ true if the Course has a banner.
+ true if the Course is Nonstop.
+ true if the Course is Oni.
+ sPath.
+ s.
+ s.
+ pn,
+ then sets the DifficultyIcon's state from the difficulty of Steps pSteps
+ pn,
+ then sets the DifficultyIcon's state from the difficulty of Trail pTrail
+ pn.
+ game.
+ true if any noteskins exist for the specified Game g.
+ st.
+ fVolume for fDuration seconds.
+ pn.
+ sPath one time.
+ true if any player has performed a feat worthy of ranking.
+ sCommand
+ for pn, if given. See .
+ true if enough credits have been inserted to join.
+ For example,
+
local credits = {GAMESTATE:GetCurrentStepsCredits()};+ will make a table of the difficulties and descriptions. +
nil if
+ it does not exist.
+ nil
+ if it does not exist.
+ true if the gameplay lead in is enabled. If
+ false, gameplay begins immediately.
+ true if the game is Multiplayer.
+ pn.
+ pn.
+ pn.
+ true if a delay is active in the song.
+ true if the song is currently in a freeze.
+ fBeat.
+ true if the workout goal is complete.
+ true if an extra stage was earned.
+ true if this is an extra stage.
+ true if any human player is using a memory card.
+ true if playing in Battle mode.
+ true if playing in a Course mode.
+ true if in Demonstration mode.
+ true if the match was a draw.
+ true if Event Mode is on, temporary or otherwise.
+ true if this is the first extra stage.
+ true if this is the second extra stage.
+ true if player pn has completed the current Goal.
+ true if player pn is human.
+ true if player pn is enabled.
+ true if player pn has joined the game.
+ true if player pn is the winner.
+ pn.
+ true if player pn is using modifier sModifier.
+ true if players can join the game.
+ course.
+ song.
+ pn's current Steps to steps.
+ trail.
+ iFields
+ pn to Difficulty dc.
+ song.
+ sGroup.
+ so using ModsLevel m.
+ bOn.
+ bOn.
+ pn.
+ sMetricsGroup.
+ g.
+ sMetricsGroup.
+ pn to empty.
+ pn from RadarValues rv
+ fSeconds.
+ tips (and optionally altTips).
+ sTips using colons to separate new sections.
+ hns.
+ tns.
+ true if failing.
+ true if the LifeMeter is "hot".
+ true if in danger.
+ pn.
+ fSeconds.
+ bSilent.
+ bStealth. If
+ true, the timer will be invisible and silent.
+ sMessage. The
+ second argument is an optional table of parameters. It may be omitted or explicitly
+ set to nil.
+ sAniName at fPlayRate speed (default 1.0).
+ fRate.
+ sAnimation at fPlayRate speed (default 1.0).
+ pn from the Metrics in group sMetricsGroup.
+ sButton sElement.
+ sButton sElement.
+ true if the strName noteskin exists in the current gametype.
+ pn.
+ true if a full combo (TNS_W3 and up) was obtained.
+ true if a full combo (tns and up) was obtained.
+ true if the player was disqualified from ranking.
+ sPlayerOptions for the specified ModsLevel.
+ sPreference.
+ sPreference to value.
+ sPreference to the default value.
+ Course c, Trail t)
+ s has been played with the profile.
+ st.
+ g on.
+ g on.
+ true if the player has passed any steps in the specified Song s.
+ true if the specified code sUnlockEntryID is unlocked.
+ iCals calories.
+ iSecs seconds.
+ gt.
+ weightPounds.
+ pn.
+ ProfileSlot.
+ true if player pn's profile is persistent.
+ true if Song s has never been played before (according to the machine profile).
+ rc from .
+ true if the current position within the file is the end. (EOF = End of File)
+ sPath (relative to the StepMania root directory).+
iAccessType can be set to read (1), write (2), stream (4) or flush to disk on close (8).+ These can also be combined with addition. For example, to set up read and write, set
iAccessType to 3 (1+2).
+ str.
+ true if a file exists at sPath.
+ sPath. The last two arguments are optional (and default to false).
+ sPath.
+ sProperty to fVal. The supported properties depend on how the associated was loaded.
+ fPitch. The associated have SupportsRateChanging = true on load.
+ fSpeed. The associated must have SupportsRateChanging = true on load.
+ fVolume, which is between 0..1.
+ {left, top, right, bottom}.
+ bLoop.
+ fPos.
+ fRate.
+ f.
+ f seconds.
+ sScreenMsg to the Screen.
+ true if a single has its NoteField centered.
+ pn.
+ true if the game is paused.
+ bPause.
+ true if screen class s exists.
+ true if screen s is prepared.
+ s.
+ true if Player pn backspaced successfully.
+ true if Player pn was able to add sKey to their name.
+ pn and returns true
+ if successful.
+ true if anyone is entering their name.
+ true if anyone is still entering their name.+ (As opposed to those who are Finalized; see ) +
true if Player pn is entering their name.
+ true if Player pn is finished entering their name.
+ pn.
+ true if all active players are on the last options row.
+ pn is on.
+ true if we are going to PlayerOptions.
+ true if there is a profile that can be loaded.
+ true if there is a profile that can be saved.
+ true
+ if successful.
+ pn to iProfileIndex.
+ fElapsedTime.
+ fBeat.
+ fBeat.
+ st.
+ true if the song has steps for the specified difficulty in st.
+ true if the song has a background.
+ true if the song has a banner.
+ true if the song has BGChanges.
+ true if the song has a CDTitle.
+ true if the song has edits.
+ true if the song has lyrics.
+ true if the song has music.
+ true if the song has significant elephants or bison.
+ true if the song has .
+ true if the song is considered easy.
+ true if the song is enabled.
+ true if the song meets the criteria for a "Long Version".
+ true if the song meets the criteria for "Marathon" length.
+ true if the song only has Beginner steps.
+ sCourse is found.
+ sSong is found.
+ c.
+ s.
+ st.
+ sGroupName.
+ Frames table consisting of iNumFrames frames lasting for a total of fSeconds seconds. This function is not a member function and should be used as Frames = Sprite.LinearFrames( 5, 2.6 ).
+ sPath is nil, then unload the texture. Otherwise, load the texture at path sPath.
+ sPath.
+ sPath.
+ song's background.
+ song's banner.
+ mode.
+ texture.
+ RageTexture:loop( bLoop ) on the texture.
+ RageTexture:position( fPos ) on the texture.
+ RageTexture:rate( fRate ) on the texture.
+ fWidth and height fHeight clipping if the dimensions do not match.
+ iNewState.
+ fWidthxfHeight.
+ true if everyone failed.
+ mp.
+ pn.
+ true if at least one person passed.
+ true if player pn has a high score.
+ pn's final grade.
+ iAgo rounds ago.
+ pn. Use to grab a specific value.
+ true if the Steps are an edit.
+ true if the Steps are a player edit (loaded from a profile).
+ true if the steps were automatically generated.
+ sMetricsGroup.
+ pn.
+ pSteps.
+ iMeter, and Difficulty.
+ pTrail.
+ Element in Class from metrics.ini.
+ ClassName Element in the BGAnimations folder.
+ Element in Class for the currently loaded language.
+ beat=BPM".
+ beat=stop seconds".
+ true if the TimingData contains BPM changes.
+ true if the TimingData contains stops.
+ m_sEntryID.
+ sCourseName.+ Example:
course,"Driven"
+ true if the UnlockEntry requires you to pass Hard steps.
+ true if the UnlockEntry is locked.
+ sModifier.
+ sSongName.+
sSongName also requires the group.+ Example:
song,"In The Groove/Pandemonium"
+ + Example:
steps,"In The Groove/Pandemonium","expert"
+ true if there are any unlocks to celebrate.
+ sEntryID.
+ sEntryID.
+ iIndex.
+ iIndex.
+ true if the wheel is locked.
+ true if the wheel is settled/stopped moving.
+ n.
+ iSongIndex.
+ BMS +Format Specification
+ +written by Urao Yane(yaneurao@sun-inet.or.jp)
+ +"BMS" means a Be-Music Source file. A file which has +BMS suffix is regarded as the BMS file. This file format was +produced by Urao Yane and NBK in 1998. And I adopted this file +format to BM98. Now,anyone can use this format freely.
+ +-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+ +<Command Line>
+ +The line begining at '#' is the command line. All the rest are +ignored (use for comments). And this BMS file is compiled at +runtime , so you can order any lines freely. And there is no +difference in the command line between using a capital letter or +not.
+ +-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+ +<Header>
+ +#PLAYER 1
+This data is for Single Play.
#PLAYER 2
+This data is for Two Play.
#PLAYER 3
+This data is for Double Play.
#GENRE xxxxxxxx
+Definition of Genre.
#TITLE xxxxxxxx
+Definition of Title.
#ARTIST xxxxxxxx
+Definition of Artist.
#BPM xxx
+Definition of BPM.(Beat Per Minite) at the top of music. default
+: 130
#MIDIFILE xxxxxxx.mid
+Background music by MIDI.
#PLAYLEVEL x
+Information of Game Level for player.
#RANK x
+judgement level.
+x = 0 :very hard, 1: hard, 2: normal, 3: easy
@
+ +#VOLWAV xxx
+relative volume control (percentage)
#WAVxx yyyyyyyy.wav
+definition of Wave Data. xx : 01 to FF (Hex) , yyyyyyyy.wav :
+wave file name
e.g.
+#WAV01 HOUSE01.WAV // assign HOUSE01.WAV to 01 wav
+#WAV02 HOUSE02.WAV // assign HOUSE02.WAV to 02 wav
+#WAVFF HOUSE03.WAV // assign HOUSE03.WAV to FF wav
#BMPxx yyyyyyyy.bmp
+definition of Bitmap file. xx : 01 to FF(Hex) , yyyyyyyy.bmp :
+bitmap file name
+Bitmap size must be 256 * 256.(max color 65536)
e.g.
+#BMP01 HOUSE01.BMP // assign HOUSE01.BMP to 01 bitmap
+#BMP02 HOUSE02.BMP // assign HOUSE02.BMP to 02 bitmap
+#BMPEE HOUSE03.BMP // assign HOUSE03.BMP to EE bitmap
+
But ,the bitmap defined by #BMP00 is something special.
+This bitmap shows when a player do a poor play.
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+ +// a sample of random loading function
+ +#random 2 // create a random number (1 or 2)
+ +#if 1 // if the number was equal to 1 then...
+#00111:31313131 // this is effective...
+#endif
#if 2 // if the number was equal to 2 then...
+#00113:32003232 // this is effective
+#endif
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+ +<Channel Messages>
+ +#aaabb:cccccccc
+ +aaa: track number (from 000 to 999)
+bb : channel number where you want to send message.(from 00 to
+FF)
+cccccccc : <message>
<a brief Channel Number>
+ +01 : BGM(background music by WAVE)
+03 : changing a Tempo
+04 : BGA(background animation)
+06 : changing Poor-bitmap
+11 to 17 : Object Channel of 1 player side
+21 to 27 : Object Channel of 2 player side
+
<Example>
+ +#00211:03030303
+This means 4 objects at the left of 1 player side in 002 track.
+This object is assigned to wave No.03 which was defined by #WAV03
+xxxx.wav. And this 4 objects are arranged evenly
+in this track.
Please try the following patterns.
+ +#00211:0303030303
+ +#00211:0303000303
+ +#00211:010101
+#00211:00020202
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+ +This document and this format is free!
+I hope the day will come when my BMS format will use all over the
+world.
Urao Yane
+ + + + diff --git a/Docs/SimfileFormats/BMS/BM98FinalSecret.html b/Docs/SimfileFormats/BMS/BM98FinalSecret.html new file mode 100644 index 0000000000..4a7e02c83b --- /dev/null +++ b/Docs/SimfileFormats/BMS/BM98FinalSecret.html @@ -0,0 +1,564 @@ + + + + + +alXWer
+ +alXWŌ̔閧Ƃ́Ad +b@\AȂ킿AQ[̃LN^[ׂĂalrt@CŕύX@\łB
+ +A̋@\́Ag[̂̂ɂȂ莟AJ悤ƎvĂ̂A낢뎖āAalXŴ̂̊J邱ƂɂȂA̖ڂ邱Ƃ̂ȂȂ@\łB
+ +ŁA̋@\gȂ́Aalq̕ł͕̓ۏłȂB܂BM98ver3.18pƂĔFĂB܂Aȍ~̃o[WŁAɂ̂́Arbg}bvt@CĂ̂ŁÃeLXg̓ěł͂ȂB
+ +܂A{IɂalXWɂāA˂炨͈T|[gȂƌĂ̓lA̓eɂĂAT|[gȂ̂ŁA[͊قĂقB
+ +ꂩAXvCgio[AalXWŗL̒萔oĂ邪ÁAalqƂ͈ؖłB
+ +@
+ +@
+ +܂A̋@\̂ƂwvłGĂ̂ŁAB
+ +--------------------------------------------------
+ +Extended Character (BM98 v3.18ȍ~)@J@\
+ +ȉ́A˂炨̃Ƃlij
+ +EQ[̔Cӂ̃XvCg[U[`@\B
+ +#ExtChr <SpriteNo.> <BMPNo.>
+ +<start_x> <start_y> <end_x> <end_y>
+ +{ <offset_x> <offset_y> { <x> <y> } }
+ +ʗAExtended Object@\ƂpĎgB
+ +XvCgNo.ƃLN^No.Ƃ͈ӖႤB--------------------------------------------------
+ +܂AExtended Object@\ƕpĎgƏĂ邪ÁAǂɂ邩ƂƁA`lio[05Ԃ̂Ƃɂ菑ĂB
+ +--------------------------------------------------
+ +05@@ [Extended Object]@J@\
+ +@@ĂIuWFʂ̃LN^[io[̂̂ɂւ@\B̍s̉ɂs̃IuWFɏԂɊUB
+ +--------------------------------------------------
+ +̃`lio[̎̍sɏĂIuWFzuf[^ɑāALł邱Ƃ͂킩邪ALN^[ƂĉǂΗǂ̂Aꂪ܂ĕsmłB
+ +ƁA˂炨悭͊oĂȂij
+ +ȂÂƂ́A{̋Ȃ`[tɁAȂɕҋȂsȂĂāÂƂPIN^[ũsAmՂoĂalrt@CŁAȋ@\o͂B
+ +Ȃ킯ŁAƃ\[XeLXg`Ă݂悤B
+ +int ExtChr[] = {
+0,961,962,963,964,965,966,967,968,969,970,971,972,973,974,975,
+// 0x [U[`\
+976,977,978,979,980,981,982,983,984,985,986,987,988,989,990,991,
+// 1x@ [U[`\
+992,993,994,995,996,997,998,999,1000,1001,1002,1003,1004,1005,1006,1007,
+// 2x [U[`\
+1008,1009,1010,1011,1012,1013,1014,1015,1016,1017,1018,1019,1020,1021,1022,1023,
+// 3x
+0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+// 4x
+0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+// 5x
+941,942,943,944,945,946,947,948,949,950,951, 0, 0, 0, 0, 0,
+// 6x FIuWF5p^[ ԁ@@D@BM98FiVIuWFj
+730,731,732,733,734,735,736,737,738,739,740,741,742,743,744,745,
+// 7x A B C D E F G H I J K L M N O P
+746,747,748,749,750,751,752,753,754,755,760,761,762,763,764,765,
+// 8x Q R S T U V W X Y Z a b c d e f
+766,767,768,769,770,771,772,773,774,775,776,777,778,779,780,781,
+// 9x g h i j k l m n o p q r s t u v
+782,783,784,785,790,791,792,793,794,795, 0, 0, 0, 0, 0, 0,
+// ax w x y z - " ! ? & .
+800,801,805,806,807,808,810,811,812,910,911,912,913,940, 0, 0,
+// bx BM ںSong SP DP BPM @ 1P 2P 1Pd
+2Pd c
+850,851,852,853,854,855,856,857,858,859,860,861,862,863,864,865,
+// cx A B C D E F G H I J K L M N O P
+866,867,868,869,870,871,872,873,874,875,876,877,878,879,890,891,
+// dx Q R S T U V W X Y Z / . ! % @ ?
+720,721,722,723,724,725,726,727,728,729, 0, 0, 0, 0, 0, 0,
+// ex 0 1 2 3 4 5 6 7 8 9
+880,881,882,883,884,885,886,887,888,889, 0, 0, 0, 0, 0, 0
+// fx 0 1 2 3 4 5 6 7 8 9
+};
+
[ƂŁAOT`lɃf[^𑗐M邱ƂŁAOP`ee܂ŁAQTTނ̃LN^\邪ł킯AꂪԂ̃XvCgɑΉ̂ł邩́A̕\ΈڗđRBiA˂炨ɂ̂݁Fj
+ +ƂALN^io[OṔAXvCgio[XUPłBi[U[`\j
+܂ALN^[io[TÓAXvCgio[XSPłA͋FIuWFłB
+͂܂ALN^[io[cQ́AXvCgio[WUVłÁAqƂłB
Ƃ悤ɂȂĂBƂƂŁÁAT`lŁAgLN^ƂāAȂǂIuWFƂė邱ƂłB
+ +ɁAŁAƂȂ̂́AXvCgio[961`1023[U[`\ƂĉĂ邱ƂłBɗāAقǂ
+ +#ExtChr <SpriteNo.> <BMPNo.> <start_x> +<start_y> <end_x> <end_y>@{ <offset_x> +<offset_y> { <x> <y> } }
+ +߂ĈӖB{ +}̕͏ȗ\ƂƁB
+ +#ExtChr 961 1 0 0 99 99
+ +ȂǂƂAXvCgio[XUPArbg}bvio[PíA#bmpŒ`Ƃ̃rbg}bvio[j́iOCOjiXXCXXĵPOO~POOhbg̕ƂĒ`ƂӖłBɂA[U[ŗpӂCӂ̃rbg}bv̓̕[U[XvCgƂĒ`邱Ƃ\ƂȂAقǂExtended +Objectŕ\邱Ƃ\Ƃ킯BiƂvoFj
+ +āA<offset_x> <offset_y>IvVŎwł邪ÁAIuWFʒu邽߂ɂB
+ +ƂAIuWF\ƂAIuWF\iKŎQƂāÃIuWF̉ʂɃvC|Cg悤ɂ̂́A܂ꂽvOł͂ȂƂ˂炨͍l킯B̂AۂՂ̈ڐÂƂɂ̂ŁAIuWFNg̉ʂvC|CgłȂƂ肤邱Ƃ𑽏ӎĂ̂B
+ +ŁAItZbg邱ƂɂBƂAi|TC|POj̃ItZbgXvCgɑẮAiPOOCPQOj̍Wɕ\ȂAƖ߂ĂiXTCPPOj̍Wɕ\킯łB̂悤ɂ邱ƂɂāAIɂ́AiPOOCPQOj̍WŊǗłBȂ킿AvC|Cgɕ\悤ɎwĂÃXvCg\̒iKŁAKȃItZbgāAKȈʒuɕ\Ƃdg݂łB
+ +ÂƂɋCÂ̂́ARDPUȂ̂ŁAXNb`͎̓ItZbgĂȂBiƎvj@̒sȂ߂ɂÃItZbgl͏dvłB
+ +Ō̃IvV̂wCxA̎w肪ƁAʏ́A̍Wʒuɂ̃XvCgzûłBՂ̃fUCύXADanceDanceRevolution̂悤ɂƑ傫Ȗpӂ肷邱Ƃ̉\B܂Aܒ`ĂXvCgォ`āAʊOɒǂoA\Ȃ悤ɂ邱ƂłB
+ +@
+ +킭킭ĂƂŁAǂ̃XvCgio[ł̂ÅtSɒm肽Ǝvl邾낤BłȂA܂錮Ղʂ̃LN^ɍĒ`Ă܂Ƃ悤ȂƂłȂłB
+ +ŁAȉɂ́AXvCg`̂߂̃[`̂܂ܔB̂悤ɂāAԂł邩LĂBAdynamicƏĂ镔́AIɕύX邩AςĂʂłB܂AXvCǵAIɂO`TPP܂ł\̂ŁAƂTPQ`POQŔA\łāAsiKŁAPOԂ̃XvCg͂TPRԂ̃XvCgRs[IȂǂƂāAPOԂɃXvCgĂāAPOԂ̃XvCgʕ\邱ƂɂATPRԂ̃XvCgʕ\邱ƂɂĂB̂悤ɂ邱ƂɂAނ̃XvCg\肷邱ƂȒPɂȂ邵AǗ̎ԂyɂȂB
+ +A₵āATPQł͑ȂȂ߁AlI\pɂPOQS`POWVgĂ悤ȋCBiȂ_TCȂDDDj
+ +܂Âւ͓ˊэHȂ̂Ő[͂܂Ȃ悤Ɂij
+ +@
+ +void DefSpriteGames(void) //
+Q[ʂ̂߂̃XvCg
+{
+int i;
+for(i=0;i<512*2+64;i++) {
+ySpriteMove(i,-10000,-10000); // SNA
+ySpriteVisible(i,true);
+}
+
+// 00 - 11 : (dynamic sprite) Great̔Ajp
+// 12-75 : Score\p (61-76 : AutoPlay\p)
+// 71-75 : (dup.) CPU % ח\p
+
+// 77-79 : ̂͂DD
+
+// 80,81,82,83,84,85,86,87,88 : 1P̌ՃtbVXNb`
+// 89,90,91,92,93,94,95,96,97 : 2P̌ՃtbVXNb`
+
+// kazu:ĂL[{[ȟʃp[cB
+yDefSprite(80,112,1,123,25); // Pi㕔j
+ySpriteMove(80,SCR1P1+1,SCRDWN3-1);
+yDefSprite(81,112,26,133,46); // Pij
+ySpriteMove(81,SCR1P1+1,SCRDWN3+25-1);
+
+yDefSprite(82,124,1,140,25); // Q
+ySpriteMove(82,SCR1P2+2,SCRDWN3);
+
+yDefSprite(83,141,1,146,25); // Ri㕔j
+ySpriteMove(83,SCR1P3+8,SCRDWN3-1);
+yDefSprite(84,133,26,154,46); // Rij
+ySpriteMove(84,SCR1P3+1,SCRDWN3+25-1);
+
+yDefSprite(85,147,1,163-1,25); // S
+ySpriteMove(85,SCR1P4+4,SCRDWN3);
+
+yDefSprite(86,164-2,1,175,25); // Ti㕔j
+ySpriteMove(86,SCR1P5+9,SCRDWN3-1);
+yDefSprite(87,154,26,175,46); // Tij
+ySpriteMove(87,SCR1P5+1,SCRDWN3+25-1);
+
+yDefSprite(88,177,2,210,46); // XNb`
+ySpriteMove(88,SCR1P6+2,SCRDWN3);
+
+for(i=80;i<=88;i++){
+ySpriteCopy(i+9,i); // ȁ[:p
+ySpriteAdd(i+9,SCROFS,0); // XvCgΈړ
+}
+
+// 98,99 : ʉ̃L[{[hiԃCj
+yDefSprite(98,1,1+5,100,89); // for 1P
+m[}L[{[hiŚBXNb`܂ށj
+ySpriteCopy(99,98); // for 2P
+
+// 100-309 : (dynamic sprite) m[gBPʓ200Ƃ͂痈
+
+// 310,311 : 1P & 2P "Great / Good / Bad / Poor "
+// NoteSprite.h
+ŎgAAg_B
+
+// 312-315 : "1P","2P"
+
+// 316 - 325 : cߐ (̕D悩...)
+for(i=0;i<10;i++){
+yDefSprite(316+i,64,91,64,91+(SCRDWN>>1)-1);
+}
+ySpriteMove(316,SCR1P3,0); // ړƂႦI
+ySpriteMove(317,SCR1P5,0); // ړƂႦI
+ySpriteMove(318,SCR1P6,0); // ړƂႦI
+ySpriteMove(319,SCR1P3,SCRDWN>>1); //
+ړƂႦI
+ySpriteMove(320,SCR1P5,SCRDWN>>1); //
+ړƂႦI
+ySpriteMove(321,SCR1P6,SCRDWN>>1); //
+ړƂႦI
+
+// 322-7 : 2Ppcߐ
+
+// 328-330 : CPUח
+
+// 331-430 : (dynamic sprite) Voltage Meter
+
+// 431,432,433,434,435,436 : 1P
+L[@Ƃ̐Ԃ̏cC
+// 437,438,439,440,441,442 : 2P
+L[@Ƃ̐Ԃ̏cC
+for(i=431;i<=442;i++){
+if (i==436 || i==442) {
+yDefSprite(i,65,91,99,91+160-1); // XNb`C
+} else {
+yDefSprite(i,65,91,84,91+160-1); //
+}
+ySpriteVisible(i,false); //
+fBtHgł͕sH
+}
+ySpriteMove(431,SCR1P1+1,0);
+ySpriteMove(432,SCR1P2+1,0);
+ySpriteMove(433,SCR1P3+1,0);
+ySpriteMove(434,SCR1P4+1,0);
+ySpriteMove(435,SCR1P5+1,0);
+ySpriteMove(436,SCR1P6+1,0);
+for(i=0;i<6;i++){
+ySpriteCopy(437+i,431+i);
+ySpriteAdd(437+i,SCROFS,0);
+}
+
+for(i=0;i<12;i++){
+ySpriteCopy(443+i,431+i);
+ySpriteAdd(443+i,0,SCRDWN>>1);
+}
+
+// 455-497 : for displaying debug message(dup.)
+// (455-486) : ʃt[(`́ABGScr.cpp)
+// (487-497) : INSERT COIN & CREDITS 0/2
+
+// 498-499 : Po^Qỏ̐ԃC
+yDefSprite(498,1,1,100,5); // for 1P
+m[}L[{[hiŚBXNb`܂ށj
+// defined BGScr.cpp
+
+// 500-506 : FPS̕\p
+
+// 507 BM
+yDefSprite(507,340,345,426,374); //
+alXW^CgSE
+
+// 508-511
+yDefSprite(508,174,48,176,52); // EOp}[N
+yDefSprite(509,178,48,180,52); // Op}[N
+ySpriteCopy(510,509);
+ySpriteCopy(511,510);
+
+/*
+(117,1,121,73) // ߍTCh̐
+(239,1,247,73) // ߉ETCh̐
+*/
+
+// 513-1023 : free@ZRCƂ킸ɍɎgI
+for(i=0;i<4;i++){
+yDefSprite(513+i,112,48+i*6,131,52+i*6); // IuWF
+yDefSprite(523+i,133,48+i*6,152,52+i*6); // IuWF
+yDefSprite(533+i,147,147+i*6,180,151+i*6); // XNb`
+}
+yDefSprite(513+4,208,48,230,53); //
+IuWF̂т[
+ySpriteOffset(513+4,-1,-1); // Z^OI
+yDefSprite(513+5,207,48,231,54); //
+IuWF̂т[
+ySpriteOffset(513+5,-2,-2);
+
+yDefSprite(523+4,208,56,230,61); //
+IuWF̂т[
+ySpriteOffset(523+4,-1,-1);
+yDefSprite(523+5,207,56,231,62); //
+IuWF̂т[
+ySpriteOffset(523+5,-2,-2);
+
+yDefSprite(533+4,147,171,180,179); //
+XNb`̂т[(1)
+yDefSprite(533+5,147,181,180,190); //
+XNb`̂т[(2)
+
+// t[][iPj
+yDefSprite(543,112,102,145,145-4);
+yDefSprite(544,147,102,180,145-4);
+yDefSprite(545,182,102,215,145-4);
+yDefSprite(546,112,147,145,190-4);
+yDefSprite(547,182,147,219,190); // т[ BM98v3.16
+// ySpriteOffset(547,-2,0);
+yDefSprite(548,182,147,219,190); // т[ BM98v3.16
+// ySpriteOffset(548,-2,0);
+
+yDefSprite(553,245,108,307,121); // GREAT
+yDefSprite(554,245,123,307,136); // GOOD
+yDefSprite(555,245,138,307,151); // BAD
+yDefSprite(556,245,153,307,166); // POOR
+
+yDefSprite(557,1,267,100,267); // ߐ
+// ySetSpriteSize(557,120,1);
+
+// ԕ
+for(i=0;i<=9;i++){
+yDefSprite(560+i,245+i*12,168,255+i*12,183); // 0-9
+}
+
+yDefSprite(581,154,48,157,64); // Q[WEiÁj
+yDefSprite(582,159,48,162,64); // Q[WEij
+yDefSprite(583,164,48,167,64); // Q[WEԁiÁj
+yDefSprite(584,169,48,172,64); // Q[WEԁij
+
+for(i=0;i<4;i++){
+yDefSprite(700+i,112+i*30,72,140+i*30,100); // GREATAj
+}
+
+// 0-9 , A-Z , a-z ...
+// F̕
+yDefSprite(720,245,89,257,106); // 0
+yDefSprite(721,259,89,265,106); // 1
+yDefSprite(722,267,89,279,106); // 2
+yDefSprite(723,281,89,293,106); // 3
+yDefSprite(724,295,89,309,106); // 4
+yDefSprite(725,311,89,323,106); // 5
+yDefSprite(726,325,89,337,106); // 6
+yDefSprite(727,339,89,351,106); // 7
+yDefSprite(728,353,89,365,106); // 8
+yDefSprite(729,367,89,379,106); // 9
+
+yDefSprite(730,245,1,257,18); // A
+yDefSprite(731,259,1,271,18); // B
+yDefSprite(732,273,1,285,18); // C
+yDefSprite(733,287,1,299,18); // D
+yDefSprite(734,301,1,311,18); // E
+yDefSprite(735,313,1,323,18); // F
+yDefSprite(736,325,1,337,18); // G
+yDefSprite(737,339,1,351,18); // H
+yDefSprite(738,353,1,357,18); // I
+yDefSprite(739,359,1,371,18); // J
+yDefSprite(740,373,1,387,18); // K
+yDefSprite(741,389,1,399,18); // L
+yDefSprite(742,401,1,421,18); // M
+yDefSprite(743,245,20,259,37); // N
+yDefSprite(744,261,20,273,37); // O
+yDefSprite(745,275,20,287,37); // P
+yDefSprite(746,289,20,301,39); // Q
+yDefSprite(747,303,20,315,37); // R
+yDefSprite(748,317,20,327,37); // S
+yDefSprite(749,329,20,341,37); // T
+yDefSprite(750,343,20,355,37); // U
+yDefSprite(751,357,20,369,37); // V
+yDefSprite(752,371,20,391,37); // W
+yDefSprite(753,393,20,405,37); // X
+yDefSprite(754,407,20,419,37); // Y
+yDefSprite(755,245,41,257,58); // Z
+
+yDefSprite(760,259,41,271,58); // a
+yDefSprite(761,273,41,285,58); // b
+yDefSprite(762,287,41,297,58); // c
+yDefSprite(763,299,41,311,58); // d
+yDefSprite(764,313,41,325,58); // e
+yDefSprite(765,327,41,337,58); // f
+yDefSprite(766,339,41,351,62); // g
+yDefSprite(767,353,41,365,58); // h
+yDefSprite(768,367,41,371,58); // i
+yDefSprite(769,373,41,383,62); // j
+yDefSprite(770,385,41,398,58); // k
+yDefSprite(771,400,41,404,58); // l
+yDefSprite(772,406,41,426,58); // m
+yDefSprite(773,245,64,257,81); // n
+yDefSprite(774,259,64,271,81); // o
+yDefSprite(775,273,64,285,85); // p
+yDefSprite(776,287,64,299,85); // q
+yDefSprite(777,301,64,311,81); // r
+yDefSprite(778,313,64,323,81); // s
+yDefSprite(779,325,64,333,81); // t
+yDefSprite(780,335,64,347,81); // u
+yDefSprite(781,349,64,361,81); // v
+yDefSprite(782,363,64,383,81); // w
+yDefSprite(783,385,64,397,81); // x
+yDefSprite(784,399,64,411,87); // y
+yDefSprite(785,413,64,425,81); // z
+
+yDefSprite(790,381,89,391,106); // -
+yDefSprite(791,393,89,399,106); // "
+yDefSprite(792,401,89,405,106); // !
+yDefSprite(793,407,89,419,106); // ?
+yDefSprite(794,309,108,325,125); // &
+yDefSprite(795,327,108,331,125); // .
+
+yDefSprite(800,201,229,426,314); //
+alXW^CgSE
+yDefSprite(801,1,269,181,385); // R[h
+
+yDefSprite(805,183,316,426,343); // uSONG SELECTv^Cg
+yDefSprite(806,183,345,338,364); // for Single Play
+yDefSprite(807,183,366,338,385); // for Double Play
+yDefSprite(808,309,127,385,156); // Auto BMP counter!
+
+yDefSprite(810,112,192,164,244); // qg
+yDefSprite(811,166+23,192+9,192+23,218+9); //
+ighԂj
+yDefSprite(812,194+23,192+9,220+23,218+9); //
+igj
+
+yDefSprite(820,182,48,185,51); //
+Ug\pEԂlp
+yDefSprite(821,187,48,190,51); //
+Ug\pEΐFlp
+yDefSprite(822,182,102,186,105); //
+Ug\pE{[_
+// XNb`IuWFؗp:p
+
+yDefSprite(830,102,1,105,89); // pE
+yDefSprite(831,107,1,110,89); // EpE
+yDefSprite(832,102,91,105,266); // pE(1)
+yDefSprite(833,107,91,110,266); // EpE(1)
+// yDefSprite(834,245,203,420,206); // 㑤pE
+// yDefSprite(835,245,208,420,211); // pE
+yDefSprite(834,245,203,245+120-1,206); // 㑤pE
+yDefSprite(835,245,208,245+120-1,211); // pE
+yDefSprite(836,387,135,402,150); // R[i[
+yDefSprite(837,387,152,402,167); // ER[i[
+yDefSprite(838,387,169,402,184); // R[i[
+yDefSprite(839,387,186,402,201); // ER[i[
+yDefSprite(840,102,91,105,91+140-1); // pE(2)
+yDefSprite(841,107,91,110,91+140-1); // EpE(2)
+
+yDefSprite(842,102,91,105,266-10); // pE(3) for
+result
+yDefSprite(843,107,91,110,266-10); // EpE(3)
+
+// At@xbg
+yDefSprite(850,1,91,9,108); // A
+yDefSprite(851,11,91,19,108); // B
+yDefSprite(852,21,91,29,108); // C
+yDefSprite(853,31,91,39,108); // D
+yDefSprite(854,41,91,48,108); // E
+yDefSprite(855,1,110,9,127); // F
+yDefSprite(856,11,110,19,127); // G
+yDefSprite(857,21,110,29,127); // H
+yDefSprite(858,31,110,33,127); // I
+yDefSprite(859,35,110,43,127); // J
+yDefSprite(860,45,110,53,127); // K
+yDefSprite(861,1,129,9,146); // L
+yDefSprite(862,11,129,21,146); // M
+yDefSprite(863,23,129,31,146); // N
+yDefSprite(864,33,129,41,146); // O
+yDefSprite(865,43,129,51,146); // P
+yDefSprite(866,1,148,9,165); // Q
+yDefSprite(867,11,148,19,165); // R
+yDefSprite(868,21,148,29,165); // S
+yDefSprite(869,31,148,39,165); // T
+yDefSprite(870,41,148,49,165); // U
+yDefSprite(871,1,167,9,184); // V
+yDefSprite(872,11,167,21,184); // W
+yDefSprite(873,23,167,31,184); // X
+yDefSprite(874,33,167,41,184); // Y
+yDefSprite(875,43,167,51,184); // Z
+yDefSprite(876,1,186,9,203); // "/"
+yDefSprite(877,11,186,13,203); // "."
+yDefSprite(878,15,186,17,203); // "!"
+yDefSprite(879,19,186,27,203); // "%"
+yDefSprite(880,1,205,8,222); // 0
+yDefSprite(881,10,205,14,222); // 1
+yDefSprite(882,16,205,23,222); // 2
+yDefSprite(883,25,205,32,222); // 3
+yDefSprite(884,34,205,41,222); // 4
+yDefSprite(885,43,205,50,222); // 5
+yDefSprite(886,1,224,8,241); // 6
+yDefSprite(887,10,224,17,241); // 7
+yDefSprite(888,19,224,26,241); // 8
+yDefSprite(889,28,224,35,241); // 9
+
+// added by BM98v3.16
+yDefSprite(890,53,167,061,184); // @
+yDefSprite(891,29,186,37,203); // ?
+yDefSprite(892,39,186,41,203); // :
+yDefSprite(893,43,186,45,203); // ;
+yDefSprite(894,47,186,51,203); // [
+yDefSprite(895,53,186,57,203); // ]
+yDefSprite(896,52,205,60,222); // ^
+yDefSprite(897,37,224,40,241); // (
+yDefSprite(898,42,224,45,241); // )
+yDefSprite(899,47,224,51,241); // "
+yDefSprite(900,53,224,54,241); // '
+yDefSprite(901,56,224,57,241); // |
+yDefSprite(902,59,224,61,243); // ,
+yDefSprite(903,1 ,243, 9,260); // _
+yDefSprite(904,11,243,19,260); // ~
+yDefSprite(905,21,243,28,260); // =
+yDefSprite(906,30,243,37,260); // -
+yDefSprite(907,39,243,47,260); // +
+yDefSprite(908,49,243,56,260); // *
+
+yDefSprite(910,245,185,270,201); // 1P
+yDefSprite(911,272,185,297,201); // 2P
+yDefSprite(912,299,185,324,201); // Â\́uPov
+yDefSprite(913,326,185,351,201); // Â\́uQov
+
+// lIn B:Blue R:Red D:Dark T:Top C:Center B:Bottom
+for(i=0;i<9;i++){
+yDefSprite(920+i,428,1+i*41,458,40+i*41);
+// RT,RC,RB,BT,BC,BB,DT,DC,DB
+}
+
+// ԕ̏́iaolpj
+yDefSprite(930,317,213,323,227); // 0
+for(i=931;i<=939;i++){
+yDefSprite(i,245+(i-931)*8,213,251+(i-931)*8,227);
+}
+
+yDefSprite(940,112,246,157,267); // sakata
+
+for(i=0;i<3;i++){
+yDefSprite(941+i,175,54+i*6,194,58+i*6); // FIuWF
+}
+yDefSprite(944,154,66,173,70);
+yDefSprite(945,207,64,231,70);
+
+for(i=0;i<6;i++){
+yDefSprite(946+i,166,192+i*6,185,196+i*6);
+// 946 ԁE947 E948 DE949 E950 bm98E 951F
+}
+
+}
@
+ +{IɁAalqłAExtended Object/Chracter̋@\͎ł͂邪AƐꂽ̂ɂ\łB
+ +ȂAɂ@\gƁAȃf[^ƂāAalXWȃf[^tH[}bgɏ̂ł͂ȂȂ邽߁ÂalXWp̃rA[Ō邱ƂłȂȂ邱ƂA炩߂f肵ĂB
+ +ȏB
+ +@
+ + + + diff --git a/Docs/SimfileFormats/BMS/BMS_Reading_Tutorial.rtf b/Docs/SimfileFormats/BMS/BMS_Reading_Tutorial.rtf new file mode 100644 index 0000000000..f4948c2825 --- /dev/null +++ b/Docs/SimfileFormats/BMS/BMS_Reading_Tutorial.rtf @@ -0,0 +1,326 @@ +{\rtf1\ansi\ansicpg1252\deff0\deflang1033{\fonttbl{\f0\fmodern\fprq1\fcharset0 Lucida Console;}} +{\*\generator Msftedit 5.41.15.1503;}\viewkind4\uc1\pard\f0\fs20 ..: HOW TO READ A .BMS/.BME WITH A NOTEPAD AND A BRAIN :..\par + ..: Tutorial v1.1 by Jack A. Trades :..\par +\par +~ v1.1 differences\par +~1 Updated BPM Change method for over 255 and/or decimal BPM usage.\par +~2 Spelling/word errors fixed.\par +~3 Added a new KEYLOCATION variable, to go with the ~1 update.\par +\par +!TIP!\par +This tutorial is best viewed in fixed-width fonts, like Lucida Console or Courier New. It's also best viewed when Word Wrap feature is enabled, so if you need to copy and paste the entire tutorial to a temporary Notepad, then you may do so. You can always get the .rtf version if that's a hassle.\par +\par +!NOTE!\par +This tutorial is intended for the creation/viewing/translation (what the hell?) of a .bms/.bme for any beatmania game. I will not include any other function that might also function in other BEMANI games such as DDR arrows or whatever else that a . bms/.bme can do. BEATMANIA ONLY PLZTHXBYE.\par +\par +!!DISCLAIMER!!\par +This tutorial is created entirely from my knowledge and experience of .bms/.bme. I am not responsible for any loss of work, destruction of property, or loss of sanity when you are deciphering your own .bms/.bme and using this tutorial as your guide. Do not bug me if you somehow burned your computer or threw your cat out of the balcony. I don't want to hear it, except the cat part. I'll be sure to call Humane Society on that one.\par +\par +\par + So you want to read a BMS, eh? Well then, read on and I'll show what little bits of pieces of a .bms/.bme stand for, for I had no life, and I deciphered almost each of the mechanics a BMS/BME can have.\par +\par +\par + A BMS have two parts: HEADER and MAIN DATA FIELD. Without each other, they're useless, basically.\par +\par +\par +\par +\par +*----------HEADER\par +\par + There are three sections of the header: BASIC, EXTENSION, and the third section that I like to call ASSIGNMENT. \par +\par +\bullet BASIC is the heart and soul of the .bms/.bme, where it tells the simulator (and you) what the hell is the song about. Title of the song, artist name, genre, BPM, play mode, and play level is specified here.\par +\bullet EXTENSION is the optional header that can contain tags you can put as cosmetics, basically.\par +\bullet ASSIGNMENT is the last, but not least, section of the header. This is where the life of keysounds and background animations (hereon called as "bga") begin. You can specify as many as 255 keysound tags and 255 bga tags so the simulator knows what file to play at where and when.\par +\par + We will begin by explaining each available tags for BASIC header. Notice that lines that begin with *--- are my comments in the header section, as to not confuse you in an actual .bms/.bme.\par +\par +*---BASIC HEADER\par +\par +\par +\par +#PLAYER #\par +*---specifies player amount (options are 1 or 2). Use your logic; if it's 5/7-keys, use #PLAYER 1. If it's 10/14-keys, use #PLAYER 2.\par +\par +#GENRE [x]\par +*---specifies the genre [x] when the song is currently highlighted.\par +\par +#TITLE [x]\par +*---specifies the title [x] when the song is currently highlighted.\par +\par +#ARTIST [x]\par +*---specifies the artist [x] when the song is currently highlighted.\par +\par +#BPM ###\par +*---specifies ### ( 0 to 999 ) as the first (or only) BPM value of the song.\par +\par +#PLAYLEVEL ##\par +*---specifies # ( 0 to 9 ) as the amount of difficulty (stars) of the song. Some simulators, from my experience, can support values above 9, but let's not be that stupid, shall we?\par +\par +#MIDIFILE xxx.mid\par +*---This tag is optional if a bgm .wav/.mp3 already exists. Specifies the MIDI file to be played at the beginning of the song. MIDI file must be in the same directory where your .bms/.bme exists.\par +\par +\par +\par +*---EXTENSION HEADER\par +\par +\par +\par +#RANK #\par +*---specifies # ( 0 to 3, where 0 is Very Hard, 1 is Hard, 2 is Normal, and 3 is Easy) as the "rank" of the song. I don't know the exact function, but I don't think it'll tell the simulator to change the judge setting.\par +\par +#TOTAL ###\par +*---I'm not quite sure about this, but I think this specifies the maximum notes you can get in this song. So values from 0 to 9999 works, I guess.\par +\par +#VOLWAV ???\par +*---I don't know the actual specifier, but I have a hunch this tells the simulator to decrease or increase the volume of the bgm with/out keysounds.\par +\par +#STAGEFILE xxx.yyy\par +*---specifies the "preview" graphic of the song. Think backgrounds in DDR. This will be shown after you choose the song, during the loading of keysounds and bganimations, if available, and will disappear when the song starts. xxx.yyy specifies the filename and filetype respectively. I think you can also use directory command (Using ..\\..\\hi.jpg may tell the simulator to use the file hi.jpg two directories above the directory where this .bms/.bme exist) but I haven't tested it.\par +\par +%EMAIL [x]\par +*---a comment header; you can enter your e-mail address, if desired.\par +\par +%URL [x]\par +*---a comment header; you can enter your website url address, if desired.\par +\par +\par +\par +*---ASSIGNMENT HEADER\par +\par +\par +\par +#WAV** xxx.yyy\par +\par +*---this is where you specify the keysound file to be stored into a local variable by the simulator, where it will be able to be called upon during the gameplay of the song, and where ** is a two-digit hex value, xxx is the filename, and yyy is the filetype (commonly used are either WAV or MP3 files). \par +*---In Layman's terms, this is where you'll give the simulator a cardboard sign that says a two-digit number (or letter. explanation later...) and tell it to play SUCH AND SUCH file whenever you tell it to. So, an example would be:\par +\par +*---#WAV01 kickdrum.wav\par +\par +*---This means that whenever there's a section in the .bms/.bme that asks for a 01 in the keysound section, the simulator will then play the file kickdrum.wav, under two conditions: (1) IF AND ONLY IF the player actually presses the key, or (2) IF AND ONLY IF the digit called is in the Always-autoplay section.\par +\par +*---Confused with those new vocabularies? Read on and you'll understand what the hell I'm babbling.\par +\par +*---The **, or the two-digit number (or letter), ranges from 00 to FF. If you haven't noticed, it's the range of a 2-byte hex value. This means that you can specify up to 255 _different_ keysound files for the simulator to memorize. To assign more variables, just make a new line with changed variable number and filename. Example:\par +\par +*---#WAV01 kickdrum.wav\par +*---#WAV02 hi-hats.wav\par +\par +#BMP** xxx.yyy\par +\par +*---The #BMP tag has the same idea as the #WAV tag, and also the same usage. The only difference is that the variables will be called in different sections. See the Main Data Field for further explanation.\par +\par +*---HUGE NOTE, AS IN READ THE BELOW COMMENT BEFORE YOU GO ON\par +*---HUGE NOTE, AS IN READ THE BELOW COMMENT BEFORE YOU GO ON\par +*---HUGE NOTE, AS IN READ THE BELOW COMMENT BEFORE YOU GO ON\par +\par +*---You do NOT need to specify every single variable. That means stop typing 500 lines of specifying nothing. Any unspecified variables will be assumed as "blanks" by the simulator, and when it is called, the simulator will do nothing, if it's a keysound, or the simulator will stop any animation previously and display nothing, if it's a bga.\par +\par +\par +*----------MAIN DATA FIELD\par +\par + _THIS_ is the fun part. This section is where all of the keysounds are specified in bits and pieces of measures of the music, and _THIS_ is where you must act like a detective and decipher what the hell each line stands for. Thankfully, I have come with aid. And chips. And guacamole dip.\par +\par +BACK TO THE POINT\par +\par + Many of you will see jumbles of nothing but digits in a normal .bms/.bme file, but do you ever wonder how does it work? I'm sure you do, because if you've never wondered so, you won't be reading through here. Or to here, even.\par +\par + So we will begin, with the explanation. I'll have fun 'splaining as I will 'yping.\par + 'ey! 'ccent 're 'ool! 'nd 'nintelligible 'oo!!! 'o 'ffense.\par +\par +\par +\par + So here you are, wandering around the main data field, and you see numbers like this.\par +\par +#00412:00000000000000005F0000001A000000E3\par +\par +and something like that repeated differently about 3000 times.\par +\par +Let's begin understanding each section by breaking down the given example line. Obviously you should already understand the #. All codes begin with #. Duh.\par +\par +# 004 12 :00000000000000005F0000001A000000E3\par + ^\par + |\par + |\par +\par +This is your _Measure #_ . Obviously it ranges from Measure 1 (000) to Measure 1000 (999), but what song have 1000 measures? Hopefully you're not making a .bms/.bme to a nonstop megamix. Anyway, this tells the simulator what's going on in such measure. In this example, there are...12...thing...with a colon and many zeroes and 5F and 1A and E3 here and there in measure 5....interesting. Don't worry; you'll understand those things soon.\par +\par +Speaking of soon, we're moving right along to the next part. Boy was that quick or what?\par +\par +\par +# 004 12 :00000000000000005F0000001A000000E3\par + ^\par + |\par + |\par +\par + This is what I like to call KEY LOCATION variable, where it tells the simulator to put those...zeroes...and 5F...and the rest of the garbage into a variable of digit "12."\par + That didn't make a lot of sense, did it? Of course not. It didn't to me at first, until I deciphered the possible variables of key locations. Below is the list of the KEY LOCATION and its variable two-digit number.\par +\par +\par +KEYLOCATION - ACTUAL LOCATION/FUNCTION\par +======================================\par +11 - White key 1 (Most left)\par +12 - Blue key 1 (Most left)\par +13 - White key 2 (Second from the left)\par +14 - Blue key 2 (Center)\par +15 - White key 3 (Second from the right)\par +18 - Blue key 3 (Most right)\par +19 - White key 4 (Most right)\par +16 - Scratch (The big circle thing that makes wiki wiki wiki wik wik sound)\par +17 - \bullet unknown function currently\bullet\par +04 - BGA\par +07 - \bullet unknown function currently\bullet\par +06 - MISS BGA\par +01 - Always Autoplay\par +03 - BPM Change\par +08 - "Advanced" BPM Change\par +\par +\par + So in the above example, the code 00000000000000005F0000001A000000E3 will all be executed solely for the Blue key 1.\par +\par +\par + "BUT JACK A. TRADES, I WANNA KNOW HOW THOSE NUMBERS WORK AND WHAT ARE THEY ACTUALLY!?!??!?!/1/1/131'31'3nklnalndkland"\par +\par + Let's stop the question and start looking at the example below.\par +\par +# 004 12 :00000000000000005F0000001A000000E3\par + ^ ^\par + --------------------------------\par + |\par + |\par +\par + _NOT_ simply put, they are the codes that tell the simulator to call up all of the specified variables in a single measure. I lost you, didn't I?\par + Simply put, in this example, the simulator is told to call the following variables: 00 (8 times), 5F, 00 (3 times), 1A, 00 (3 times), and E3. That means the simulator will first find what you have specified earlier in the ASSIGNMENT HEADER, follow your command, and open/play that file for you at that point of time.\par + But how should this help you in terms of music? How can you specify exact call locations for the simulator, like a kick drum every beat in a measure, or a hi-hats for every-other-eighth-beat in a measure? This is where the (other) fun part comes in.\par +\par + The amount of digits available will determine what kind of a note each double-digit is. I lost you again, didn't I?\par +\par + For (another?) example, if you put a line of code such as this instead of the given example above:\par +\par + #00412:5F\par +\par + You're telling the simulator to play the 5F keysound whenever the player presses the blue key 1 at the first beat of measure 5.\par +\par + HOLY CRAP HOW DID I KNOW THAT!?\par + Well, if you've studied music, and understand what the hell I was saying earlier, then you must know you only specified one digit for the measure, and that means the simulator will assume that double-digit as a whole note. Remember: 4 beats equal a measure, and a whole note = 4 beats.\par +\par + So if you specify this instead:\par +\par + #00412:5F005F00\par +\par + The simulator will assume each double-digit as _quarter note_ and do the polka. I mean, do its thing. Play 5F in the first beat of the measure, play 00 in the second beat, play 5F in the third and finally play 00 in the fourth.\par + \par + If I specify:\par +\par + #00412:001A001A001A001A\par +\par + I'm telling the simulator to play the 1A in every other sixteenth notes. Get the picture?\par +\par + \'a4 THE AMOUNT OF DOUBLE DIGITS AvAILABLE IN THE LINE OF CODE SPECIFIES THE TYPE OF NOTE EACH ARE \'a4\par +\par + If there is one double-digit, it is a whole note.\par + If there are two double-digits, each double-digit is a half note.\par + If there are four double-digits, each double-digit is a quarter note.\par + If there are eight double-digits, each double-digit is a eighth note.\par + If there are sixteen double-digits, each double-digit is a sixteenth note.\par + If there are twelve double-digits, each double-digit is a twelveth note.\par + If there are thirty two double-digits, each double-digit is a thirty-second note.\par + ET CETERA\par +\par + The highest note type a simulator can take, usually, is a 192nd note. If you go beyond that, something is wrong with you or the song. Probably you, but you never know.\par +\par +\par + So let's recap! What does this code actually tell you?\par +\par + #00412:00000000000000005F0000001A000000E3\par +\par + \bullet At measure 5 ( #004 = MEASURE #5 ),\par + \bullet The following variables are to be called in the Blue Key 1 section ( #xxx12 = Blue Key 1 ):\par + \bullet 00,00,00,00,00,00,00,00,5F,00,00,00,1A,00,00,00,E3\par + \bullet Where each note is assumed as (in this strange case) a seventeenth note.\par + \bullet Therefore, the simulator must play the keysound of variable 00 in the first seventeenth note, then another 00 in the second seventeenth note, etc.\par + \par +\par + And you're done! See, that wasn't so hard, was it? But you think I'm forgetting something. Actually, two things. Well, I'm not, so shut up. That code always apply to everything you see in the KEYLOCATION table, including BGA and Always Autoplay.\par + The difference in the BGA, however, is that the simulator will load the graphics of the specified variables. So, if you've specified #BMP01 neh.bmp, and you want to call the graphic in a note, then the simulator will _NOT_ play the keysound for 01, but it will instead load the neh.bmp file.\par + The other and my last point that you think I've forgotten is the actual explanation of the other KEYLOCATION functions. I'll put the table below again for your convenience.\par +\par +\par +\par +KEYLOCATION - ACTUAL LOCATION/FUNCTION\par +======================================\par +11 - White key 1 (Most left)\par +12 - Blue key 1 (Most left)\par +13 - White key 2 (Second from the left)\par +14 - Blue key 2 (Center)\par +15 - White key 3 (Second from the right)\par +18 - Blue key 3 (Most right)\par +19 - White key 4 (Most right)\par +16 - Scratch (The big circle thing that makes wiki wiki wiki wik wik sound)\par +17 - \bullet unknown function currently\bullet\par +04 - BGA\par +07 - \bullet unknown function currently\bullet\par +06 - MISS BGA\par +01 - Always Autoplay\par +03 - BPM Change\par +08 - "Extended" BPM Change\par +\par +\par +\par +So what's 17 and 07 all about? I sure as hell don't know. Perhaps if you know, you would help me out with this tutorial. C'mon; I typed everything you see here, from my brain, in one single session.\par +\par +Never mind that for now. What's MISS BGA, Always Autoplay, and BPM, you ask?\par +\par + MISS BGA is where you can specify any custom animations you have when the player is currently missing the notes he's playing. If you want an absolute, easy example, find and download onoken - P8107 bms file with the background, and just miss a couple of notes (or the whole song and failing it, like I did!). You'll see that onoken has incorporated a custom MISS animation.\par + Of course, if you don't have the patience to make one, you can always specify a single image that has the word MISS in bold, or something. Preferably red, you know.\par + But nevertheless, to specify them is the exact same as how you would specify BGA or keysounds, but the only hassle is you have to copy and paste the same exact line for each measure you have.\par +\par + This is also true for my next topic: Always Autoplay. Mostly used in [L7] and usually in [7] keysound files, this baby will make sure any sound (or annoying noises) will always be played even if the player just sits there and watches himself plummet to a Game Over screen. Or something. The usage is a bit different, however. Remember that \'a4 THE AMOUNT OF DOUBLE DIGITS AvAILABLE IN THE LINE OF CODE SPECIFIES THE TYPE OF NOTE EACH ARE \'a4 rule? Well, it applies to every code you can see, even those beyond the horizon.\par +\par + So what do you have to do when you want to have two, three, or even four or more keysounds to play at the same exact time? Specify a new line, with different codes! Example is below:\par +\par +#00001:01\par +#00001:02\par +#00001:03\par +\par +This tells the simulator to play keysounds 01, 02, and 03 at the first note in measure 1. Simple, no?\par +\par + But when you blame me for forgetting things, you are right for one thing, but ONLY one thing. I forgot to mention the BPM. That lil' bugger is used when you want to suddenly change the BPM value of the song. The usage is still the same, with a little variation.\par +\par +#01103:96\par +\par + The lil' code above this paragraph tells the simulator to change the BPm at measure 12 to 150 BPM. So how did I get 150 from 96? Some weird formula like standard deviation of the population mean in a binomial distribution?\par +\par + Heck no, I got 150 because 96 is the hex value of 150. Let me remind you that 2-byte hex value only goes up to 255 in decimal, so in short, if you're trying to create a .bms/.bme for MaxX Unlimited, where the BPM changes from 300 to 280 to 300 to 150 to 320, we might have a problem. How would you specify a BPM value over 255?\par +\par +[credit goes to pukpuk/2220 for finding the method originally and jammitch for pointing me to the solution]\par +\par + You can specify your BPM in the ASSIGNMENT header, as you may recall. The process is the same; the code tag is the only one different. So if you want to specify a BPM of 320, put:\par +\par +#BPM01 320\par +\par + And call it in the main data field like:\par +\par +#00408:01\par +\par + This will call the BPM Change of 01 in measure 5, and thus changing the song's BPM to 320.\par +\par +\par + So if you want multiple BPM changes:\par +\par +#01103:96AFC8E1\par +\par + This tells the simulator to change the BPM to 150 at the first quarter note of Measure 12, to 175 at second quarter note, 200 at third, and 225 and fourth.\par +\par +\par +\par +\par +\par +\par +\par +\par +And with that, I conclude this tutorial. Hopefully I have made a tutorial that can actually help you read .bms/.bme more intelligently, and not think of egyptian inscriptions when you see those codes. Until next time, I am Jack A. Trades.\par +\par +~ let empathy fill the void ~\par +} + \ No newline at end of file diff --git a/Docs/SimfileFormats/BMS/BMS_Reading_Tutorial.txt b/Docs/SimfileFormats/BMS/BMS_Reading_Tutorial.txt new file mode 100644 index 0000000000..78423d4dd9 --- /dev/null +++ b/Docs/SimfileFormats/BMS/BMS_Reading_Tutorial.txt @@ -0,0 +1,323 @@ +..: HOW TO READ A .BMS/.BME WITH A NOTEPAD AND A BRAIN :.. + ..: Tutorial v1.1 by Jack A. Trades :.. + +~ v1.1 differences +~1 Updated BPM Change method for over 255 and/or decimal BPM usage. +~2 Spelling/word errors fixed. +~3 Added a new KEYLOCATION variable, to go with the ~1 update. + +!TIP! +This tutorial is best viewed in fixed-width fonts, like Lucida Console or Courier New. It's also best viewed when Word Wrap feature is enabled, so if you need to copy and paste the entire tutorial to a temporary Notepad, then you may do so. You can always get the .rtf version if that's a hassle. + +!NOTE! +This tutorial is intended for the creation/viewing/translation (what the hell?) of a .bms/.bme for any beatmania game. I will not include any other function that might also function in other BEMANI games such as DDR arrows or whatever else that a .bms/.bme can do. BEATMANIA ONLY PLZTHXBYE. + +!!DISCLAIMER!! +This tutorial is created entirely from my knowledge and experience of .bms/.bme. I am not responsible for any loss of work, destruction of property, or loss of sanity when you are deciphering your own .bms/.bme and using this tutorial as your guide. Do not bug me if you somehow burned your computer or threw your cat out of the balcony. I don't want to hear it, except the cat part. I'll be sure to call Humane Society on that one. + + + So you want to read a BMS, eh? Well then, read on and I'll show what little bits of pieces of a .bms/.bme stand for, for I had no life, and I deciphered almost each of the mechanics a BMS/BME can have. + + + A BMS have two parts: HEADER and MAIN DATA FIELD. Without each other, they're useless, basically. + + + + +*----------HEADER + + There are three sections of the header: BASIC, EXTENSION, and the third section that I like to call ASSIGNMENT. + + BASIC is the heart and soul of the .bms/.bme, where it tells the simulator (and you) what the hell is the song about. Title of the song, artist name, genre, BPM, play mode, and play level is specified here. + EXTENSION is the optional header that can contain tags you can put as cosmetics, basically. + ASSIGNMENT is the last, but not least, section of the header. This is where the life of keysounds and background animations (hereon called as "bga") begin. You can specify as many as 255 keysound tags and 255 bga tags so the simulator knows what file to play at where and when. + + We will begin by explaining each available tags for BASIC header. Notice that lines that begin with *--- are my comments in the header section, as to not confuse you in an actual .bms/.bme. + +*---BASIC HEADER + + + +#PLAYER # +*---specifies player amount (options are 1 or 2). Use your logic; if it's 5/7-keys, use #PLAYER 1. If it's 10/14-keys, use #PLAYER 2. + +#GENRE [x] +*---specifies the genre [x] when the song is currently highlighted. + +#TITLE [x] +*---specifies the title [x] when the song is currently highlighted. + +#ARTIST [x] +*---specifies the artist [x] when the song is currently highlighted. + +#BPM ### +*---specifies ### ( 0 to 999 ) as the first (or only) BPM value of the song. + +#PLAYLEVEL ## +*---specifies # ( 0 to 9 ) as the amount of difficulty (stars) of the song. Some simulators, from my experience, can support values above 9, but let's not be that stupid, shall we? + +#MIDIFILE xxx.mid +*---This tag is optional if a bgm .wav/.mp3 already exists. Specifies the MIDI file to be played at the beginning of the song. MIDI file must be in the same directory where your .bms/.bme exists. + + + +*---EXTENSION HEADER + + + +#RANK # +*---specifies # ( 0 to 3, where 0 is Very Hard, 1 is Hard, 2 is Normal, and 3 is Easy) as the "rank" of the song. I don't know the exact function, but I don't think it'll tell the simulator to change the judge setting. + +#TOTAL ### +*---I'm not quite sure about this, but I think this specifies the maximum notes you can get in this song. So values from 0 to 9999 works, I guess. + +#VOLWAV ??? +*---I don't know the actual specifier, but I have a hunch this tells the simulator to decrease or increase the volume of the bgm with/out keysounds. + +#STAGEFILE xxx.yyy +*---specifies the "preview" graphic of the song. Think backgrounds in DDR. This will be shown after you choose the song, during the loading of keysounds and bganimations, if available, and will disappear when the song starts. xxx.yyy specifies the filename and filetype respectively. I think you can also use directory command (Using ..\..\hi.jpg may tell the simulator to use the file hi.jpg two directories above the directory where this .bms/.bme exist) but I haven't tested it. + +%EMAIL [x] +*---a comment header; you can enter your e-mail address, if desired. + +%URL [x] +*---a comment header; you can enter your website url address, if desired. + + + +*---ASSIGNMENT HEADER + + + +#WAV** xxx.yyy + +*---this is where you specify the keysound file to be stored into a local variable by the simulator, where it will be able to be called upon during the gameplay of the song, and where ** is a two-digit hex value, xxx is the filename, and yyy is the filetype (commonly used are either WAV or MP3 files). +*---In Layman's terms, this is where you'll give the simulator a cardboard sign that says a two-digit number (or letter. explanation later...) and tell it to play SUCH AND SUCH file whenever you tell it to. So, an example would be: + +*---#WAV01 kickdrum.wav + +*---This means that whenever there's a section in the .bms/.bme that asks for a 01 in the keysound section, the simulator will then play the file kickdrum.wav, under two conditions: (1) IF AND ONLY IF the player actually presses the key, or (2) IF AND ONLY IF the digit called is in the Always-autoplay section. + +*---Confused with those new vocabularies? Read on and you'll understand what the hell I'm babbling. + +*---The **, or the two-digit number (or letter), ranges from 00 to FF. If you haven't noticed, it's the range of a 2-byte hex value. This means that you can specify up to 255 _different_ keysound files for the simulator to memorize. To assign more variables, just make a new line with changed variable number and filename. Example: + +*---#WAV01 kickdrum.wav +*---#WAV02 hi-hats.wav + +#BMP** xxx.yyy + +*---The #BMP tag has the same idea as the #WAV tag, and also the same usage. The only difference is that the variables will be called in different sections. See the Main Data Field for further explanation. + +*---HUGE NOTE, AS IN READ THE BELOW COMMENT BEFORE YOU GO ON +*---HUGE NOTE, AS IN READ THE BELOW COMMENT BEFORE YOU GO ON +*---HUGE NOTE, AS IN READ THE BELOW COMMENT BEFORE YOU GO ON + +*---You do NOT need to specify every single variable. That means stop typing 500 lines of specifying nothing. Any unspecified variables will be assumed as "blanks" by the simulator, and when it is called, the simulator will do nothing, if it's a keysound, or the simulator will stop any animation previously and display nothing, if it's a bga. + + +*----------MAIN DATA FIELD + + _THIS_ is the fun part. This section is where all of the keysounds are specified in bits and pieces of measures of the music, and _THIS_ is where you must act like a detective and decipher what the hell each line stands for. Thankfully, I have come with aid. And chips. And guacamole dip. + +BACK TO THE POINT + + Many of you will see jumbles of nothing but digits in a normal .bms/.bme file, but do you ever wonder how does it work? I'm sure you do, because if you've never wondered so, you won't be reading through here. Or to here, even. + + So we will begin, with the explanation. I'll have fun 'splaining as I will 'yping. + 'ey! 'ccent 're 'ool! 'nd 'nintelligible 'oo!!! 'o 'ffense. + + + + So here you are, wandering around the main data field, and you see numbers like this. + +#00412:00000000000000005F0000001A000000E3 + +and something like that repeated differently about 3000 times. + +Let's begin understanding each section by breaking down the given example line. Obviously you should already understand the #. All codes begin with #. Duh. + +# 004 12 :00000000000000005F0000001A000000E3 + ^ + | + | + +This is your _Measure #_ . Obviously it ranges from Measure 1 (000) to Measure 1000 (999), but what song have 1000 measures? Hopefully you're not making a .bms/.bme to a nonstop megamix. Anyway, this tells the simulator what's going on in such measure. In this example, there are...12...thing...with a colon and many zeroes and 5F and 1A and E3 here and there in measure 5....interesting. Don't worry; you'll understand those things soon. + +Speaking of soon, we're moving right along to the next part. Boy was that quick or what? + + +# 004 12 :00000000000000005F0000001A000000E3 + ^ + | + | + + This is what I like to call KEY LOCATION variable, where it tells the simulator to put those...zeroes...and 5F...and the rest of the garbage into a variable of digit "12." + That didn't make a lot of sense, did it? Of course not. It didn't to me at first, until I deciphered the possible variables of key locations. Below is the list of the KEY LOCATION and its variable two-digit number. + + +KEYLOCATION - ACTUAL LOCATION/FUNCTION +====================================== +11 - White key 1 (Most left) +12 - Blue key 1 (Most left) +13 - White key 2 (Second from the left) +14 - Blue key 2 (Center) +15 - White key 3 (Second from the right) +18 - Blue key 3 (Most right) +19 - White key 4 (Most right) +16 - Scratch (The big circle thing that makes wiki wiki wiki wik wik sound) +17 - unknown function currently +04 - BGA +07 - unknown function currently +06 - MISS BGA +01 - Always Autoplay +03 - BPM Change +08 - "Advanced" BPM Change + + + So in the above example, the code 00000000000000005F0000001A000000E3 will all be executed solely for the Blue key 1. + + + "BUT JACK A. TRADES, I WANNA KNOW HOW THOSE NUMBERS WORK AND WHAT ARE THEY ACTUALLY!?!??!?!/1/1/131'31'3nklnalndkland" + + Let's stop the question and start looking at the example below. + +# 004 12 :00000000000000005F0000001A000000E3 + ^ ^ + -------------------------------- + | + | + + _NOT_ simply put, they are the codes that tell the simulator to call up all of the specified variables in a single measure. I lost you, didn't I? + Simply put, in this example, the simulator is told to call the following variables: 00 (8 times), 5F, 00 (3 times), 1A, 00 (3 times), and E3. That means the simulator will first find what you have specified earlier in the ASSIGNMENT HEADER, follow your command, and open/play that file for you at that point of time. + But how should this help you in terms of music? How can you specify exact call locations for the simulator, like a kick drum every beat in a measure, or a hi-hats for every-other-eighth-beat in a measure? This is where the (other) fun part comes in. + + The amount of digits available will determine what kind of a note each double-digit is. I lost you again, didn't I? + + For (another?) example, if you put a line of code such as this instead of the given example above: + + #00412:5F + + You're telling the simulator to play the 5F keysound whenever the player presses the blue key 1 at the first beat of measure 5. + + HOLY CRAP HOW DID I KNOW THAT!? + Well, if you've studied music, and understand what the hell I was saying earlier, then you must know you only specified one digit for the measure, and that means the simulator will assume that double-digit as a whole note. Remember: 4 beats equal a measure, and a whole note = 4 beats. + + So if you specify this instead: + + #00412:5F005F00 + + The simulator will assume each double-digit as _quarter note_ and do the polka. I mean, do its thing. Play 5F in the first beat of the measure, play 00 in the second beat, play 5F in the third and finally play 00 in the fourth. + + If I specify: + + #00412:001A001A001A001A + + I'm telling the simulator to play the 1A in every other sixteenth notes. Get the picture? + + THE AMOUNT OF DOUBLE DIGITS AvAILABLE IN THE LINE OF CODE SPECIFIES THE TYPE OF NOTE EACH ARE + + If there is one double-digit, it is a whole note. + If there are two double-digits, each double-digit is a half note. + If there are four double-digits, each double-digit is a quarter note. + If there are eight double-digits, each double-digit is a eighth note. + If there are sixteen double-digits, each double-digit is a sixteenth note. + If there are twelve double-digits, each double-digit is a twelveth note. + If there are thirty two double-digits, each double-digit is a thirty-second note. + ET CETERA + + The highest note type a simulator can take, usually, is a 192nd note. If you go beyond that, something is wrong with you or the song. Probably you, but you never know. + + + So let's recap! What does this code actually tell you? + + #00412:00000000000000005F0000001A000000E3 + + At measure 5 ( #004 = MEASURE #5 ), + The following variables are to be called in the Blue Key 1 section ( #xxx12 = Blue Key 1 ): + 00,00,00,00,00,00,00,00,5F,00,00,00,1A,00,00,00,E3 + Where each note is assumed as (in this strange case) a seventeenth note. + Therefore, the simulator must play the keysound of variable 00 in the first seventeenth note, then another 00 in the second seventeenth note, etc. + + + And you're done! See, that wasn't so hard, was it? But you think I'm forgetting something. Actually, two things. Well, I'm not, so shut up. That code always apply to everything you see in the KEYLOCATION table, including BGA and Always Autoplay. + The difference in the BGA, however, is that the simulator will load the graphics of the specified variables. So, if you've specified #BMP01 neh.bmp, and you want to call the graphic in a note, then the simulator will _NOT_ play the keysound for 01, but it will instead load the neh.bmp file. + The other and my last point that you think I've forgotten is the actual explanation of the other KEYLOCATION functions. I'll put the table below again for your convenience. + + + +KEYLOCATION - ACTUAL LOCATION/FUNCTION +====================================== +11 - White key 1 (Most left) +12 - Blue key 1 (Most left) +13 - White key 2 (Second from the left) +14 - Blue key 2 (Center) +15 - White key 3 (Second from the right) +18 - Blue key 3 (Most right) +19 - White key 4 (Most right) +16 - Scratch (The big circle thing that makes wiki wiki wiki wik wik sound) +17 - unknown function currently +04 - BGA +07 - unknown function currently +06 - MISS BGA +01 - Always Autoplay +03 - BPM Change +08 - "Extended" BPM Change + + + +So what's 17 and 07 all about? I sure as hell don't know. Perhaps if you know, you would help me out with this tutorial. C'mon; I typed everything you see here, from my brain, in one single session. + +Never mind that for now. What's MISS BGA, Always Autoplay, and BPM, you ask? + + MISS BGA is where you can specify any custom animations you have when the player is currently missing the notes he's playing. If you want an absolute, easy example, find and download onoken - P8107 bms file with the background, and just miss a couple of notes (or the whole song and failing it, like I did!). You'll see that onoken has incorporated a custom MISS animation. + Of course, if you don't have the patience to make one, you can always specify a single image that has the word MISS in bold, or something. Preferably red, you know. + But nevertheless, to specify them is the exact same as how you would specify BGA or keysounds, but the only hassle is you have to copy and paste the same exact line for each measure you have. + + This is also true for my next topic: Always Autoplay. Mostly used in [L7] and usually in [7] keysound files, this baby will make sure any sound (or annoying noises) will always be played even if the player just sits there and watches himself plummet to a Game Over screen. Or something. The usage is a bit different, however. Remember that THE AMOUNT OF DOUBLE DIGITS AvAILABLE IN THE LINE OF CODE SPECIFIES THE TYPE OF NOTE EACH ARE rule? Well, it applies to every code you can see, even those beyond the horizon. + + So what do you have to do when you want to have two, three, or even four or more keysounds to play at the same exact time? Specify a new line, with different codes! Example is below: + +#00001:01 +#00001:02 +#00001:03 + +This tells the simulator to play keysounds 01, 02, and 03 at the first note in measure 1. Simple, no? + + But when you blame me for forgetting things, you are right for one thing, but ONLY one thing. I forgot to mention the BPM. That lil' bugger is used when you want to suddenly change the BPM value of the song. The usage is still the same, with a little variation. + +#01103:96 + + The lil' code above this paragraph tells the simulator to change the BPm at measure 12 to 150 BPM. So how did I get 150 from 96? Some weird formula like standard deviation of the population mean in a binomial distribution? + + Heck no, I got 150 because 96 is the hex value of 150. Let me remind you that 2-byte hex value only goes up to 255 in decimal, so in short, if you're trying to create a .bms/.bme for MaxX Unlimited, where the BPM changes from 300 to 280 to 300 to 150 to 320, we might have a problem. How would you specify a BPM value over 255? + +[credit goes to pukpuk/2220 for finding the method originally and jammitch for pointing me to the solution] + + You can specify your BPM in the ASSIGNMENT header, as you may recall. The process is the same; the code tag is the only one different. So if you want to specify a BPM of 320, put: + +#BPM01 320 + + And call it in the main data field like: + +#00408:01 + + This will call the BPM Change of 01 in measure 5, and thus changing the song's BPM to 320. + + + So if you want multiple BPM changes: + +#01103:96AFC8E1 + + This tells the simulator to change the BPM to 150 at the first quarter note of Measure 12, to 175 at second quarter note, 200 at third, and 225 and fourth. + + + + + + + + +And with that, I conclude this tutorial. Hopefully I have made a tutorial that can actually help you read .bms/.bme more intelligently, and not think of egyptian inscriptions when you see those codes. Until next time, I am Jack A. Trades. + +~ let empathy fill the void ~ \ No newline at end of file diff --git a/Docs/SimfileFormats/BMS/_src.txt b/Docs/SimfileFormats/BMS/_src.txt new file mode 100644 index 0000000000..c7b3a79e27 --- /dev/null +++ b/Docs/SimfileFormats/BMS/_src.txt @@ -0,0 +1,17 @@ +BM98Data_format_specification.html = http://www.sun-inet.or.jp/~yaneurao/bm98/bmsformat.html +BM98FinalSecret.html = http://www.sun-inet.or.jp/~yaneurao/bm98/bm98secret.html (Japanese) +tmp.txt = http://unhappyangel.at.infoseek.co.jp/bms/tmp.txt +BMS_Reading_Tutorial.txt = http://www.angelfire.com/ga4/jackatrades606606/BMS_Reading_Tutorial.txt + +[BMS Dialects] +Drum BMS: http://wiki.bms.ms/Drum_BMS:Spec (Japanese) +DDR BMS + * http://wiki.bms.ms/DDR_BMS:Spec (Japanese) + * http://www.mni.ne.jp/~asuma/dde/explain.html (Japanese) + * http://homepage1.nifty.com/nickle/ex_format.html (Japanese) + +[not in repository but good reading] +http://fileformats.wikia.com/wiki/Be-Music_Script +http://nvyu.net/rdm/rby_ex.php (warning: Korean language material) +http://wiki.bms.ms/Bms:Spec +http://wiki.bms.ms/index.php?title=Bms:Format&oldid=1615 (last good revision) \ No newline at end of file diff --git a/Docs/SimfileFormats/BMS/tmp.txt b/Docs/SimfileFormats/BMS/tmp.txt new file mode 100644 index 0000000000..9ce2bbe99d --- /dev/null +++ b/Docs/SimfileFormats/BMS/tmp.txt @@ -0,0 +1,187 @@ +BMS Format Specification(Remake version.) +Written in June 28th 2003. + +original document written by Urao Yane. +edited by U(uhangel4u@yahoo.co.jp) + +"BMS" means a Be-Music Source file. A file which has BMS suffix is regarded as the BMS file. +This file format was produced by Urao Yane and NBK in 1998.and It revised sometime. +And I adopted this file format to BM98, Delight Delight Reduplication, MixWaver, nazoBMPlay and so on. +Now,anyone can use this format freely. + +BM98 Drink Edition +http://www5c.biglobe.ne.jp/~kbs/bm98/ (Japanese) +Delight Delight Reduplicaton +http://nickle.hey.to/ (Japanese) +MixWaver +http://hello.to/mixwaver/ (Korean) +nazoBMPlay +http://www.nothing.sh/nazobmplay/ (Japanese) + +-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + +DANCE WITH INTENSITY v2.50.00
+© SimWolf, 2003
-
+
- DISCLAIMER AND TERMS OF USE +
- WHAT'S NEW? +
- USING AND CONFIGURING DWI
-
+
- Basic Operation +
- Song Sorting +
- Selecting Song Modifiers +
- Special keys +
- Controller Configuration +
- Gameplay Settings +
- Sound Configuration +
- Changing the Display from Windowed to Full-screen +
- Sound effects +
- Command-line options +
- Testing a song +
- Setting Skins +
- Setting Announcer and Sound Effects +
- Folder- and Genre- Specific Banners +
- AVI Movie Support +
- Sonique Visualizations (SVP) Support +
- User Profiles +
- DWI FILE FORMAT
-
+
- Steps +
- Hold Arrows +
- Tags +
- Background Animations, Movies, and Visualizations +
- NONSTOP MODE AND CRS FILE FORMAT +
- LRC (LYRICS) FILE FORMAT +
- LIMITATIONS +
- VERSION HISTORY +
- FUTURE DEVELOPMENT AND THANKS +
1. DISCLAIMER AND TERMS OF USE
+ +This program is provided for free, as-is. Although it has been tested on multiple systems for compatability and reliability, you run this program at your own risk. I cannot be held responsible if the program causes file loss or other problems.
+ +THIS PROGRAM IS *NOT* FOR SALE!!! IT SHOULD NEVER BE BUNDLED WITH ANY OTHER FILES (MUSIC OR STEP FILES) ON ANY MEDIA, INCLUDING (BUT NOT LIMITED TO) CD's, DVD's, DISKS OR OTHER MEDIA.
+ +DWI is Donation-Ware. Although you are not required to donate, it would be greatly appreciated if you enjoy the program that you contribute something towards the developers.
+ +This program simulates a popular arcade and home video game. It was written to allow myself the ability to play songs from the games without having to switch CDs in my Playstation or Dreamcast, and also affords the ability to add new songs not currently available. It also allows for playing older songs with new play modes, such as downward-scrolling arrows. This program is being released to the public in the hopes that others would find it useful in the same manner.
+ +As such, this program REQUIRES responsibility on the part of the end-user (ie. YOU) to use the program LEGALLY. You should *ONLY* play songs where you:
| a) | Own the game from which that music comes from. |
| or b) | Own the soundtrack CD from which the music comes from. |
| or c) | Legally own rights to the music being used (ie. other CDs, etc.) |
I own all the available soundtracks and videogames for the music I own, and respectfully ask that you support the games and purchase them. Thank you.
+ + + ++v2.50.00 - August 14, 2003. + - NEW: Addition of WAVE, BRAKE, and 0.25x modifiers. + - BUGFIX: Stage numbers and various other numbers are coloured again. + - BUGFIX: Bonus stages now default to Heavy/Maniac again. + - OTHER: Various other bugs I can't remember that have been fixed. + ++ + + + +
BASIC OPERATION
+ +When you first run DWI, you will receive a warning screen about responsible use of the program. This warning screen will appear *EVERY* time the program detects new songs.
+ +DWI uses step-files with the extension ".DWI". These files go in their own folder along with their associated background and banner images. Optionally the music file can go in the same folder also.
+ +DWI supports multiple collections of songs, so you can organise your songs as you see fit. To do this, just create different sub-directories in the "Songs" folder.
+ +eg. For a song with a step-file of "abc.dwi", put into a collection called "My Songs", your directory structure should look like this:
+ <INSTALL directory> + + Songs + + My Songs + + abc + + abc-banner.png (any name, the program will detect that it's a banner) + + abc-bg.png (any name, the program will detect that it's a background) + + abc.dwi (any name) + + (abc.mp3/wav) (optional - otherwise FILE: tag is used). + + (abc.lrc) (optional - should have same base as DWI file). ++ + +
So, in each "song folder", there should be two image files (background and banner), the DWI file, and optionally the music file in MP3 or WAV format.
+ +Song Sorting
+ +When you are at the song select screen, simply press up or down to change the current collection you are in. Songs are organized alphabetically within each collection, and collections are organized alphabetically also.
+ +Another option is to sort your music by genre. To activate this, go to "Options Menu", then "System Menu", and change the sort method to "GENRE" *. This requires your DWI files to have a tag defining the genre to put the music into (see DWI format, below). Multiple genres can be given (separated by a comma), to make the same song appear in different collections. At the song select screen, press up or down to change the genre.
+ +You can also press Up-Left to change the sort method. This cycles through:
-
+
- Folder/Genre (default) +
- Folder/Genre, Separated +
- All Music (by title) +
- All Music (by artist) +
- BPM. +
- Player's Best (top 64) +
Selecting Song Modifiers
+ +At the song-select screen, press the "Select" button/key, and use the arrows to change options. When done, press "Select" again. Alternatively, you can hold down "Start" when selecting a song and you will be taken to a +screen where you can set your options.
+ +| Speed: | 1.5x, 2.0x, 3.0x, 4.0x, 5.0x, 8.0x, 0.5x, 0.75x, 0.25x |
| Boost: | BOOST, BRAKE, WAVE |
| Appear: | HIDDEN, SUDDEN, STEALTH |
| Turn: | LEFT, MIRROR, RIGHT, SHUFFLE |
| Other: | LITTLE, FLAT, SOLO |
| Dark: | DARK (can't see arrow indicators) |
| Scroll: | REVERSE |
| Freeze: | NOFREEZE |
| Power: | POWER-DROP (gauge starts full and depletes), DEATH (must full-combo song) |
For courses and bonus stages, use the same text as above in the course definition file when setting modifiers.
+eg. #SONG:Default\MySong:BASIC:1.5x,HIDDEN,LEFT,FLAT;
Special keys
+ +The function keys will be used to adjust or enable various gameplay functions. Primarily these are designed for people creating DWI files and want to adjust timing.
+ +| F1/F2 | - Restarts the song (developer mode only) |
| F3/F4 | - Adjust playback speed of song down/up (during song select/gameplay) |
| F5/F6 | - Adjust BPM value down/up by 0.50 BPM. (during gameplay) |
| F7/F8 | - Adjust BPM value down/up by 0.02 BPM. (during gameplay) |
| F9/F10 | - Adjust GAP value down/up by 5ms. (during gameplay) |
| F12 | - Toggle "Assist Click" on/off. (during song select/gameplay) |
Controller Configuration
+ +To change the inputs, simply go to the Options Menu from the main screen and goto "Keyboard Configuration" or "Gamepad Configuration". Choose to configure either Player 1 or Player 2's inputs and you will be prompted to press each key, joystick button or dancepad square in turn. You cannot choose an input that is currently in use. To skip joystick buttons, press the "TAB" key.
+ +When done, select "Return" to make the change take effect.
+ +Gameplay Settings
+ +Gameplay settings such as difficulty level, danger display, and end-of-game settings are selected from the Gameplay Configuration menu from the Options screen. These changes take effect immediately.
+ +Extra Stages
+ +If you AA a Heavy or Challenge mode song on the last stage and have Extra Stages enabled in the Game Options, you can play another song. The song(s) you can choose from are either generated randomly (3 for Extra Stage #1, one for Extra Stage #2), or can be defined in a CRS file.
+ +| bonus-1.crs | Songs for Extra Stage #1 |
| bonus-2.crs | Songs for Extra Stage #2 |
NB: These CRS files go in the same directory as DWI2.exe, not the Courses folder.
+ +Sound Configuration
+ +The default sound settings for DWI are 44Khz, Stereo, 16-bit samples. However, you may want to lower these +settings on slower computers.
+ +* NB: You must exit DWI and start it again for this change to take effect. + +Changing the Display from Windowed to Full-screen
+Go to the "System Menu" from the Options screen and change the display type.
+ +* NB: You must exit DWI and start it again for this change to take effect. + +Sound effects
+ +Sound effects are all in the "Sounds" directory. You can add or remove files to most directories, and the program will use the existing files during gameplay. However, files in the root of the sound-set directory and those in the "attract" and "combo" directories must be the same name in order for the program to find them and play them appropriately.
+ + + +You can run DWI with various command line options to configure some values. (Please read the FAQ for details +on how to start the program with command line options). These options are available:
+ +| /sdl | Starts DWI in the software-only graphics mode. |
| /16bpp | Runs DWI in 16-bit colour mode (SDL), or uses a 16-bit primary surface (DirectX) |
| /32bpp | Runs DWI in 32-bit colour modes/32-bit primary surface. |
| /fullscreen | Runs DWI in fullscreen mode (may need to use to start on some cards) |
| /window | Runs DWI in a window. Some cards won't support this so DWI will try fullscreen. |
| /log | Creates a 'dance.log' file that can be useful for debugging. |
| /anysize | In DirectX mode, this tries to make textures in any size, rather than creating textures to the nearest power-of-two value (ie. a 75x60 image is loaded into a texture that big instead of a 128x64 one). This can speed up performance on some cards and save memory, if your card can handle it. |
| /sw | In SDL mode, surfaces are created in regular memory (default) |
| /hw | In SDL mode, surfaces are created in hardware memory (can improve performance if your card can handle it). |
| /priority:x | can force DWI to run as a more "important" program under Windows. "1" starts it as "ABOVE NORMAL", "2" is "TIME CRITICAL". May improve performance in certain cases. (Use with caution if you're running many other processes at the same time). |
| /sdevice:x | tells DWI to use a given sound-device. Use "/log" and look in dance.log first for a list of available sound-devices. |
| /fps:xx | makes DWI try to stay at a given framerate (20..100). If you've got a fast machine, this can really save on computer cycles. |
| /showsm | will add songs with only SMANIAC steps to the song-select screen. |
| /skipsearch | will prevent DWI from searching the Songs folder at startup. |
| /dither:0 | will turn off the dithering effect DWI uses for semi-transparent images on old videocards that can't handle them. Some users may prefer this to remove the 'speckles' in the gameplay graphics. |
You can limit paging to virtual memory during gameplay (which can cause skips as Windows decides to write or retrieve data from disk) using these flags:
+ +| /minRAM:xx | Instructs DWI to try to reserve at least this much physical memory from the Operating System. * |
| /maxRAM:xx | Instructs DWI to try to reserve at most this much physical memory from the Operating System. * * Only works in Windows NT, 2000, and XP. Default is 16-32MB. |
Use these flags to fix strange behavior in DWI...
+ +| /key:nonexclusive | affect how DirectInput is initialized. Should be paired with one of /key:fg or /key:bg |
| /key:exclusive | |
| /key:fg | affect how DirectInput is intialized. |
| /key:bg | |
| /altcombo | for reasons known to the heavens and my machine in the basement, DWI would not display the 'lives' image in Nonstop Mode, instead locking up the computer. I'm convinced this is a videocard/driver issue, as the code to draw the image is exactly the same as the code to display any other image... but oh well. Using this command line argument will tell DWI to not try to display the image and instead write "X Lives" in its place, which seemed to make it work. Strange... but the option's there in case you run into the problem too. |
| /v5hack | some Voodoo card drivers seem to allocate space for textures incorrectly (off by one) - this should hopefully fix the problem. |
| /altmovie | Uses an alternate way of drawing the background movies and visualizations for older videocards that display solid-colour textures instead. |
| /noshade | Prevents the extra shading effect on the song-select wheel from being added. |
Testing a song
+ +| /test:... | You can start DWI in test/developer mode by using the "/test:..." command line argument. Provide the *folder* the .dwi file is in. |
| /style:... | use this set of steps (SINGLE, DOUBLE, SOLO). Default is SINGLE. |
| /level:... | use this level of steps (BASIC, ANOTHER, MANIAC, SMANIAC). Default is BASIC. |
| /p2 | test using player 2's controls instead. |
| /speed:X | starts song at a given speed (1..5) |
| /scroll:X | starts song with given speed modifier (0.5, 0.75, 1.5, 2, 3, etc.) |
| /startat:<TIME> | jumps to a given time into the song (game-time). <TIME> can be given in minutes, seconds, or milliseconds.
+ie. /startat:1:05.5 (minutes) + /startat:65.5 (seconds) + /startat:65500 (ms) - all the same position. |
| /tick:1 | turns the assist click on at startup (default is off). |
| /dark | hides the fixed-place arrows during testing. |
Example:
+ +"DWI.exe /test:.\Songs\Development\MyNewSong /style:SINGLE /level:MANIAC /p2 /speed:4 /scroll:2 /startat:1:00"
+ +Starts testing the .dwi file found in \songs\development\mynewsong, in SINGLE mode, with MANIAC-level steps. Player 2's controls are used, and the song's speed is set to '4'. Arrows are displayed as though the "x2" modifier was active. The song starts at the 1-minute mark.
+ +Setting Skins
+ +Create different sub-directories within the "Skins" folder for each skin you wish to use. So, for example: +
+ <INSTALL directory> + + Skins + + Default (leave as-is) + + Skin A + + Skin B + + ...+ +
The filenames for each skin should be the same as in the default directory. If an image isn't found, the default is used. This way you can create skins that are relatively simple, or very elaborate ones. And you don't need to delete any of the original files. ;) There is a limit of 64 skins.
+ +Changes will take effect when you leave the Skin Selection screen.
+ +I do ask, however, that you keep the title of the program as "Dance With Intensity". Thank you. :)
+ +Setting Announcer and Sound Effects
+ +Similar to skins, just create new directories in the 'Sounds' folder for each sound set you wish to use. So, for example: +
+ <INSTALL directory> + + Sounds + + Default (leave as-is) + + Jack + + Jill + + ...+ +
The tree structure for each set should be the same as is used for the "Default" directory. For example: +
+ Jill
+ + attract - files should be named attract-00.wav, attract-01.wav, attract-02.wav
+ | (these are the sounds used on the title screen)
+ + combo - files should be named combo-00.wav and combo-01.wav
+ | ("100 Combo" and "Combo stopped")
+ + danger - a set of files played when power level at danger or zero.
+ + eval
+ | + A
+ | + B - sets of files to play at the evaluation screen based on grade
+ | + ...
+ + good - a set of files played when power level in the 'good' range
+ + great - " " 'great' range
+ + over
+ | + fail - files played at game over screen (failure)
+ | + pass - " " (cleared all stages)
+ + select
+ | + new - files played when #STATUS:NEW; is set in DWI file and song is selected
+ | + song - files played when a song is selected
+ + start
+ + + go - files played at "Here we go!" screen.
+ + + ready - files played at "Ready?" screen.
+ + warning - a set of files played when the power gauge is in the 'warning' range.
+
+There should not be more than 64 sound effects in a single subdirectory. There is a limit of 64 sets. Changes will take effect once you leave the Announcer/Sound Select screen. Please keep the title sound effect (attract-00.wav) as "Dance With Intensity".
+ +Folder- and Genre- Specific Banners
+You can make DWI display a special banner for each folder when it is highlighted on the Song-Select Screen. To do this, simply put a standard (horizontal) banner with the same name as the folder in the 'Songs' folder. (eg. a banner for 'Default Songs' would be ".\Songs\Default Songs.png").
+ +If you have sorting by Genre on, you can have special banners for each Genre by putting banners in PNG format with the same name as the Genre referenced into ".\Genres". (eg. "Pop Music.png").
+ +Folder-Specific Banners can also be made for Courses too. Just put a PNG file with the same name as the subfolder the CRS files are in, in the "Courses" directory.
+ +AVI Movie Support
+AVI movies can be played in the background while you play. See the "Background Animation" section below for more details on how this is set up. From the System Menu, you can tell DWI whether to not play AVI files at all, or set the quality level from 1 (worst) to 10 (full). The default is 5. Changing this value could affect your framerate, so play with the values to determine what works best for your system.
+ +Random animations are picked from the ./Movies/Random folder and played in the background of songs without a defined background script if enabled in the System Options menu. This folder can be changed by a flag in the DWI file also, enabling themes.
+ +Sonique Visualizations (SVP) Support
+Sonique visualizations can be played in the background while you play. See the "Background Animation" section below for more details on how this is set up. From the System Menu, you can tell DWI whether to use them at all, or set the quality level from 1 (worst) to 10 (full). The default is 5. Changing this value could affect your framerate, so play with the values to determine what works best for your system.
+ +Random visualizations are picked from the ./Vis folder and played in the background of songs without a defined background script if enabled in the System Options menu. Their behavior can often be changed by editing the 'vis.ini' file that is created after they are used in DWI, similar to in Sonique.
+ + +DWI2.40 introduced 'user profiles' - a way that multiple users can play DWI on the same machine and keep their own individual records. Setting up a new profile is easy - simply create a new subdirectory in the "Profiles" directory with the name of the user (15 characters or less), and inside that folder, put a 64x64 PNG file called 'user.png' to represent you in the game. Look at the 'Profiles/Sample User' folder for an example.
+ +When you use a profile, DWI will create an individual records file and profile information file in the same directory that keeps track of your individual achievements.
+ +When you get a high score, it will be saved to your own profile's records ("New Personal Best"), and, if you beat the overall high score, it will also be saved to the system records ("It's a New Record!"), with your username registered with it.
+ +Using a user-profile also lets you track some other statistics, such as overall high scores and combos for each mode. It will also store the last-used modifiers you used (eg. 2x speed modifier, Reverse) between sessions, so you don't have to set it again each time you start a new game.
+ +This option can be disabled in the Game Options Menu if you prefer.
+ +4. DWI FILE FORMAT + +Steps
+ +DWI uses step-files that are similar to the ".MSD" file format. However, there are new additions and some tags are treated slightly differently, so the extension was changed to avoid confusion. DWI files with these new additions will not work properly in other simulators.
+ +Step-patterns are defined in the same way as .MSD files - use the numeric keypad as a reference for most patterns: +
+ 7=U+L 8=U 9=U+R + + 4=L 6=R + + 1=D+L 2=D 3=D+R + + (U+D = A and L+R = B) ++ +
A '0' indicates no step. Each character defaults to one 1/8 of a beat. Surround a series of characters with the following brackets to change the rate at which the steps come: +
+ (...) = 1/16 steps
+ [...] = 1/24 steps
+ {...} = 1/64 steps
+ `...' = 1/192 steps
+
+6-panel (Solo) mode uses additional characters: +
+ -\---- = C + ----/- = D + + L\---- = E + -\D--- = F + -\-U-- = G + -\---R = H + + L---/- = I + --D-/- = J + ---U/- = K + ----/R = L + + -\--/- = M+ +
To do more than 2 panels at a time, you can join codes together with the "<..>" object, and they will all count as the same beat. So, to do a jump that involves Left, Right, Up-Left, and Up-Right, you could do: +
+ -\--/- = M + L----R = B + ====== + L\--/R = <MB> (or <LE>, <IH>, <46M>, etc.)+ +
MSD files from other simulators will work with DWI, with a change in the 'GAP' value being the only change usually necessary. DWI calculates the 'GAP' value differently than other simulators that use the MSD format.
+ +DWI does not support the BMS file format. There is a utility available that can convert any BMS file into DWI format. Each song only requires one DWI file for all of its steps, so if you are converting BMS files please remember that all the different difficulties of step patterns will be contained in the same DWI file.
+ +Hold Arrows
+ +In the DWI file format a hold arrow is signified with the ! symbol. The string 8!8 will begin an 'up' hold arrow, and the arrow will be released the next time the program encounters an 'up' arrow: by itself or combined with another arrow (7, 8, 9, A, etc.) The characters 7!4 would show both 'up' and 'left' arrows but only the left arrow would be held. The format could best be described as "show!hold".
+ +Tags
+ +These tags should be in every DWI file:
+ +| #TITLE:...; | title of the song. |
| #ARTIST:...; | artist of the song. |
| #GAP:...; | number of milliseconds that pass before the program starts counting beats. Used to sync the steps to the music. |
| #BPM:...; | BPM of the music |
Additionally, the following tags can be given:
+ +| #DISPLAYTITLE:...; | +provides an alternate version of the song name that can also include special characters. | +
| #DISPLAYARTIST:...; | + provides an alternate version of the artist name that can also include special characters. + + Special Characters are denoted by giving filenames in curly-brackets. + eg. #DISPLAYTITLE:The {kanji.png} Song; + + The extra character files should be 50 pixels high and be black-and-white. The baseline for the font should be 34 pixels from the top. + |
+
| #DISPLAYBPM:...; | +tells DWI to display the BPM on the song select screen in a user-defined way. Options can be: + +* - BPM cycles randomly +a - BPM stays set at 'a' value (no cycling) +a..b - BPM cycles between 'a' and 'b' values + |
+
| #FILE:...; | + path to the music file to play (eg. /music/mysongs/abc.mp3 ) + (NB: if the file is not found, a .wav or .mp3 file in the same folder as the DWI file is used) |
+
| #MD5:...; | +an MD5 string for the music file. Helps ensure that same music file is used on all systems. | +
| #FREEZE:...; | +a value of the format "BBB=sss". Indicates that at 'beat' "BBB", the motion of the arrows should stop for "sss" milliseconds. Turn on beat-display in the System menu to help determine what values to use. Multiple freezes can be given by separating them with commas. | +
| #CHANGEBPM:...; | +a value of the format "BBB=nnn". Indicates that at 'beat' "BBB", the speed of the arrows will change to reflect a new BPM of "nnn". Multiple BPM changes can be given by separating them with commas. | +
| #STATUS:...; | +can be "NEW" or "NORMAL". Changes the display of songs on the song-select screen. | +
| #GENRE:...; | +a genre to assign to the song if "sort by Genre" is selected in the System Options. Multiple Genres can be given by separating them with commas. | +
| #CDTITLE:...; | +points to a small graphic file (64x40) that will display in the song selection screen in the bottom right of the background, showing which CD the song is from. The colour of the pixel in the upper-left will be made transparent. | +
| #SAMPLESTART:...; | +the time in the music file that the preview music should start at the song-select screen. Can be given in Milliseconds (eg. 5230), Seconds (eg. 5.23), or minutes (eg. 0:05.23). Prefix the number with a "+" to factor in the GAP value. | +
| #SAMPLELENGTH:...; | +how long to play the preview music for at the song-select screen. Can be in milliseconds, seconds, or minutes. | +
| #RANDSEED:x; | +provide a number that will influence what AVIs DWI picks and their order. Will be the same animation each time if AVI filenames and count doesn't change (default is random each time). | +
| #RANDSTART:x; | +tells DWI what beat to start the animations on. Default is 32. | +
| #RANDFOLDER:...; | +tells DWI to look in another folder when choosing AVIs, allowing 'themed' folders. | +
| #RANDLIST:...; | +a list of comma-separated filenames to use in the folder. | +
Each pattern of steps for different modes have the same basic format: +
#SINGLE:BASIC:X:...; + ^ ^ ^ ^ + | | | + step patterns. In doubles, the left pad's steps are given first, + | | | then the right pad's, separated by a colon (:). + | | | + | | + difficulty rating. Should be 1 or higher. + | | + | + Difficulty. Can be one of "BASIC", "ANOTHER", "MANIAC", or "SMANIAC" + | + + Style. Can be one of "SINGLE", "DOUBLE", "COUPLE", or "SOLO". "COUPLE" is + Battle-mode steps.+ +
Comments can be used by using "//". Everything after this on the same line in the file will be ignored.
+ +Background Animations, Movies, and Visualizations
+ +DWI allows for background animations using a special script within the step-file. A script consists of static images, animated images, and/or an AVI movie. Using the script, you can create a variety of layered effects. A sample animation is described below: +
+ #BACKGROUND: + + M:MOVIE:.\movies\sfx.avi STARTAT:-1.0 LAYER:0; + V:VIS:.\Vis\somevis.svp LAYER:0; + E:FILE:.\anim\equalizer.png ANIMATE:10,33 POSITION:-33,0 SPACING:40,40 LAYER:1; + D:FILE:.\anim\dancer-m1.png ANIMATE:24,66 SIZE:2 MULT:0,0.5,1 SPACING:30,30 LAYER:1; + X:LAYER:1 OFF; + + SCRIPT:M....................... + ................E............... + D...............X,V...............E...............D............... + X,M...............E...............D...............X,V............... + E...............D...............X,M...............E............... + D...............X,V...............E...............D............... + X,M...............E...............D...............X; + + #END;+ +
The first part of the "BACKGROUND" definition defines the effects. Each effect is attributed to a letter or number ("a-z", "A-Z", "1-9"). The format for defining an effect is:
+ +| The first four tags cannot be used together... | |
| FILE: | path to a file. Either a still image, or an animation (multiple frames of animation are stacked *vertically* in the image). |
| MOVIE: | path to a standard Windows AVI file. Note that the movie won't play unless you have the right codecs installed in Windows. Movies are currently stretched to fill the whole screen. |
| VIS: | path to a Sonique Visualization plug-in (SVP). Visualizations are currently stretched to fill the whole screen and are always put on Layer 0, and no other commands will affect it. |
| OFF | turns off a layer, effectively making it invisible. Will not turn off layer 0. |
| LAYER:l | the layer to use (required):
+0 - base layer. + (Image/Movie is always tiled and SPACING is ignored). + 1 - overlay layer + 2 - overlay layer + 3 - overlay layer |
| STARTAT:t | number of seconds into the AVI file to start at. If negative, the movie will wait that many seconds before playing. Can be decimal (eg. 1.3 = 1300ms). |
| MULT:r,g,b | Red, Green, and Blue pixels in the image/movie are tinted by the given amounts. This way the same image/movie can be used multiple times across DWI files and have different colours. |
| ANIMATE:f,n1,n2,...nF | indicates that the FILE contains multiple frames of animation. "f" is the number of frames of animation. Each following value is the number of milliseconds each frame of animation is displayed. If not enough time-values are given, the last given value is used. Ignored for MOVIE type. |
| MOVE:x,y | the image/movie is moved by the given number of pixels every millisecond. |
| SPACING:x,y | images are always tiled if they don't fill up the screen. This tag allows you to add some spacing between the images by the given number of pixels horizontally and vertically (Layer > 0) |
| SIZE:s | multiplies the image size by 's' in both directions. Must be a whole number. |
| KEEPPOS | normally when a new effect is turned on, its position is reset. This tag keeps the layer where it is, useful for keeping images moving smoothly. |
| KEEPTIME | (MOVIEs only) normally when a movie starts, it starts from the beginning or the time given in the "STARTAT" tag. Adding this tag will keep it playing so when that layer is enabled again, it will have kept going. |
Following the effect definition, comes the actual animation script. This is a sequence of characters in a similar way as the step-patterns are given - each character normally is 1/8 of a beat, though brackets can be used to change the time-values. In this way, background animations can be syched to the steps. It is suggested that the steps for "SINGLE:BASIC" are copied to after the "SCRIPT:" tag, and then the effects be set. In this way one knows that the script will match the same length of the music.
+ +The animations take effect as that point in the song is reached. Multiple effects can occur at the same time if they are separated with a comma. A period (.) means no new effect should take place at that point. A zero (0) turns off all effects and returns the background to the original graphic.
+ +More Information
+ +Please check our website for more information and links to useful resources.
+ +5. NONSTOP MODE AND CRS FILE FORMAT
+ +DWI uses special CRS files that should be put in subfolders of the "Courses" directory. Now courses +can be shared with others if they have the same files and directory structure as you.
+ +CRS files are similar to DWI files in structure. The file defines the basic details about the course, such as its name and which songs should be played. Currently these tags are supported:
+ +Required tags:
+ +| #COURSE:...; | the name of the course. |
| #DISPLAYCOURSE:...; | alternate name of course that can include special characters. Similar to #DISPLAYTITLE and #DISPLAYARTIST in DWI files. |
| #SONG:...; | defines a song in the course. This can either be a selection from the Player's Best (or Worst), a Random stage or a predefined stage. The syntax for each is given below: + PLAYER'S BEST/WORST STAGE: + #SONG:BESTx:[BASIC|ANOTHER|MANAIC|SMANIAC]; + #SONG:WORSTx:[BASIC|ANOTHER|MANAIC|SMANIAC]; + - choose a song with the given index 'x'. So BEST1 is the most popular + song, and WORST5 is the 5th least popular song. If the given + difficulty is not available, DWI will choose the next closest difficulty. + Songs that are equally popular will be put in random order. + + RANDOM STAGE: + #SONG:*:[a]|[a..b]; + - choose a random song, with a difficulty rating equal to or between 'a' and 'b'. + - if only 'a' is given, 'b' is assumed to be the same as 'a'. + + #SONG:*:[BASIC|ANOTHER|MANIAC|SMANAIC]; + - choose a random song with a given difficulty level. + + #SONG:folder\*:[a]|[a..b]|[BASIC|ANOTHER|MANIAC|SMANIAC]; + - choose a random song from a given folder. + + DEFINED STAGE: + #SONG:<FOLDER>\<SONG TITLE>:<DIFFICULTY>; + - will use a song from <FOLDER> with the given title. + So to play a song called "My Song", which is in + './Songs/Default/mysong/mysong.dwi', on MANIAC, + you would say: + + #SONG:Default\My Song:MANIAC;+ + NB: Either the TITLE or folder the DWI file is in can be used. + +In addition, modifiers can be defined for each song by adding a list of comma-separated values to the end of the #SONG line. These modifiers are the same as listed above, plus + + xRANDOM - where 'x' is the number of random effects to apply. + 'x' can be 1 to 7. + AWARDx - where 'x' is the number of lives to award after + finishing the stage. ++ So to play "My Song", Maniac, with 2.0x, Left, Hidden, and with one random effect, use: |
Optional tags:
+ +| #REPEAT:...; | can be "YES" or "NO". If set, starts course over from the beginning after last song. |
| #COMBO:PERFECT; | during play, the combo counter will only go up if a "PERFECT" is made. |
| #COMBOMODE:1; | sets how much is added to the combo counter for jumps. Can be 1 or 2. |
| #LIVES:4; | sets the number of 'lives' given to each player at the start of game play. After each stage is cleared, a given number of lives is added, either by a value specified by the "AWARDx" tag in the CRS file, or using the scale below:
+Song was 6 feet or less - 1 life. + Song was 7 or 8 feet - 2 lives. + Song was 9 feet or more - 3 lives. + |
At the course selection screen, courses that have songs without steps for the current style (SINGLE, DOUBLE, etc) will be filtered out. Courses are loaded when DWI starts.
+ + +DWI can display lyrics during a song if it finds a .LRC file in the same folder as the step-file. The file should have the same file-base as the .DWI file - so, for example, if your DWI file is called "mysong.dwi", the lyrics file should be called "mysong.lrc".
+ +This file is a simple text-file that tells the program what text to display and when. It can also define the colour the text is displayed in.
+ +Each line starts with a tag in the format [xxxxxx]. Currently, these tags are supported:
+ +| [COLOUR] | Sets the colour for the following text. After the tag, a colour value is given in hex (ie. yellow would be 0xFFFF00). Up to 10 colour values can be given, separated by commas. |
| [offset:xxxx] | Makes timestamps following this tag have their times adjusted by 'xxxx' milliseconds. Use to fine-tune timings for lyrics. |
| [MM:SS.ss] | Sets a time. The text following the tag will be shown on the screen after this time has passed, replacing any text that was there before. To clear text, provide just a tag with no text after it. A line-break can be defined using the pipe "|" symbol. +A new colour can be selected from the defined colours by using "{cX}", where "X" is a number from 0 to 9. + |
Sample LRC file:
+[0:00.00]aye-aye-aye|aye-aye-aye|aye-aye-aye +[0:05.30]Where's my samurai? +[0:07.00] +[COLOUR]0xffff00 +[0:13.50]I've been searching for a man +[0:16.00]All across Japan. +...etc...+ + + +
Partly due to the compiler and my own lack of knowledge in some areas, there are a number of limitations +imposed on the program that users should know about:
-
+
- No more than 2048 songs. +
- No more than 64 sound effects in a single subdirectory of 'soundfx' +
If the program runs slowly on your machine, try the following:
-
+
- Install the latest DirectX 8.1 drivers. +
- Update the video drivers for your video card. +
- Try running the game in fullscreen mode, and/or setting your screen resolution to 16-bit mode. +
- Lower the sound quality to Mono, 8-bit, and/or 11 or 22Khz. +
- Lower the quality of background movies if you use them a lot. +
- Try limiting the framerate (/fps:xx). +
v2.49.00 - May 22, 2003.
+ - NEW: Addition of "Player's Best" and "Player's Worst" to CRS file format.
+ - NEW: Expanded functionality of random song selection in CRS files. You can now
+ choose a random song by difficulty (instead of just foot ratings), and also select a
+ random song in a particular folder
+ - NEW: Courses are now arranged in subfolders, allowing for different groupings of
+ courses. One set could be for nonstop, others for challenge; or you can divide the
+ courses up by mix or genre, etc. You can also give each folder its own banner, like
+ in the song select interface.
+ NOTE: You will have to move your existing courses into subfolders for them to
+ be recognized!
+ - NEW: #DISPLAYBPM:[xxx..xxx]|[xxx]|[*]; added, to force a certain display type on
+ song select screen.
+ - NEW: For users with old videocards that can't display semi-transparent images, you
+ can now turn off the dithering effect that DWI uses if you like. Use the
+ '/dither:0' command line argument.
+ - Tweaks to how #RANDFOLDER:...; behaves, plus program now searches folder DWI file
+ is in for a "Movies" sub-folder, or AVIs in the same folder first before using the
+ default /Movies/Random folder.
+ - Tweaks to banner display on Evaluation screen (for when song/course had no banner)
+ - Tweaks to record-display for courses.
+ - Tweak to beat-display in-game and in developers mode, so numbers won't 'jiggle'.
+ - BUGFIX: 'tiled images' on song-select screen (BPM, stage #, difficulty) and during
+ gameplay on some old videocards has been fixed. You should probably consider
+ upgrading to a better card though anyway. ;^)
+ - BUGFIX: Can now have up to 512 courses, instead of 64. Oops. ;)
+ - BUGFIX: "combo continuing" playing on every step past 9999 combo. BTW, I hate you. ;)
+ - BUGFIX: Game doesn't crash on entering course-select screen after you've added new
+ CRS files.
+ - OTHER: Other bugfixes and tweaks that I can't begin to remember. :P
+
+v2.41.00 - February 15, 2003.
+ - CHANGE: Drawing of text made more efficient and slightly more readable, through better
+ drawing of drop-shadows.
+ - CHANGE: textures for SVP plug-ins to draw to now adjusted to nearest multiple of 2, as I
+ suspect some assume it's supposed to be like that for efficiency reasons, and otherwise
+ might cause problems overrunning memory.
+ - BUGFIX: DWI2.log file now created properly again. (d'oh!!!)
+ - BUGFIX: problem drawing certain images in 32bpp SDL mode fixed (eg. BPM display, star-wipe)
+ - BUGFIX: extra 'N/A" box no longer appears in Solo mode "Select Profile" if started with P1.
+ - BUGFIX: Better freeing of music samples after gameplay, credits, and on song-select screen.
+
+v2.40.00 - February 2, 2003.
+ - NEW: Addition of "User Profiles", a system to keep user-specific records and high
+ scores similar to the 'name entry' system from DWI1, but with more features. Individual
+ users can tailor their own icon and (if directories are the same across systems) take
+ their records with them between machines. Now tracks personal high scores and overall
+ high scores, all viewable in the Records screen. (Can be disabled in Options menu if you
+ prefer not to use it).
+ - NEW: Arrow set for DWI completely redone to feature true colour-cycling arrows like the
+ arcade. Also, arrows are drawn in last-to-first order now instead of first-to-last.
+ (NB: Thanks to uKER for the help creating the new arrow set).
+ - NEW: You can pause the game with the "Pause/Break" key. However, like autoplay, high
+ score will not be saved.
+ - CHANGE: Folder-specific banners treated differently - now DWI looks for a PNG file with
+ the same name as the sub-folder, in the base "Songs" folder. Should be easier to
+ manage the banners all in one folder now.
+ - some freeze arrow behavior tweaked.
+ - shading on song-select wheel made less dark.
+ - more details on LRC file support added to this file.
+ - style icon colours in default skin fixed (they were reversed).
+ - if you pass a song reasonably well, you'll get that cheer as the 'Cleared' text appears.
+ - BUGFIX: strange wrapping in View Records/Nonstop mode for some songs with two lines fixed.
+ - BUGFIX: Song titles and artist names with special characters on Nonstop mode now display
+ correctly
+ - BUGFIX: Timing in Developer mode after adjusting GAP fixed. Actually tested it this time. ;)
+ - BUGFIX: Realigning the word 'Test' in developer mode.
+ - BUGFIX: /startat in developer mode is more accurrate.
+ - BUGFIX: Bonus CRS files don't 'skip' songs that are next to each other in the songlist.
+ - VARIOUS: other small tweaks I can't remember. ;)
+
+v2.30.01 - January 3, 2003.
+ - AVI and SVP decoding optimized slightly to reduce load on main game function.
+ - flag added to turn off shading on song select wheel, if desired.
+ - BUGFIX: "Game Over" back in on failing in regular mode. Oops.
+ - BUGFIX: "NEW!" status works. Expires after 2 weeks now. May require songlist reset.
+ - BUGFIX: animation thread closes properly between stages.
+ - BUGFIX: steps are judged better again. Oops x 2.
+
+v2.30.00 - January 1, 2003.
+ - NEW: Implemented Sonique Visualization Plugins (SVP) for background animations.
+ - NEW: Folder- and Genre- specific banners, plus banners for Roulette
+ and Title/Artist sort options.
+ - NEW: Sort by difficulty added to Song Select screen.
+ - NEW: Multiple colours on same line of lyrics possible.
+ - NEW: Can adjust the number of stages between breaks in Nonstop Mode.
+ - NEW: Ability to disable Background Scripts.
+ - NEW: Ability to set default sort method.
+ - New 'default' banners and backgrounds.
+ - Banner and Sample Start load time reduced.
+ - Sort by BPM now much faster.
+ - Paths in Background Scripts can now have spaces (use quotes around path).
+ - Addition to Background Script commands to use Visualizations (on Layer 0).
+ - Long song names with special characters now wrap.
+ - Options Screens reorganized to group some things better.
+ - Adjustments to GAP in Development mode handled properly if changed in DWI file.
+ - Ability to change method for drawing movies/etc. to older method (slower, but good
+ for old videocards that just give solid-colour images instead now).
+ - CRS files can take either title or directory now.
+ - Stage number/display now graphical, and colours can be assigned in skin CFG file.
+ - "TAB" can be used in song-titles to force line-wrap.
+ - Font updated to include missing '~' character.
+ - Song select wheel now has some extra shading.
+ - Support for semi-transparant images on older videocards improved by addition of
+ pattern dithering instead of simply "off" or "on".
+ - BUGFIX: Missing '0's in scores during gameplay.
+ - BUGFIX: Rounding of scores to proper multiples of 10000000 on some processors.
+ - BUGFIX: Early "GOOD" judgement on a freeze arrow + jump combination fixed.
+ - BUGFIX: "New" tag treated properly again.
+ - BUGFIX: Random AVI search assumed any file was an AVI, without checking extension.
+ - BUGFIX: Skin CFG file with Hex values in uppercase read properly now.
+
+v2.20.30 - November 30, 2002.
+ - General performance improvements.
+ - Options left-over from main game removed in demo.
+ - Command-line options added for fine-tuning memory usage (WinNT/2k/XP).
+ - Time displayed in developer mode should be correct now at different speeds.
+ - Can disable lyrics from the Options menu.
+ - BUGFIX: Genre tag correctly parsed again.
+ - BUGFIX: GeForce/Detonator drivers bug fixed.
+ - BUGFIX: Corrections to Lyric file handling (timestamps, no return after last line)
+
+v2.20.10 - November 21, 2002.
+ - Lyrics now displayed in Test mode
+ - Lyrics now enabled for songs with positive GAP values
+ - SMANIAC songs selectable in extra stages even if /showsm not used.
+ - STREAM bar glows on final tally screen if you've AAA'd all songs(!)
+ - backgrounds and banners with upper-case extensions now recognised correctly
+ - in addition to PNG files, JPGs and BMPs can be used as backgrounds.
+ - "OK" flash for Reverse-scrolling arrows added
+ - Songlist.html only written if files added/updated/deleted
+
+v2.20.00 - November 20, 2002.
+ - NEW: "Final Tally" screen added if number of stages not set to "Unlimited".
+ - NEW: Timer added to developer mode.
+ - NEW: Support for lyrics during songs added through use of "LRC" files.
+ - NEW: "/skipsearch" command line argument added.
+ - Ability to reset songlist completely from Options Menu.
+ - BUGFIX: Groove Radar values calculated correctly again.
+ - BUGFIX: "Lost life" sound playing during Arcade mode removed.
+ - BUGFIX: Sample now played when combo jumps from 99..101.
+ - BUGFIX: "Skipped" notes in autoplay fixed.
+ - BUGFIX: Stream bar glows in Evaluation Screen if full combo and combo mode set
+ to "ORIGINAL"
+ - BUGFIX: Folders with no files in them handled better when searching for files.
+
+v2.10.00 - November 12, 2002.
+ - NEW: Songlist rebuild is now automatic and time for incremental updates has been
+ dramatically reduced, as the whole song database does not get rebuilt from
+ scratch each time now. (NB: Special thanks to uKER for his code that
+ implements this).
+ - NEW: Extra stages implemented - extra stages can be defined in CRS files, or
+ random songs are chosen automatically.
+ - NEW: Extra character support in song titles, course titles, and artist names
+ now possible with new tags to DWI format.
+ - NEW: Various drop-shadow colours can be defined in the skin-configuration file.
+ - NEW: "Flash" added for "OK" on freeze-arrows.
+ - NEW: DWI now uses version 1.7 of the BASS sound library.
+ - NEW: "/dark" added for Developer mode.
+ - NEW: "+" modifier added to "#SAMPLESTART:" tag - the GAP value is used as a
+ reference.
+ - Autoplay now possible in Nonstop mode.
+ - Centre positions for combo and judgement displays adjusted.
+ - movie decoding performance improved slightly.
+ - game starts at a default of 60FPS now. Adjust with '/fps:xx' command-line.
+ - selecting difficulty on song-select screen requires discrete button presses, so
+ it won't cycle accidentally.
+ - BUGFIX: 'empty' space below song-names on Course selection screen corrected.
+ - BUGFIX: Various graphical glitches corrected.
+ - BUGFIX: 'negative percentages' in Nonstop mode fixed.
+ - BUGFIX: 'broken freeze arrows' glitch fixed.
+ - VARIOUS: various other tweaks and fixes that I can't remember. ;)
+
+v2.03.00 - September 12, 2002.
+ - NEW: 'Global GAP' adjustment added to System Options (affects all files)
+ - NEW: Ability to reset 'Player's Best" list added to Options.
+ - NEW: Rebuilding songlist also creates 'dwi2-songlist.html', for easier reference.
+ - colour for random songs in Nonstop mode brightened.
+ - switching from a song with CHALLENGE steps to one without that set reverts to HEAVY, not LIGHT.
+ - small graphical bug with freeze arrows ending cleaned up.
+ - freeze arrow graphics updated for up-left/up-right.
+ - new Nonstop course banner to replace the old ugly one. ;) (thanks, Cave)
+ - more Q/A added to FAQ.html
+ - BUGFIX: Scoring precision improved to make 'AAA'd songs add up correctly.
+ - BUGFIX: extra 'ticks' being played with "Little" mode on.
+ - BUGFIX: 'invisible' steps being played when Autoplay was on in "Little" mode.
+ - BUGFIX: jumping to a specific spot with different speeds in Developer mode corrected.
+ - BUGFIX: starting a song with "Start" in SDL mode won't automatically take you to Options screen.
+ - BUGFIX: arrows loaded correctly when switching skins again.
+
+v2.02.00 - August 16, 2002.
+ - NEW: Freeze arrows with normal steps at same time have both arrows in
+ freeze-colour.
+ - NEW: Up-left and up-right arrows in Solo mode redone to match other arrows.
+ - NEW: SOLO arrow set available in Options.
+ - NEW: Rebuilding Songlist now provides information on status
+ instead of appearing to 'freeze'.
+ - Numeric Keypad's 'ENTER' key now re-enabled.
+ - BUGFIX: Grading system fixed ('points' value correctly calculated now).
+ - BUGFIX: Problem with 'skipped' steps not registering in Nonstop mode fixed.
+ - BUGFIX: ESCAPE handled better under new keyboard method.
+ - BUGFIX: Can now exit developer mode properly.
+ - BUGFIX: problem with REVERSE and HIDDEN in CRS files fixed.
+ - BUGFIX: locking up in some DWIs with animated backgrounds fixed.
+ - BUGFIX: jumps treated correctly again.
+
+v2.01.10 - August 12, 2002.
+ - '/showsm' will show SMANIAC-only songs on the select screen, otherwise they're hidden
+ - All keys now read using DirectInput (or SDL) instead of using old Windows interfaces. So
+ problems with Escape and F1..F12 should be fixed now.
+ - BUGFIX: doubling of time in Nonstop Versus mode fixed
+ - BUGFIX: lives added properly now in Nonstop Doubles and Solo modes.
+ - BUGFIX: after rebuilding songlist, starting in Single mode should behave now.
+
+v2.01.00 - August 11, 2002.
+ - NEW: Press up-left ("sort") button on Results screen to switch to percentage-display
+ - NEW: Credits screen finally added. Thanks to all who have helped. :)
+ - NEW: Support for more than two panels at a time in a jump. (DWI specification tweaked slightly)
+ - NEW: '/v5hack' command-line argument for some strange Voodoo card drivers. Might
+ fix problems on Voodoo cards if you can't get it working right.
+ - NEW: Ability to specify number of lives added after each stage in Nonstop mode. Also changed
+ default behavior to give back lives in relation to difficulty of song just played.
+ - Groove radar values calculated better; now Chaos gives a better value, and all values are in
+ relation to the length of the song now (so extended-length songs don't give too-large values).
+ - Songs with only SMANIAC steps are now selectable in regular song-select screen.
+ - If current difficulty selected is 'bumped' when moving to a song that doesn't have that set of
+ steps, it'll go back to that setting when the next song that does is selected.
+ - Wrapping of song-titles tweaked to wrap on " -", not just "-".
+ - Power bar 'sliding' behavior tweaked.
+ - In Options Menu, currently-selected item is remembered when returning from sub-menus.
+ - Maximum number of songs allowed upped to 2048.
+ - BUGFIX: going to course-select screen after rebuilding songlist should work correctly now.
+ - BUGFIX: starting a song with 'start' on a gamepad won't take you to the options screen unless
+ you hold it now.
+ - BUGFIX: 'beat' counter behavior fixed for when a BPM-pause/freeze occurs.
+ - BUGFIX: animations should behave now when speed is altered.
+
+v2.00.52 - I released the DirectInput implementation too soon, sorry. This should solve the
+ issues with DX mode in some operating systems, and SDL mode.
+
+v2.00.5 - August 2, 2002.
+ - I now have WindowsXP... yay... so now I can test DWI in it...
+ - 'white flashes' during video playback fixed.
+ - grading system (rounding) bug fixed... (I think...).
+ - keyboard input now uses DirectInput for most things, instead of Windows functions -
+ should hopefully be faster and avoid some lag problems some have been experiencing.
+ - second set of keyboard inputs can be configured now.
+ - can't change sort method after choosing "ROULETTE" anymore.
+
+v2.00.3 - July 25, 2002.
+ - fixes a number of graphical problems related to songs with positive GAP values.
+ - groove radar calculations now a bit more tolerant of mistakes in files.
+ - .75x and .5x modifiers corrected in Options screen.
+ - Stealth now selectable through both methods.
+ - New freeze arrow 'flash' animation as earlier version was getting mixed reviews. ;)
+ - fixed Roulette when "Sort by Genre" is used.
+ - Difficulty tweaked slightly.
+ - Failure of stage behaves properly again.
+
+ - IMPORTANT - I meant to do this with the first release of 2.00, but forgot -
+ DWI2's configuration is stored in 'dwi2.cfg', 'dwi2.sng', 'dwi2.rec', etc.
+ IF YOU HAVE BEEN RUNNING v2.00, PLEASE RENAME 'dance.*' 'dwi2.*'.
+ Sorry for the inconvenience.
+
+v2.00.0 - July 22, 2002.
+ - Completely overhauled DWI's interface. The 'brushed metal' look is out in favor
+ of a new, more colourful design
+ - New, more readable and stylish font
+ - optional timer on gameplay screens to hurry things up
+ - hold 'START' when selecting a song to open up a new 'select options' screen
+ ('SELECT' will still let you change options as before also).
+ - DWI2 has removed old interfaces that I feel are outdated and in the process makes
+ it much easier to update. At the same time, the base skin has been updated
+ considerably. (NB: old skins will not be recognized, sorry...)
+ - Nonstop Mode now keeps track of time, percent, etc.
+ - MAX2 scoring and grading system
+ - Smooth animations for judgements, combo display
+ - New animation for song start/end
+ - Groove Radar implemented (values calculated when Songlist is rebuilt)
+ - Roulette added to song-select screen
+ - 5th/MAX-style power bars and gameplay interfaces, freeze arrows, etc.
+ - completely redone evaluation screen
+ - usernames taken out - they were a pain to put in anyway
+ - Song banners now used on song-select screen if available. Can be horizontal or
+ old diagonal-style (backgrounds used as before if no banner found)
+ - Records screen now keeps track of Nonstop records too
+ - new option '/fps:xx' lets you set a maximum framerate (20..100); saves processor
+ time for other applications if you've got a fast machine
+ - multiple bugs fixed.
+
+SPECIAL NOTE: DWI 2.0's skins require a file called 'dwi2-skin.cfg' to work. This is done
+ to avoid accidentally choosing an old skin.
+ The Sounds folder is very similar, but with new samples for some things. Users
+ upgrading from 1.7 and lower should run 'convert.bat', which does the following:
+ 1) copy all files from \eval\S to \eval\SS
+ 2) rename \eval\SS \eval\AA
+ 3) rename \eval\SSS \eval\AAA
+ 4) remove \eval\S
+ 5) move all files from \select\song to \start\ready
+ 6) remove \select\song. (You can also delete \select\new)
+
+v1.70.0 - June 17, 2002.
+ - New method for creating Nonstop Mode courses - introduction of "CRS" file format.
+ This should allow for easier creation of Nonstop Mode courses. See below for details.
+ - Removed all old Nonstop-mode sections.
+ - New Nonstop Course selection screen. Banners can be given to a course. Also allows for
+ playing defined courses in different modes.
+ - Two people can play Nonstop mode courses at the same time.
+ - Better record keeping for Nonstop mode courses.
+ - Style Select Screen modified. SOLO mode is now selected by pressing up/down there.
+ - New "Failed" sequence - arrows stop and fade out now instead of still scrolling.
+ - Freeze arrow behavior tweaked.
+ - Combo system can be chosen in Options Screen.
+ - New command line argument "/sdevice:x" can tell DWI what sound device to use.
+ (view dance.log to see a listing of available devices first).
+
+v1.65.5 - June 7, 2002.
+ - Added sound effect for when you lose a life in Nonstop "Combo" mode.
+ - Updated freeze arrows to behave more like MAX.
+ - Freeze-arrows don't do as much damage as they used to. ;)
+ - MAX-like combo system.
+
+v1.65.0 - May 26, 2002.
+ - Added random background animations. Put looping AVIs into ./Movies/Random
+ and DWI will use them automatically in the backgrounds for songs with
+ no background script.
+ - Random animations can be enabled/disabled in the System Options.
+ - Addition of four new tags to DWI files:
+ #RANDSEED:x; - provide a number that will influence what AVIs DWI picks.
+ Will be the same animation each time if AVI filenames and count
+ doesn't change (default is random each time).
+ #RANDSTART:x; - tells DWI what beat to start the animations on. Default is 32.
+ #RANDFOLDER:...; - tells DWI to look in another folder when choosing AVIs,
+ allowing 'themed' folders.
+ #RANDLIST:...; - a list of comma-separated filenames to use in the folder.
+
+ - Ability to tweak timings for judging Perfect, Great, etc. steps in System Options.
+ - New "Select Style" interface added (default now for "DWI (Second Interface)" skin).
+ Use "SelectStyle=2" under "[GENERAL]" in the 'dwi-skin.cfg' file to enable.
+ - Crowd cheers or moans during gameplay based on performance.
+ - Music loop added to "Select Style" screens.
+ - Routine for displaying background animations put into separate thread now.
+ - New command-line argument: '/priority:x' can force DWI to run as a more "important"
+ program under Windows. "1" starts it as "ABOVE NORMAL", "2" is "TIME CRITICAL". May
+ improve performance in certain cases.
+ - BUGFIX: Selecting an SMANIAC song after a previous one in 1st Interface fixed.
+ - Other various bugfixes that I can't remember. ;)
+
+v1.62.3 - May 6, 2002.
+ - Minor bug fixes. Main change is a tweak to the /test: command line arguments to
+ accommodate folders on other drives to faciliate step-file creator authors.
+
+v1.62.2 - April 18, 2002.
+ - Speed of song can now be set to faster than normal play using F3/F4 during gameplay or
+ at song select screen (1..5..9).
+ - bug fix: BPM shift won't reset background animation.
+ - bug fix: GAP adjustment should behave better now.
+ - More developer functions added:
+ /startat:
+
+9. FUTURE DEVELOPMENT AND THANKS
+ +A long time was spent making this program, and I believe that this first release is fairly complete in terms of features. New features will be considered as resources and interest permit.
+ +Special thanks go to DjDraftHorse for the announcer files - I think he did a fantastic job, very professional. Also he has been a great beta-tester and a sounding board for new ideas. Much appreciated!
+ +Also, a huge 'thank you' to BemaniRuler for beta-testing the program and your enthusiasm for the project. He's been a great help in creating the new interfaces and I appreciate him letting me incorporate some of his graphics from his earlier skins in the release of DWI 2.0.
+ +Thanks also to Durikkan for his help in implementing the Groove Radar - the values used are based off of his algorithm.
+ +BBW, for putting up with my incessant programming of the simulator and my exhorting of the joys of Bemani. ;)
+ +LagGed and the others at "The Melting Pot" for the resources available there concerning the file formats and other simulators, and his offer to host the distribution files. uKER for taking it upon himself to write some better code for song-management which I was able to implement into the main DWI code. YrevaTeneb for his writeup on how to create DWI files at the Melting Pot, and for permission to list it here. Also a special thanks to Apocalypse for his insight in getting DirectX working.
+ +Pawwaves to those in the furry community. :^)
+ +Enjoy...
+SimWolf.
+
+
+
The Manual
++ + +
+ +
Introduction
+This is the basic player manual. We should also link to the Beginner's Guide and +Themer's Guide from here as well.
+ ++ +
Welcome to sm-ssc
+ +System Requirements +
sm-ssc can run on this bare minimum:
+-
+
- Operating System(s):
+
-
+
- Windows (2000, XP, Vista, Windows 7) +
- Mac OS X (10.?) +
- *NIX/POSIX-compliant OS (GNU/Linux, *BSD) +
- Microsoft Xbox +
+
However, we highly recommend at least these settings for decent performance:
+ +Installation +
If you're reading this, you've likely already figured out how to install sm-ssc. +Just in case you're reading this without having installed it yourself, however, +here are the installation instructions for various operating systems.
+ +Windows
+I hate Vista and Windows 7
+ +Mac OS X
+I hate Steve Jobs and hipsters
+ +Linux
+I hate dhdarka and people who complain about binary blob drivers
++