DivaScript: Difference between revisions

From DivaDocs
GGAB3 (talk | contribs)
m added MIKU_ROT, MIKU_DISP, MIKU_MOVE, MIKU_SHADOW, MOVIE_ commands. Improved some descriptions.
GGAB3 (talk | contribs)
m Improved formatting
Line 301: Line 301:
|Indicates under what difficulties the command will trigger in this exact script.
|Indicates under what difficulties the command will trigger in this exact script.
This value is a bit flag corresponding to a group of difficulties:
This value is a bit flag corresponding to a group of difficulties:
<code>1</code> - Easy
<code>1</code> - Easy
<code>2</code> - Normal
<code>2</code> - Normal
<code>4</code> - Hard
<code>4</code> - Hard
<code>8</code> - Extreme
<code>8</code> - Extreme
<code>16</code> - Encore
<code>16</code> - Encore
Adding the values up to each other results in a group: <code>6</code>:Hard(4) and Normal (2).
Adding the values up to each other results in a group: <code>6</code>:Hard(4) and Normal (2).
Use <code>31</code> as a universal value (works on any difficulty).
Use <code>31</code> as a universal value (works on any difficulty).
|True
|True

Revision as of 10:54, 27 September 2025

DivaScript (commonly referred to as DSC) is the file format used by all the Project DIVA games for storing various commands related to Music Videos/PVs and Rhythm Game Charts.

The data inside .dsc files is stored in a binary format. This means that they can not be edited with a text editor and instead require specialized programs that can decode them such as DSC Studio or ScriptEditor. Additionally, .dsc files from Project DIVA F2nd and Project DIVA X are encrypted using DIVAFILE encryption. They need to be decrypted before editing.

DSC Formats

Every Project DIVA game uses a specific DivaScript format. The exact format of a .dsc file is determined by the first 4 bytes of the file.

List of DSC Commands (Incomplete)

List of commands that can be used in FT, F, F2/X DSC formats. Format-exclusive commands are marked individually.

AGEAGE_CTRL

Controls the effect for the hair of the module "AgeAge Again".

AFT: AGEAGE_CTRL(chara, side, unk1, scale, unk2, unk3, -1, -1);

Parameter Description Required Type
chara Character slot True int
side Side to control True enum:

0: both 1: left 2: right

unk1 Unknown True int
scale Effect scale True int
unk2 Unknown False int
unk3 Unknown True int

BAR_TIME_SET

Sets the length of a measure.

BAR_TIME_SET(bpm, beats);

Parameter Description Required Type
bpm Beats per minute True int
beats Number of quarter note beats minus 1. eg.: 3 for 4/4. True int

BLOOM

Sets data from bloom pv_param.

AFT, F2, X: BLOOM(id, unk);

Parameter Description Required Type
id ID matching the data in pv_param. True int
unk Unknown True int

CHANGE_FIELD

Changes the field defined in pv_field/pv_db.

CHANGE_FIELD(id);

Parameter Description Required Type
id ID matching the field number in pv_field or pv_db. True int

F2, X: CHANGE_FIELD(id, unk);

CHARA_SIZE

Sets a character's scale/size.

CHARA_SIZE(chara, size);

Parameter Description Required Type
chara Character slot True int
size Character scale True int

END

Ends reading of the script.

END();

HAND_SCALE

Set the size of a character's hand.

AFT: HAND_SCALE(chara, hand, scale);

Parameter Description Required Type
chara Character slot True int
hand Which hand True enum:

1: left 2: right

scale Hand scale in percentage times 10; eg. for 105% use 1050 True int

LYRIC

Displays a lyric from pv_db.

LYRIC(id, color);

Parameter Description Required Type
id ID matching the number of a lyric in pv_db.

Use -1 as "disable".

True int
color #AARRGGBB hex color code converted to decimal.

eg.: for a red lyric the command would be LYRIC(id, 16711680); because Red: #00FF00000x00ff000016711680

Default: -1

False int

MIKU_DISP

Show or hide a character in a PV.

MIKU_DISP(chara, disp);

Parameter Description Required Type
chara Character slot True int
disp Whether to display the character or not. True bool

MIKU_MOVE

Moves a character in 3D space in a PV.

MIKU_MOVE(chara, x, y, z);

Parameter Description Required Type
chara Character slot True int
x X coordinate True int
y Y coordinate True int
z Z coordinate True int

MIKU_ROT

Rotates a character in a PV.

MIKU_ROT(chara, angle);

Parameter Description Required Type
chara Character slot True int
angle Angle value True int

MIKU_SHADOW

Show or hide a character's shadow in a PV.

MIKU_SHADOW(chara, disp);

Parameter Description Required Type
chara Character slot True int
disp Whether to display the character's shadow or not. True bool

MODE_SELECT

Starts or ends a special chart segment, such as Chance Time.

MODE_SELECT(difficulty, mode);

Parameter Description Required Type
difficulty Indicates under what difficulties the command will trigger in this exact script.

This value is a bit flag corresponding to a group of difficulties:

1 - Easy

2 - Normal

4 - Hard

8 - Extreme

16 - Encore

Adding the values up to each other results in a group: 6:Hard(4) and Normal (2).

Use 31 as a universal value (works on any difficulty).

True bitfield enum
mode What segment to start/end:

1 - Challenge Time (Arcade games) / Chance Time (Console games) Start 3 - Challenge Time (Arcade games) / Chance Time (Console games) End 8 - Technical Zone Start 9 - Technical Zone End Only used by the New Classics mod: 4 - Chance Time Start 5 - Chance Time End

True enum

MOVIE_CUT_CHG

Play, show or hide the movie defined in pv_db or a movie from movie.list in pv_db. It can be used as a fancier version of both MOVIE_DISP and MOVIE_PLAY that allows more control.

AFT: MOVIE_CUT_CHG(id, disp);

Parameter Description Required Type
id The number in movie.list of the movie to be played.

Playback starts at the moment the command is called for a newly called movie.list item. Re-calling a movie again doesn't play it from the starting position.

True int
disp 1 - display the movie layer

Any other value - hide the movie layer (playback keeps going)

True bool

MOVIE_DISP

Show or hide the movie layer in a PV.

MOVIE_DISP(disp);

Parameter Description Required Type
disp 1 - display the movie layer

Any other value - hide the movie layer (playback keeps going)

True bool

MOVIE_PLAY

Start playing the movie defined in pv_db or the first movie in movie.list in pv_db.

MOVIE_PLAY(play);

Parameter Description Required Type
play 1 - plays the movie

Any other value doesn't do anything.

True bool

MUSIC_PLAY

Starts playing the song file defined in pv_db.

MUSIC_PLAY();

SCENE_FADE

Plays a screen fade effect during PVs.

SCENE_FADE(speed, start, end, r, g, b)

Parameter Description Required Type
speed Fade duration in seconds

eg: 1000: 1 second 800: 0.8 seconds

True int
start The opacity the fade will start with

0: fully transparent

1000: fully opaque

True int
end The opacity the fade will end with

0: fully transparent

1000: fully opaque

True int
r Red color component scale, from 0 to 1000 True int
g Green color component scale, from 0 to 1000 True int
b Blue color component scale, from 0 to 1000 True int