Skip to content

Command List

l i o n edited this page Apr 26, 2021 · 1 revision

Script and Menu Control

Commands for tweaking functionality of the script itself and its graphical display.

  • /config toggles display of the configuration menu (enable/disable signposts, paragraph spacing etc).
  • /debug toggles debugging mode which outputs modified context to a menu above the input field.
  • /enable allows script to modify context (default).
  • /disable disables context modification and hides the menus.
  • /show makes the menus visible (default).
  • /hide hides the menus.
  • /min minimizes the menus.
  • /max maximizes the menus.

Menu Navigation

Commands for moving through the graphical display menus.

  • ! exits any menu. If changes were made, a y/n prompt will appear to confirm saving of changes made.
    • y! and n! exits a menu with and without saving changes respectively.
  • > and < moves the current selection forward (down) or back (up) the list of menu options.
  • >> and << moves the current selection to the next or previous menu page.
  • #0 will move the current selection to the label option, or first (top) of the list of menu options. Entering any number except 0 will move the current selection to the nth option in the list counting from the top.
  • ^ deletes the currently selected field. If the label is selected, it deletes the entire entry.
  • ? toggles hints for the current menu and selection.

Notes

Commands for loading different scenes and switching control over the player character, with examples.

  • +💭: You think this will be an easy victory creates/updates a note labeled 💭 with the content "You think this will be an easy victory."
    • ++Time: Evening will create a note with the context Time: Evening.
    • +Shhh Secret Info!: There is a monster stalking you creates and hides the note from view due to the ! included before the :. Notes can also be hidden long after being created by adding a ! after the label such as +Info that should be secret!. This can also be used to show a hidden note: +Shhh Secret Info! will reveal the previously hidden note for view.
    • +⚔️#500: You are fighting for your life injects the note before 500 characters into the context. The higher a number following # is, the further down the note is injected into context. +❕#-1: will inject the note to the front (very top) of the memory. A further negative number such as +❗#-20: will be placed above the -1 entry (the very very top).
    • seen+outfit#100: Voldemort is wearing a stylish coat will trail 100 characters in the context from the SEEN match for the Voldemort entry.
  • /n or /notes will display all currently active notes, including hidden ones.

Scene and Perspective

  • /y or /you John switches the user POV and control to the character "John" (only use with 2nd person perspective).
  • /s or /scene Chapter 1 opens the scene creation/editing menu for the scene with the label "Chapter 1".
  • /l or /load Chapter 1 loads the scene and executes any text to prompt as per configuration in the scene menu.
    • /load Intro Scene, Cloudy Weather, Jack's POV, badly hurt, fluff prompt loads multiple scenes at once.
    • /l! or `/load! loads the scene without executing any text to prompt / scene breaks.

Context Definition

Commands for creating and tweaking of context-related content, with examples. Each has a graphical menu to guide you through the process.

  • /e or /entry John creates or loads the world info entry with the label "John".
  • /r or /rel John opens the relationship menu for "John".
  • /t or /title ex wife creates or loads the title with the label "ex wife".
  • /k or /kill John updates entry "John" and sets their status to dead.
  • /revive Mary updates entry "Mary" and sets their status to alive.

Advanced Usage

Commands tailored towards power users, with examples.

  • /f or /find Mary searches and displays all scenes, entries and titles with the label "Mary".
  • /b or /ban John, Mary prevents the entries "John" and "Mary" from being injected into context.
    • /b or /ban with no entries specified will clear all previous bans.
  • /flush will clear state.displayStats in the rare case that it bugs out.
  • @, #, $, %, or ^ are quick entry creation symbols that correspond with each entry type. Left to right, they are Character, Location, Thing, Faction, and Other.
    • #Hogwarts: is a school for wizards: is a large castle: is a place of great mystery creates the location entry with the label "Hogwarts" and fills in each of the entry's fields with the corresponding information, separated by :s.
    • #Hogwarts+2: with tall gothic spires appends the included information to the second field of the entry labeled "Hogwarts" such that it now reads is a large castle with tall gothic spires.
    • @convert!: John Smith, Jane Smith, Mary will add all vanilla WIs with the keys "John Smith", "Jane Smith", and "Mary" as SC2 character entries.

Reference

Getting Started

  • Overview
  • What are Notes?
  • Dressing the Scene
  • Building Your First Entry
  • Importing World Info
  • Debugging and Configuration
  • FAQ and SC1 Migration

Intermediate Usage

Scene and Perspective

  • Global vs Scene Notes
  • Prompts and
  • Swapping Character Control

Entries and Relations

  • Main, Seen, Heard, Topic
  • Entry types
  • Aspects
  • Soft Links
  • Family, Pronouns, and Zombies
  • Trailing and Persistent Notes

Advanced Usage

Power User Features

  • Shortcut Commands
  • Custom Titles
  • Formats and STOP Words
  • Regex Keys
  • Advanced Debugging

Behind the Curtain

  • How Entries are Weighted
  • Modifying the Script

Clone this wiki locally