Create a Cue from Cue creation information CSV is a function to create a Cue from a simple CSV.
Reads the CSV containing Cue creation information and creates a Cue.

Advantages of creating from CSV

When creating a large number of Cue sheets that play different materials but have the same parameters and structure, You can use the CSV as a template.
Materials can be replaced by loading the CSV into Excel or a text editor and replacing the materials.

The CSV data that will be the source of the Cue can be created outside of CRI Atom Craft.
This makes it easier to divide up the work.
Please make any final adjustments to the Cue on CRI Atom Craft.

Operation flow

Start CRI Atom Craft
Open project
Register materials (e.g. drop a folder containing waveforms into the material root)
Prepare the destination Cue sheet
Open the Cue creation information CSV
Right-click on the Cue sheet and select "Create a Cue from the Cue creation information CSV" menu.
(The materials specified in this CSV file must be prepared in advance at the time of (3.).)
Cue is added

Open Cue creation information CSV by drag and drop

Load Cue sheets while creating them
When you drop a CSV file in the "Cue Creation CSV Format" into the Cue Sheet folder in the Work Unit Tree, a Cue sheet will be created with the CSV file name.

Input/Output

Input: Text file (extended CSV format)
Output: Cue

Text formatting

Basics

The basic specification method is as follows:

Input csv

0.gun1.wav, Gunshot

1.bomb1.wav, explosion

result

Cue ID	Cue Name
0	gun1
1	bomb1

Please specify the items in the following order: Cue ID, Material name, Text. You can create one Cue per line.

The "Text" section is optional. The text is available to extensions, described below.

Specify multiple waveforms in one Cue

If the same Cue ID is specified consecutively, they will be combined into one Cue. The Cue name in this case will be the first one.

Input csv

0,footstep1.wav
0,footstep2.wav
0,footstep3.wav

result

Cue ID	Cue Name
0	footstep1

About Cue names

The Cue name will be the specified material name minus the extension (including the period).

About CSV delimiters

In the Cue creation information CSV, commas and tabs are treated as delimiters. However, please note that spaces are treated as normal characters.

Comment writing

A line beginning with "//" is recognized as a comment.
If multiple people are sharing a CSV file, you can write comments for other members.
Comment lines are generally ignored.

// This line is a comment. The three below are created as the same Cue"footstep1".
#CopyTextTo CueComment
0,footstep1.wav,Footstep 1
0,footstep2.wav,Footstep 2
0,footstep3.wav,Footstep 3
1,cancel.wav, system cancel sound
2,ok.wav, system decision sound

result

Cue ID	Cue Name	Comment
0	footstep1	footstep3
1	cancel	System cancel sound
2	ok	System decision sound

About the text

A line beginning with "#" is recognized as an extended command.
The extended command allows you to write text into a specified field (Cue comment or user data).
If the Cue names are the same, the one specified later will be overwritten.

Extended Commands	Actions
#CopyTextTo CueComment	Write text to a Cue comment
#CopyTextTo UserData	Write text to user data

If the text is blank, no processing will be performed.
However, if you specify "UseBlank", you can write empty strings to Cue comments and user data.

Extended Commands	Actions
#CopyTextTo CueComment UseBlank	Write text to Cue comment. If text is blank, write blank text
#CopyTextTo UserData UseBlank	Write text to user data. If text is blank, write blank characters

sample

#MaterialPath voice/
//===================================================
// CSV format test
//===================================================
#CopyTextTo CueComment
1, TEST_01_A.wav, this will be overwritten
1, TEST_01_B.wav, as Cue comment
#CopyTextTo UserData
2, TEST_02_C.wav, as user data 1
3, TEST_03_D.wav, as user data 2
4, sin.wav, this is a sine wave
#CopyTextTo CueComment UseBlank
5, TEST_05_E.wav, overwritten with blank
5, TEST_05_E.wav,

result

Cue ID	Cue Name	Comments	User Data
1	TEST_01_A	as Cue comment
2	TEST_02_C		as user data 1
3	TEST_03_D		as user data 2
4	sin		This is a sine wave
5	TEST_05_E

Refer to the initial value when adding

Refer to "Initial value settings" in "Tool settings".

Extended commands

Lines beginning with "#" in CSV are recognized as extended commands. Extended commands include the following, including text processing.

Item	Contents	Description
#CopyTextTo CueComment	Copies the text item in the CSV to the Cue comment field.	This is also the default behavior if no extended command is specified.
#CopyTextTo CueComment UseBlank	If the CSV text field is blank, copy the blank text to the Cue comment field.	It is possible to overwrite it with blanks when there are multiple tracks.
#CopyTextTo UserData	Copies a text item from the CSV to the Cue's user data field.
#CopyTextTo UserData UseBlank	Copies the CSV text item to the Cue 's user data field.	Allows overwriting with blanks when there are multiple tracks.
#MaterialPath	Specify the path of the material.	Example: #MaterialPath system/

