Skip to content

Getting Started with Scriptum

Scriptum is your live C# console inside Unity, empowering you to experiment, debug, and build with pure runtime clarity. With no need to recompile or stop Play Mode, Scriptum turns the editor into your personal code altar.

Installation

  1. Import Scriptum
    Add the Scriptum.unitypackage to your Unity project via drag-and-drop or Assets → Import Package.

  2. Dependencies
    All dependencies are included — no extra setup is required.

Launching Scriptum

To begin using Scriptum:

  • Navigate to DivinityCodes → Scriptum Console in the Unity top menu.
  • The Scriptum Console will open in a new Editor window.
  • You can dock or float it like any standard Unity panel.

If you enabled “Start with entry template” under Scriptum → Preferences, a Main class with a Run() method will be pre-generated.
Otherwise, the editor will start empty — allowing you to write code directly without any class/method wrapping.

Modes of Operation

Scriptum supports two distinct coding environments:

  • Editor Mode – Ideal for multi-line scripts, classes, and session logic.

  • REPL Mode – A real-time command console available during Play Mode.

You can switch between modes using the toolbar at the top of the console.

Each feature in Scriptum clearly states which mode it supports.

Basic Usage

  • Type any valid C# expression and hit Enter to run it.

  • Use @ to reference Live Variables.

  • Use # to summon the Quick Spells popup.

  • Use this. to view available built-in commands for the current mode (like echo(), manifest(), bind(), etc.).

  • Multi-line code is fully supported in Editor Mode.