Skip to main content

API Reference

@go​

Changes location to a different one

@go location_name

@state​

Changes the mood of a character

@state jo neutral
@state kate excited

@show​

Displays a character or device

@show character_name
@show phone

Modifiers​

  • #from: left|right|center|midleft|midright Default (Target simply condenses)

  • #to: left|right|center|midleft|midright

  • #duration: number in seconds

  • #chat: Sets the mode to chat. Used for phone conversations

@show flora #from:left #to:right #duration:0.5
@show flora #from:left #happy

@move​

Moves a character or device

@move character_name #to:midright #from:0.1
@move phone #from:left

Modifiers:​

  • #to: left|right|center|midleft|midright
  • #duration: number in seconds
  • #chat: Sets the mode to chat. Used for phone conversations

@hide​

Hides a character or device

@hide flora #to:right
@hide phone #to:left

Modifiers​

  • #from: left|right|center|midleft|midright

  • #to: left|right. Default (Target simply dissolves)

  • #duration: number in seconds

  • #chat: Sets the mode to chat. Used for phone conversations

@phone​

Manage in-game phone

@phone add character_name

@lastchoice​

Simply outputs the last chosen option value Implemented to prevent repetition

@lastchoice

@ask​

Pops up a dialog box to request for text from the user

@ask $mc:name #title:"What's your name?"
@ask $mc:age #title:"How old are you?" #max:2

Modifiers​

  • #title: Specifies the dialog box title
  • #max: Specifies the maximum amount of allowed characters (Default: 16)

@stats​

Modifies game stats

Values:​

  • Love: lv, love
  • Hate: h8, ht, hate
  • Strength: str, athletics, strength
  • Charisma: char, charisma, rizz, charm
  • Intelligence: int, smarts, intelligence
  • Lust: lust
@stats +lv -h8
@stats target_name +lv -hat

Sets the location of the next option block

Values:​

'left' | 'right' | 'top' | 'farLeft' | 'farRight' | 'center' | "farleft" | "farright";

@menu 'farright'

@quest​

Manages a specified quest

@quest activate quest_name
@quest complete quest_name

@black​

Makes the screen completely black

@black

@refresh​

Forces a game screen refresh During a refresh, characters, scenes and locations are updated

@refresh

@inventory​

Manages game inventory

@inventory add flash_drive
@inventory remove sugarcube3 2

@play​

Play a scene or target media

// Only one piece of music can play at a time, so simply calling play will stop other active music themes
@play music home_theme
@play sound kiss
@play scene jo_morning_kiss

@stop​

Stop a scene or target media

@stop music 
@stop sound kiss
@stop scene jo_morning_kiss

@schedule​

Schedule a character or location based on a time range

@schedule flora kitchen:sitting #from:6 #to:13

Schedule values are set based on location:activity. If a character is in multiple places at once simply specify all their locations and activities

@schedule jo kitchen:counter kitchen:counter west_hall #from:0 #to:23

Modifiers​

  • #from: 0-23 hours

  • #to: 0-23 hours

@guide​

Point quest guide to a specific item or character

To be more specific on where an item or character is, format your values as follows location:item_name

@guide bedroom:flash_drive
@guide kitchen:stairs home_hall:water_trail
@guide jo

@vpunch​

Cause vertical screen shake

@vpunch

Modifiers​

  • #async: Continue right after the transition has been initiated

@hpunch​

Cause horizontal screen shake

@hpunch

Modifiers​

  • #async: Continue right after the transition has been initiated