1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
|
# Briefing and Proximity file formats
In releases beyond the 4.5 series, the campaign brief and Proximity files are now in a more readable format.
# Proximity
Example:
```json
{
"type": "wz2100.proxmsgs.v1",
"msgs": {
"C1A_BASE0": {
"audio": "pcv390.ogg",
"message": "BARBASE_MSG",
"type": 0,
"x": 3904,
"y": 4672,
"z": 0
}
}
}
```
Each Proximity message must have a unique ID. This ID will be what can be referenced in scripts. Various key-value pairs in one contain:
- audio: The audio file associated with this Proximity blip when it gets clicked. Either a string to an audio file, or 0 to not use a sound.
- message: A translated string reference that will print a message when the Proximity blip is clicked on. An array of references is supported.
- type: What type of Proximity blip this is (0 - ENEMY|RED, 1 - RESOURCE|BLUE, 2 - ARTIFACT|GREEN).
- x, y, z: Coordinates in World Units (128 World Units = 1 Tile) where the Proximity blip will appear.
# Briefing
Example:
```json
{
"type": "wz2100.briefs.v1",
"briefs": {
"MB1A_MSG": {
"sequences": [
{ "loop": 1, "subtitles": "TRANS_MSG1", "video": "brfcom.ogg" },
{ "loop": 0, "subtitles": ["CAM1A_MSG1", "CAM1A_MSG2", "CAM1A_MSG3"], "video": "cam1/cam1ascv.ogg" }
]
}
}
}
```
Each briefing must have a unique ID. This will be used as a reference for scripts to invoke to start a video subset.
Within each briefing, there will be:
- sequences: an array of objects (order matters!) containing variables about each sub-video:
- loop: An integer between 0-1 to loop the entire video until its audio stops playing. Will always display subtitles every frame if set to 1.
- subtitles: String or array of string translation references for the video. These are added to the Intel menu icon text messages.
- video: The actual video file to display. Note the directory starts at "data/[base|mp]/sequences/".
|