DivaScript

2025-12-09T15:10:12Z

2400:CB00:27:1000:E907:45B7:43AF:2768: /* List of DSC Commands (Incomplete) */

''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 <code>.dsc</code> 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, <code>.dsc</code> 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 <code>.dsc</code> file is determined by the first 4 bytes of the file.
{| class="wikitable"
|}

== 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.
{| class="wikitable sortable"
|+
!Command Name
!Definition
!Parameter
!Description
!Type
|-
| rowspan="6" |
<h6>AGEAGE_CTRL</h6>
| rowspan="6" |Controls the effect for the hair of the module "AgeAge Again".
FT: <code>AGEAGE_CTRL(chara, parts, npr, rot_speed, skip, disp, -1, -1);</code>
|chara
|Character slot
|int
|-
|parts
|Hair parts to control:
<code>0</code>: both

<code>1</code>: left

<code>2</code>: right
|enum
|-
|npr
|sets NPR material
|bool
|-
|speed
|Effect speed
|int
|-
|skip
|Skips 200 frames of animation.
|bool
|-
|disp
|Whether to display the effect or not.
|bool
|-
| rowspan="2" |
<h6>BAR_TIME_SET</h6>
| rowspan="2" |Sets the length of a measure.
<code>BAR_TIME_SET(bpm, beats);</code>
|bpm
|Beats per minute
|int
|-
|beats
|Number of quarter note beats minus 1. eg: <code>3</code> for 4/4.
|int
|-
| rowspan="2" |
<h6>BLOOM</h6>
| rowspan="2" |Sets data from <code>bloom</code> pv_param.
FT, F2, X: <code>BLOOM(id, unk);</code>
|id
|ID matching the data in pv_param.
|int
|-
|unk
|Unknown
|int
|-
|
<h6>CHANGE_FIELD</h6>
|Changes the field defined in <code>pv_field</code>/<code>pv_db</code>.
<code>CHANGE_FIELD(id);</code>

F2, X: <code>CHANGE_FIELD(id, unk);</code>
|id
|ID matching the field number in <code>pv_field</code> or <code>pv_db</code>.
|int
|-
| rowspan="2" |
<h6>CHARA_SIZE</h6>
| rowspan="2" |Sets a character's scale/size.
<code>CHARA_SIZE(chara, size);</code>
|chara
|Character slot
|int
|-
|size
|Character scale
|int
|-
|
<h6>END</h6>
|Ends reading of the script.
<code>END();</code>
| colspan="3" |
|-
|
====== EDIT_BLUSH ======
|Sets a character's facial effect
<code>EDIT_BLUSH(id);</code>
|id
|Character facial effect
|int
|-
| rowspan="3" |
<h6>HAND_SCALE</h6>
| rowspan="3" |Sets the size of a character's hand.
FT: <code>HAND_SCALE(chara, hand, scale);</code>
|chara
|Character slot
|int
|-
|hand
|Which hand to scale:
<code>1</code>: left

<code>2</code>: right
|enum
|-
|scale
|Hand scale in percentage times 10; eg. for <code>105%</code> use <code>1050</code>
|int
|-
| rowspan="2" |
<h6>LYRIC</h6>
| rowspan="2" |Displays a lyric from <code>pv_db</code>.
<code>LYRIC(id, color);</code>
|id
|ID matching the number of a lyric in <code>pv_db</code>.
Use <code>-1</code> as "disable".
|int
|-
|color
|<code>#AARRGGBB</code> hex color code converted to decimal.
eg.: for a red lyric the command would be <code>LYRIC(id, 16711680);</code>

because Red: <code>#00FF0000</code> → <code>0x00ff0000</code> → <code>16711680</code>

Default: <code>-1</code>
|int
|-
| rowspan="2" |
<h6>MIKU_DISP</h6>
| rowspan="2" |Shows or hides a character in a PV.
<code>MIKU_DISP(chara, disp);</code>
|chara
|Character slot
|int
|-
|disp
|Whether to display the character or not.
|bool
|-
| rowspan="4" |
<h6>MIKU_MOVE</h6>
| rowspan="4" |Moves a character in 3D space in a PV.
<code>MIKU_MOVE(chara, x, y, z);</code>
|chara
|Character slot
|int
|-
|x
|X coordinate
|int
|-
|y
|Y coordinate
|int
|-
|z
|Z coordinate
|int
|-
| rowspan="2" |
<h6>MIKU_ROT</h6>
| rowspan="2" |Rotates a character in a PV.
<code>MIKU_ROT(chara, angle);</code>
|chara
|Character slot
|int
|-
|angle
|Angle value
|int
|-
| rowspan="2" |
<h6>MIKU_SHADOW</h6>
| rowspan="2" |Shows or hides a character's shadow in a PV.
<code>MIKU_SHADOW(chara, disp);</code>
|chara
|Character slot
|int
|-
|disp
|Whether to display the character's shadow or not.
|bool
|-
| rowspan="2" |
<h6>MODE_SELECT</h6>
| rowspan="2" |Starts or ends a special chart segment, such as Chance Time.
<code>MODE_SELECT(difficulty, mode);</code>
|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:

<code>1</code> - Easy

<code>2</code> - Normal

<code>4</code> - Hard

<code>8</code> - Extreme

<code>16</code> - Encore

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).
|bitfield enum
|-
|mode
|What segment to start/end:
<code>1</code> - Challenge Time (Arcade games) / Chance Time (Console games) Start

