Datasets:

nekohacker591

/

test21

like 0

There are 6 different file types that will generate for each registered channel. The these types are main, transitions, commands, toggles, redirect, and jukebox. All channel based config files are TOML files with the exception of redirect and jukebox which are simple txt files.

Main

Index

The main config files is where your trigger and song configurations go. This is the file you will be mainly using when configuring the mod

Triggers

Index

All triggers go under a triggers table and each trigger is defined by a table with the name of that trigger under that. For example, when you want to define the menu trigger - one of the simplest and most straightforward triggers the mod offers - it would look something like this:

[triggers]

[triggers.menu]

If you want to give the menu trigger some fade and delay values, you just need to add a variable with those parameters like so:

[triggers]

[triggers.menu]

fade_in = 100

fade_out = 150

song_delay = "100:200"

If you want to use a trigger holder like the mob trigger and have 2 different parameter sets, it could look something like this:

[triggers]

[[triggers.mob]]

identifier = "mob1"

resource_name = [ "Zombie" ]

level = 2

mob_targeting = true

[[triggers.mob]]

identifier = "mob2"

resource_name = [ "Skeleton" "Creeper" ]

level = 1

All of the different triggers and the parameters they accept are listed below.

Music Linking

Music Linking is a system where you can "link" triggers to each other, even across channels. This is useful if you want to have a song inherit the time where the song from previous trigger left off at, but it can also be used a crossfade helper between different channels or just to block music in another channel when a specific trigger is active. The accepted parameters are channel, inherit_time, linked_triggers, required_triggers, and resume_after_link. Here are what those do:

channel: The name of the channel that is being linked to. It is allowed to be the

same as the parent channel of the trigger, but since each channel can only play 1

sound at a time it will not be able to crossfade.

(Accepts any string)

inherit_time: Determines if the song that starts playing after the linked trigger(s)

become(s) active will be inherit the time from the last playing song of the trigger

that was linked from.

(Accepts true/false)

linked_triggers: The list of triggers in the target channel that must be active for

the link to occur.

(Accepts a list of strings)

required_triggers: The list of triggers in addition to the parent trigger of this

link that must be active in the channel of the parent trigger for the link to occur.

If this parameter is empty or not included, it means that only the parent trigger is

allowed to be active, but if the only element is the parent trigger that means that

the parent trigger is allowed to be active with any combination of other triggers.

Any other combination of triggers listed here means only that combination of triggers

is allowed to be active.

(Accepts a list of strings)

resume_after_link: Determines whether the song playing before the link occurred should

resume where it left off when the link is finished. If inherit_time is false, this

means the song plays where it left off, but if inherit_time is true, it will play the

song from where the linked song left off.

(Accepts true/false)

Songs

Index

Referencing Simple Triggers

All songs go under a [songs] table and each song is defined by a table with the name of that song under that. For example, when you add a menu trigger to a song called songOne, it would look like:

[songs]

[songs.songOne]

triggers = [ "menu" ]

Or if you one a song called other3 to be able to play only when multiple triggers are active, you can do something like this:

[songs]

[songs.other3]

triggers = [ "raining" "pet" ]

Referencing Trigger Holders

In order to reference an instance of a trigger holder you need both the name of the trigger and its identifier parameter in the format of name-identifier. For instance, if you were to define a time trigger with an identifier of night that only plays during the nighttime, and a dimension with an identifier of overworld that only plays in the overworld and you have a song called nighttime1 which should only play when both of those are active, it would look like this:

[songs]

[songs.nighttime1]

triggers = [ "time-night" "dimension-overworld" ]

Song Parameters

In addition to the triggers parameter, there are 5 other parameters that can be defined for audio. Those are chance, must_finish, pitch, play_once, play_x, resume_on_play, and volume. Here are what each of them do:

chance: A weighted chance value for the song to play within the song pool for a trigger. Default: 100

Note that even if you change the chance for a song to play, the mod will still never play the same song twice in a

row for the same trigger

(Accepts any positive integer value)

must_finish: The song must finish playing before the trigger is able to change

(Accepts true/false)

pitch: NYI

play_once: Allows for specifying various different levels of having the song only play once