Creating your own scripts

Previous  Top  Next

Scripts are normal windows ini-files and use the standard ini structure.

So here is not a manual for creating in-files, but the manual about the sections and fields of RPG-SoundMixer scripts. For a concrete example you can study the SoundMixer demo/tutorial-script. You will find it in the "scripts" folder.

Sections and fields:

Note: Parameters are in enclosed in *

Note: For the correct key code, look at this table (q.v. )

[General]
general settings

Version = 1610

version of script

File = "*filename*"

name of the sound-library, which is opened at the beginning of the script (file has to be placed in the library path)

Delay = *duration in milliseconds*

delay, which is used in the text sections for text delay (indicates the time after which an additional text is displayed and then it is possible to continue by key stroke)

FirstStep = *section number*

section number: the script starts at this section

HideInfos = 1

if set, the display of the RPG-SoundMixer main window will be invisible

[General design]
general settings, which concern visualization

PositionType = "absolute" *or* "relative"

the following positioning values can be absolute or relative (to the RPGSM main window)

PositionX = *x position in pixel*

vertical position of the script window

PositionY = *y position in pixel*

horizontal position of the script window

SizeX = *x size in pixel*

vertical size of the script window

SizeY = *y size in pixel*

horizontal size of the script window

BackColor = *color*

background color

ColorHeadline = *color*

color for headlines

ColorText = *color*

color for normal text

ColorTextColored = *color*

color for text with an alternative color

ColorHyperlink = *color*

color for hyperlinks

[Step*section number*]
section number: 1 - number of steps (marks the sections)

DelayAuto = *duration in milliseconds*

delay, which is used to continue the script's automatic execution (also automatic keys)

Layout = "*layout name*"

If you want to change the layout picture, the script uses this value (layout name without the ".jpg" extension)

Headline = "*headline*"

text for the headline

Text*text number* = "*text*"

text number: 1 - number of paragraph text: text, which is printed out

TextHyper*text number* = 1

if set, the specified text (text number) is treated as a hyperlink (optional)

TextColored*text number* = 1

if set, the specified text (text number) has an alternate color (optional)

TextDelay*text number* = 1

if set, the specified text (text number) is displayed after the delay (DelayText) (optional)

Key*key number* = *key code*

key number: 1 - number of allowed keys the key codes define, which keys are allowed to be pressed in this section (Keys not mentioned will no longer have any effect! However, keys for volume adjustment, track and section controlling are always allowed!)

KeyStep*key number* = *section number*

if set, the specified key (key number) is used to jump to another section (section number)

if the section number is set to -2, the script will be stopped

if the section number is set to -1, the script will jump to the section, which was executed before the current section (history back)

KeyAuto*auto key number* = *key code*

auto key number: 1 - number of automated keys the enumerated keys (key code) will be "pressed" after the delay period (DelayAuto) by RPG-SoundMixer automatically

AutoContinue = *section number*

if set, RPG-SoundMixer will jump to the section (section number) automatically after the expiration of the delay (DelayAuto)

Mode = *mode number*

mode number: 0 - 9 (the SoundMixer will change to this mode automatically); (optional - if not set, no changes will be accomplished)

LocationMode = *location mode number*

location mode number: 0 (Off) - 12 (dream) (the SoundMixer will change to this mode automatically); (optional - if not set, no changes will be accomplished)

VolMode = *volume mode number*

volume mode number: 0 (loud) - 2 (quiet) (the SoundMixer will change to this mode automatically); (optional - if not set, no changes will be accomplished)

TotalVol = *main volume*

0 - 65535 (the SoundMixer will change the specified volume automatically); (optional - if not set, no changes will be accomplished)

SoundVol = *sound volume*

-10000 - 0 (the SoundMixer will change the specified volume automatically); (optional - if not set, no changes will be accomplished)

MusicVol = *music volume*

0 - 65535 (the SoundMixer will change the specified volume automatically); (optional - if not set, no changes will be accomplished)