Installation

MrDialogue runs on both the server and client. Install the package in a container replicated to both environments, then start its client runtime from a LocalScript.

Wally

Add MrDialogue to the [dependencies] section of your wally.toml:

[dependencies]
MrDialogue = "arakodev/mrdialogue@0.1.2"

Install the dependency:

wally install

Sync the generated Packages directory into ReplicatedStorage with Rojo. A typical project mapping looks like this:

{
  "name": "MyExperience",
  "tree": {
    "$className": "DataModel",
    "ReplicatedStorage": {
      "Packages": {
        "$path": "Packages"
      }
    }
  }
}

Keep the package shared

Do not install MrDialogue as a server-only dependency. The server API owns dialogue state, while the client API owns presentation and player input.

Start the client

Create a LocalScript under StarterPlayerScripts:

StarterPlayerScripts/DialogueClient.client.luau

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local MrDialogue = require(ReplicatedStorage.Packages.MrDialogue)

MrDialogue.Start()

MrDialogue.Start() creates the bundled interface and tells the server that this player is ready for dialogues. Calling it again returns the same client runtime.

Start the client before starting a session

Dialogue:Start() returns "player dialogue client is not ready" until the player's client runtime has connected. Starting the runtime from StarterPlayerScripts normally makes it ready before the player can trigger an NPC prompt.

Verify the installation

Run the experience and inspect ReplicatedStorage:

ReplicatedStorage
├── Packages
│   └── MrDialogue
└── MrDialogueRuntime
    └── DialogueRemote

MrDialogueRuntime is created by the server automatically. Do not create or send messages through its remote manually.

Next step

Create your first dialogue and trigger it with a ProximityPrompt.