Guide to Ink Script Commands

Summary

These are the custom commands added to Ink Script. For more information on Ink itself, see Inkle’s guide.

If you want to pull down and modify the DomSim ink scripts, have a look at the DomSim Guide to Github for more information.

Note: You can use all of these in the in-game debug console. While playing, press Tab to bring up the console, then type the command. You can also use help in the console to show all the available commands.

---

Game Content

/notify title="<title>" [text="<text>"] Puts up a notification box with a title and optional text.

Best to have it include a question like “Understood?” and have a [yes] choice immediately after so the player can read it at their own speed.

/action <action_name> Triggers custom GameEvents that specific scenes or systems know about. Currently supported actions include:

<action_name>	Description
open_journal	Opens the player’s journal.
close_journal	Closes the player’s journal.
raise_curtains	Raises the curtains in the Head Mistress’ auditorium.
force_dice	Forces the dice to all cups so Nega can cheat.
equip_cock	Equips the player’s penis or strap-on, depending on gender.
restart	Restart the demo.

/perform <performance> [<emotion> [<intensity>]] This tells the focused character to perform an animation.

This can also sometimes include sounds, such as performances of the ‘crowd’ character in the Headmistress’ auditorium.

See /list performances for a complete list.

Additionally, you can add an optional emotion and emotion intensity. See Emotions Page.

/character <name> [<perform> [<emotion> [<intensity>]]] Selects a character to focus on and optionally set their current performance and emotion. For a complete list: /list characters. For performance options, see PERFORMANCES PAGE and for emotion options, see Emotions Page.

/scene <room>.<staging>

Loads the two Unity scenes that make up a fully assembled scene in the game.

The part of the name is the room that the scene takes place in.

The part of the name is the name of the staged scene that contains the layout of elements in the room like the player’s spawn location, move location, and starting scene characters.

Note: You can use /scene none to load an empty scene.

This is sometimes necessary if you want to transition back to the spawn point of the existing scene (such as for replaying a scene for testing purposes).

/wait [<seconds>] Waits for a set amount of time before continuing.

This is the equivalent of using the [continue] choice.

determines how long to wait.

If not included, /wait will pause for 1 second.

/open_link <url> This opens a web page to the specified .

This is currently used to open a browser, in the credits area.

/quit Immediately quits the game.

/emotion <emotion> [<intensity>] Sets the focused characters current facial expression. If set, will determine the amount of the expression to apply over neutral. (Range from 1 to 100. Default is 100) For more information, see the Emotions Page.

/lookat <target> Tells the focused character to look at a . Current targets include ‘player’ or a character name.

Game Debugging

/list <bucket> Lists out the items in a specific bucket of assets.

<bucket>	Description
actions	List of actions available for the /action command.
ambient	List of ambient audio tracks available for the /ambient command.
music	List of music audio tracks for the /music command.
characters	List of available characters available for the /character <character_name> command.
choices	List of all [choice] options available for scripting.
commands	List of all /command options available for scripting.
performances	List of all available performances for the /perform command.
poses	List of all available player poses for the /pose <pose_name> command.
scenes	List of all available scenes for the /scene . command.
vo	List of all available VO lines available. (Warning: Very long).

/load [<save_slot>] Loads the most recent save or the specified save slot.

/recenter Re-centers the player or the last used [move] or starting spawn point.

/log <message> Displays in the console.

/logWarning <message> Displays in the console as a warning.

/logError <message> Displays in the console as an error.

Game Music

/ambient <track> Sets the ambient audio loop. Options are found in the Audio Ambient Bucket. For a complete list: /list ambient.

<track>	Description
crowd	Murmuring crowd sounds used in the Auditorium.
orgy	Orgy sounds used in the Goddess’ intro.
rain	Rain sounds used in the Goddess’ bedchamber and entry.
none or off	Turns off the ambient sound.

/sound <sound_name> Plays a one-off audio file. Options are found in the Sound Bucket. For a complete list: /list sounds.

<sound_name>	Description
slap	The slap sound used for inappropriate touching.

/music <track> Sets the music audio loop. Options are found in the Audio Music Bucket. For a complete list: /list music.

<track>	Description
entry	Music used in the intro and entryway.
goddess	Goddess’ theme music.
headmistress	Headmistress’ theme music.
nega	Nega’s theme music.
nega-reward	Nega’s reward theme music.
yuki	Yuki’s theme music.
none or off	Turns off the music.

-Created by Deviant Dev et al. -Edited by headphonetaco et al.