[image: Reflex]
Quill

---

 

🪶 Quill

Quill is a book-inspired Roblox game framework inspired by Sapphire, designed to simplify your workflow's setup.

You can use Quill for Chapters (services/controllers) and Characters (components). Eventually, you will be able to use Quill to handle networking, data saving, and will be able to add your own extensions.

 

📦 Installation

This package is available for Wally and Pesde.

# wally.toml
[dependencies]
quill = "featherfall-org/quill@0.1.0-alpha"

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

 

📚 Getting Started

Take me to the documentation →

🚀 Start using Quill

Quill requires some sort of bootstrapper to launch your lifecycle hooks. You can start by making bootstrappers for the server and client.

local quill = require(path.to.quill)

quill()
    :register_chapters(script.chapters)
    :register_characters(script.characters)
    :begin_reading()

📖 Using Chapters

Now that you have made your bootstrappers, you can begin writing your Chapters. Here's what a Chapter might look like:

local Players = game:GetService("Players")

local example = {
    priority = 1,
}

function example:player_added(player: Player)
    print(player.Name .. " has joined the game!")
end

function example:state_something(statement: string)
    print(statement)
end

function example:init()
    Players.PlayerAdded:Connect(function(player)
        self:player_added(player)
    end)
end

return example

👤 Using Characters

You may also want to include components in your workflow; Quill provides components that are called Characters. Here's what a Character might look like:

local example = {
    tag = "Example_Tag",
}

function example:init()
    print("Character is attached to " .. self.instance:GetFullName())
end

function example:destroy()
    print("Character " .. self.instance:GetFullName() .. " has been destroyed!")
end

return example

 

📺 Credits

Credits go to Mark-Marks for the creation of Sapphire and its architecture, which is what Quill draws its inspiration from, and littensy for the documentation and README inspiration.

 

📝 License

Quill is licensed under the MIT License.