Quick Start

Welcome to the Quick Start page for Quill. Quill is a book-inspired Roblox game framework that allows you to easily setup your workflow in a fun and intuitive way. It is partially inspired by Sapphire and uses a similar architecture.

Installation

Quill is currently available on Wally and Pesde:

Wally

[dependencies]
quill = "featherfall-org/quill@0.1.0-alpha"

Pesde

[dependencies]
quill = { wally = "featherfall-org/quill", version = "0.1.0-alpha" }

Start using Quill

Now that you've installed Quill, it is time to setup your workflow! Let's setup your first book (bootstrapper).

ServerScriptService.server_book.luau

local quill = require(path.to.quill)

quill()
    :register_chapters(script.chapters) -- "Chapters" are services/controllers
    :register_characters(script.characters) -- "Characters" are components
    :begin_reading() -- Starts the framework!

Every book needs its own chapters and characters, right? Check out the guides to learn how to write your own chapters and characters.