<code>3</code> - Challenge Time (Arcade games) / Chance Time (Console games) End

<code>8</code> - Technical Zone Start

<code>9</code> - Technical Zone End

Only used by the [https://divamodarchive.com/post/169 New Classics mod]:

<code>4</code> - Chance Time Start

<code>5</code> - Chance Time End
|enum
|-
| rowspan="2" |
<h6>MOVIE_CUT_CHG</h6>
| rowspan="2" |Plays, shows or hides the movie defined in <code>pv_db</code> or a movie from <code>movie_list</code> in <code>pv_db</code>. It can be used as a fancier version of both <code>MOVIE_DISP</code> and <code>MOVIE_PLAY</code> that allows more control.
FT: <code>MOVIE_CUT_CHG(id, disp);</code>
|id
|The number in <code>movie_list</code> of the movie to be played.
Playback starts at the moment the command is called for a newly called <code>movie_list</code> item. Re-calling a movie again doesn't play it from the starting position.
|int
|-
|disp
|<code>1</code> - display the movie layer
Any other value - hide the movie layer (playback keeps going)
|bool
|-
|
<h6>MOVIE_DISP</h6>
|Shows or hides the movie layer in a PV.
<code>MOVIE_DISP(disp);</code>
|disp
|<code>1</code> - display the movie layer
Any other value - hide the movie layer (playback keeps going)
|bool
|-
|
<h6>MOVIE_PLAY</h6>
|Starts playing the movie defined in <code>pv_db</code> or the first movie in <code>movie_list</code> in <code>pv_db</code>.
<code>MOVIE_PLAY(play);</code>
|play
|<code>1</code> - plays the movie
Any other value doesn't do anything.
|bool
|-
|
<h6>MUSIC_PLAY</h6>
|Starts playing the song file defined in <code>pv_db</code>.
<code>MUSIC_PLAY();</code>
| colspan="3" |
|-
|
<h6>PV_BRANCH_MODE</h6>
|Make future DSC commands only be executed on either the <code>Global</code>, <code>Fail</code> or <code>Success</code> branch.
FT, F, F2, X: <code>PV_BRANCH_MODE(branch);</code>
|branch
|<code>0</code> - Global (commands are executed regardless of success state)
<code>1</code> - Fail (commands are executed only if the PV is in the 'failed' state)

<code>2</code> - Success (commands are executed only if the PV is in the 'success' state)
|enum
|-
|
<h6>PV_END</h6>
|Ends PV playback.
<code>PV_END();</code>
| colspan="3" |
|-
|
<h6>SATURATE</h6>
|Changes color saturation in a PV.
<code>SATURATE(amount);</code>
|amount
|Saturation strength on a scale from 0 to 1000:
<code>0</code> - No color, perfect grayscale

<code>1000</code> - Regular colors
|int
|-
| rowspan="6" |
<h6>SCENE_FADE</h6>
| rowspan="6" |Plays a screen fade effect during PVs.
<code>SCENE_FADE(duration, start, end, r, g, b)</code>
|duration
|Fade duration in milliseconds
eg:

<code>1000</code>: 1 second

<code>800</code>: 0.8 seconds
|int
|-
|start
|The opacity the fade will start with
<code>0</code>: fully transparent

<code>1000</code>: fully opaque
|int
|-
|end
|The opacity the fade will end with
<code>0</code>: fully transparent

<code>1000</code>: fully opaque
|int
|-
|r
|Red color component scale, from 0 to 1000
|int
|-
|g
|Green color component scale, from 0 to 1000
|int
|-
|b
|Blue color component scale, from 0 to 1000
|int
|-
|
<h6>SE_EFFECT</h6>
|Plays a sound effect in a PV defined in <code>pv_db</code>. Normally used for success scenes but not restricted to them.
FT, F, F2, X: <code>SE_EFFECT(id);</code>
|id
|number of a <code>effect_se_name_list</code> item defined in <code>pv_db</code>.
|int
|-
| rowspan="12" |
<h6>TARGET</h6>
| rowspan="12" |Spawns a rhythm game note.
FT: <code>TARGET(type, pos_x, pos_y, angle, dist, amp, freq);</code>

F: <code>TARGET(type, duration, is_end, pos_x, pos_y, angle, freq, dist, amp, fly_time, sig);</code>

F2, X: <code>TARGET(type, duration, is_end, pos_x, pos_y, angle, freq, dist, amp, fly_time, sig, hit_eff);</code>
|type
|ID corresponding to a note type.
Full ID list for each game on the dedicated [[Target]] page.
|enum
|-
|pos_x
|X position of the note's target.
|int
|-
|pos_y
|Y position of the note's target.
|int
|-
|angle
|Angle of the note's path.
|int
|-
|distance
|Distance between the note's spawn position and the target's position.
Default: <code>300000</code>
|int
|-
|amp
|Amplitude of the note's path wave.
Default: <code>500</code>
|int
|-
|freq
|Frequency of the note's path wave.
|int
|-
|duration
|(for F/F2/X formats)
Sustain and Rush Note duration.
Default (for notes other than Sustain and Rush): <code>-1</code>
|DivaTime
|-
|is_end
|(for F/F2/X formats)
set to <code>1</code> for Sustain 'end' notes, otherwise set to <code>-1</code>
|bool
|-
|fly_time
|(for F/F2/X formats)
Target Flying Time value (same format as the TARGET_FLYING_TIME command)
|DivaTime
|-
|sig
|(for F/F2/X formats)
Time Signature

The same value that would otherwise go in <code>BAR_TIME_SET</code>:

Number of quarter note beats minus 1. eg: <code>3</code> for 4/4.
|int
|-
|hit_eff
|(for F2/X formats)
Assigns a hit effect to the note based on a local ID defined in a previous TARGET_EFFECT command.
|int
|-
|
<h6>TARGET_FLYING_TIME</h6>
|Sets the time it takes for the rhythm game notes to hit their targets.
<code>TARGET_FLYING_TIME(flytime);</code>
|flytime
|time value in milliseconds
|int
|-
|
<h6>TIME</h6>
|Waits until a specified game time.
<code>TIME(t);</code>
|t
|time value in DivaTime
|DivaTime
|}

= References =
somewhatlurker's [https://github.com/somewhatlurker/pydiva/blob/dsc/pydiva/pydsc_op_db.py pyDIVA/pyDSC]

DivaDocs - User contributions [en]

DivaScript