Item	Contents	How to specify columns
#GenerateCueNameBy MaterialName	Generates a Cue with the material name minus the extension as the Cue name. This is also the default behavior if no extension command is specified.	Specify the columns as " Cue ID, material name, text". Example: 0,gun1.wav,gunshot The Cue name will be "gun1".
#GenerateCueNameBy CueID	Generate a Cue with the Cue name " Cue%d (%d is the Cue ID number)".	Specify the columns as " Cue ID, Material name, Text". Example: 0, gun1.wav, Gunshot The Cue name will be "Cue0".
#GenerateCueNameBy CueName	Generate a Cue with the specified Cue name.	Specify the columns as " Cue name, material name, text". Example: gun, gun1.wav, gunshot The Cue name will be "gun".

Item	Contents
#SeqType	Sets the sequence type to the specified one. For details, see the "About #SeqType" section below.

Column formatting details

The details of each column in the CSV are as follows:

Item	Description	Details
Cue name	Cue name	When the CueName extension command is specified, the string specified here will be used as the Cue name. If multiple columns have the same name, they will be grouped into the same Cue.
Cue ID	Cue ID (number)	A numeric ID that represents the Cue. If an extended command that specifies a Cue ID is specified, the value specified here will be used as the Cue name. If the same number appears in multiple columns, they will be grouped together into the same Cue.
Material name	Material name (path name)	Search through the material root for the path name and use the first one found.
Text	Any text	By specifying an extended command, it can be treated as a Cue comment or user data.

#GenerateCueNameBy CueName example

The Cue name will be generated from the string of the first element.

Input CSV

#GenerateCueNameBy CueName
#CopyTextTo CueComment
footsteps,footstep1.wav,Footsteps 1
footsteps,footstep2.wav,Footsteps 2
footsteps,footstep3.wav,Footsteps 3
cancel,cancel.wav, system cancel sound
ok,ok.wav, system confirmation sound

result

Cue ID	Cue Name	Comment
0	footsteps	footsteps 3
1	cancel	System cancel sound
2	ok	System decision sound

The Cue ID is assigned automatically.

#GenerateCueNameBy CueID example

A Cue name will be generated, such as Cue0.
This is useful for projects where you only need to call the Cue ID.

Input CSV

#GenerateCueNameBy CueID
0,gun1.wav
1,game.wav

result

Cue ID	Cue Name
0	Cue0
1	Cue1

#MaterialPath example

The search will be performed by adding the string to the front of the reference path of the material.
If not specified, a full search will be performed from the material route.

//Material folder path Search under system
#MaterialPath system/
0,ok.wav
1,cancel.wav
 
//Material folder path Search under weapon
#MaterialPath weapon/
1,gun1.wav
 
//Material folder path Search under bgm
#MaterialPath bgm/
2,title.wav
3,game.wav
4,gameover.wav

About SeqType

You can specify the sequence type by specifying the extended command "#SeqType".

Item	Contents	Description
#SeqType	Cue sequence type	If not specified, it will be Polyphonic.
#SeqType Polyphonic	Polyphonic	Sequence type becomes polyphonic.
#SeqType Sequential	Sequential	Sequence type becomes sequential.
#SeqType Shuffle	Shuffle	Sequence type becomes shuffle.
#SeqType Random	Random	Sequence type becomes random. No weighting is set.
#SeqType RandomNoRepeat	Random No Repeat	Sequence type becomes random no repeat.
#SeqType Switch	Switch	Sequence type becomes switch.
#SeqType ComboSequential	Combo Sequential	Sequence type becomes combo sequential.

Input CSV

#GenerateCueNameBy CueName
#CopyTextTo CueComment
#SeqType RandomNoRepeat
footsteps,footstep1.wav,Footsteps 1
footsteps,footstep2.wav,Footsteps 2
footsteps,footstep3.wav,Footsteps 3
#SeqType Polyphonic
cancel,cancel.wav, system cancel sound
ok,ok.wav, system confirmation sound

result

Cue ID	Cue Name	Comment
0	footsteps	footsteps 3
1	cancel	System cancel sound
2	ok	System decision sound

The footsteps Cue is created with sequence type random no repeat.

Error handling and logging

If an error occurs during the "Create a Cue from Cue creation information CSV" process, the error details will be output to the log view.
If an error is output, please correct the CSV and re-import it, or correct the Cue sheet you created to resolve the issue.
(If the problem is not resolved, an error will occur again during the ACB build process and the ACB data will not be output.)
In addition, if a merge process is performed by specifying the same Cue ID in the read CSV, the fact that the merge process has been applied will be output to the log.
If you get an unexpected result, check the log and CSV and make corrections.

Reading result	Error cause
Cue sheet not generated	When adding by drag and drop, a Cue sheet with the same name as the csv file already exists
There are duplicate Cue names in the Cue sheet	There are elements in the CSV with the same Cue name (but different Cue IDs) The same Cue name already exists in the merge source
There are duplicate Cue IDs in the Cue sheet	There are elements in the CSV with the same Cue ID The same Cue ID already exists in the merge source
No reference to material	Material does not exist in specified path