infoThis version ships no README. Showing the README from v0.1.1, mirrored from wally.

Introduction

MrDialogue lets Roblox experiences define conversations as data and run them for individual players from the server. Use the included dialogue UI or connect the runtime to your own interface.

Features

• Graph-Based: Build branching conversations from line, choice, branch, action, and end nodes.
• Server-Authoritative: Conditions, actions, choices, and dialogue state are evaluated and controlled by the server.
• Customizable: Use the included UI or supply a custom client adapter.
• Typed and Validated: The package uses strict Luau types and validates dialogue definitions and client adapters.

Installation

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

Install the dependencies in your project:

wally install

Usage Example

Create the dialogue and start it from a server Script under a ProximityPrompt:

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local MrDialogue = require(ReplicatedStorage.Packages.MrDialogue)

local dialogue = MrDialogue.new({
	format = 1,
	id = "directions",
	entry = "greeting",
	nodes = {
		greeting = {
			type = "line",
			text = "Do you need directions?",
			next = "answer",
		},
		answer = {
			type = "choice",
			options = {
				{ id = "yes", text = "Yes.", next = "directions" },
				{ id = "no", text = "No, thanks.", next = "done" },
			},
		},
		directions = {
			type = "line",
			text = "Follow the road north.",
			next = "done",
		},
		done = {
			type = "end",
		},
	},
})

script.Parent.Triggered:Connect(function(player)
	dialogue:Start(player)
end)

Initialize MrDialogue from a LocalScript in StarterPlayerScripts:

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local MrDialogue = require(ReplicatedStorage.Packages.MrDialogue)

MrDialogue.Start()

License

MrDialogue is available under the MIT License.