Visual Novel Choices
Create a visual novel style choice menu with a list of choices and a title. Make democratic or non votes, customize colors and background image, and trigger scene changes or macros when a choice is resolved.
How to use
To create a choices prompt you will need to use the /choice chat command.
You can provide additional parameters to both the choice and the option
with this syntax: [param=value].
The first line of the chat message (the one with /choice)
is the question. Every new line will be one option.
Example
/choice [img=path/to/my/image.jpg][player=Jhon,Mary] What path will you chose?
[scene=path1] The Woods
[scene=rockymountains] The MountainsParameters
You can use the following parameters (all in the format [param=value])
Choice Parameters
The choice is the first line of the message
| Parameter | Type | Details |
|---|---|---|
multi | Boolean | determines if multiple choices can be selected (default false) |
img | String | the path to the image to be displayed as the background |
sound | String | the sound to be played when the choice is displayed (the sound will loop and stop when the choice ends) |
portraits | String | a comma separaded list of actor names, actor ids or image paths (you can mix an match) - these images will be displayed in the choice (theatre inserts style, if the actor has a theatre insert specific image, that will be used instead) |
player | String | a comma separated list of player names, if not provided all players will get to chose |
democracy | Boolean | determine if the choice with the highest votes will be picked (if true) or resolve the choice per player (if false) (default true) |
default | Number | the default choice if no choice is made (default 0) |
displayResult | Boolean | determine if the result will be output to chat after the choice is made (default true) |
resolveGM | Boolean | determine if the resolution of the choice should run on the gm side as well (default false) |
Options Parameters
The options are the lines after the first line of the message
| Parameter | Type | Details |
|---|---|---|
scene | String | a scene name or id, when the choice is resolved this scene will be viewed |
macro | String | a macro name or id, when the choice is resolved this macro will be executed, if you have the advanced macros module you can provide a comma separated list of args to be passed to the macro (eg [macro=myMacro,arg0,arg1]) |
sound | String | a sound file path, when the choice is resolved this sound will be played once |
chain | Boolean | set to true if this options triggers a macro with a choice |
Examples
You can use some neat tricks to get more use out of this module, for example you can create a choice with no choices to just display portraits on a background :)
Basic
/choice [img=https://i.pinimg.com/originals/f4/30/56/f43056ea6e34f2071621a736b6d6da36.jpg][time=60] This is a test
[scene=Scene name]Go to this place
[scene=Scene name 2]Go to this other place
[scene=Scene name 2]Go to this other place
[scene=Scene name 2]Go to this other place/choice [img=https://i.pinimg.com/564x/49/92/5e/49925e1c7ff5dae26836ec636b134a1e.jpg][multi=true] This is a test
[scene=Scene name]Go to this place
[scene=Scene name 2]Go to this other place
[scene=Scene name 2]Go to this other place
[scene=Scene name 2]Go to this other place/choice [img=https://i.pinimg.com/564x/49/92/5e/49925e1c7ff5dae26836ec636b134a1e.jpg][democracy=false] This is a test
[scene=Scene name]Go to this place
[scene=Scene name 2]Go to this other place
[scene=Scene name 2]Go to this other place
[scene=Scene name 2]Go to this other place/choice [img=https://i.pinimg.com/564x/49/92/5e/49925e1c7ff5dae26836ec636b134a1e.jpg][democracy=false][portraits=Arngrim Brakenbrik,Blue Dragon Wyrmling,Acolyte] This is a test
[scene=Scene name]Go to this place
[scene=Scene name 2][sound=music/Bloodborne/02.%20Ryan%20Amon%20-%20The%20Night%20Unfurls.mp3]Go to this other place
[scene=Scene name 2][sound=music/Bloodborne/02.%20Ryan%20Amon%20-%20The%20Night%20Unfurls.mp3]Go to this other place
[scene=Scene name 2][sound=music/Bloodborne/02.%20Ryan%20Amon%20-%20The%20Night%20Unfurls.mp3]Go to this other placeChaining
If you want to chain choices, the choice needs to have democracy=true and resolveGM=true , any option that calls another choice needs to have chain=true
/choice [img=https://i.pinimg.com/564x/49/92/5e/49925e1c7ff5dae26836ec636b134a1e.jpg][democracy=true][resolveGM=true] This is a test
[macro=scene2][chain=true]Scene 2/choice [img=https://i.pinimg.com/564x/49/92/5e/49925e1c7ff5dae26836ec636b134a1e.jpg][democracy=true][resolveGM=true] This is a test
[macro=scene3][chain=true]Scene 3/choice [img=https://i.pinimg.com/564x/49/92/5e/49925e1c7ff5dae26836ec636b134a1e.jpg][democracy=true][resolveGM=true] This is a test
[macro=scene4][chain=true]Scene 4