infoThis version ships no README. Showing the README from v1.4.0, mirrored from wally.

🌲 Sawdust Framework

Sawdust is a lightweight, modular framework for Roblox developers who want clarity, control, and smart abstractions, without the bloat 😉

💖 Built with love by Griffin Dalby
🛠 Designed for efficient, easy-to-read, and easy-to-use code - made for devs who hate reading docs.

---

✨ Features

• 💉 Service Injection System
  Build, inject, and manage services with dependency resolution.

• 🔗 Smart Networking
  Networking w/ a custom protocol for secure returns from each side, all with a friendly interface.

• 📦 CDN System
  Efficient asset delivery with preload batching and efficient caching.

• 📣 Signal Emitters
  Embeddable event behavior for services or general-purpose modules.

• 📜 Cache API
  Stackable cache management built for structure, and speed.

• 🧹 Maid Utility
  Clean up anything, connections, callbacks, instances, all with tag-based logic.

• ✈ And much, much more planned
  I hope to get as much quality of life features as possible.

• 🌳 Lignin
  Lignin is a plugin being developed to aid even further with sawdust development. You'll be able to gradually create networking channels and events/functions, and many more things All of these will create automatic type metadata for a dynamic feeling typechecking experience including assetIds and networking event names.

---

🚀 Quick Start

Network from server <-> client

--> In StarterCharacterScripts.Mechanics

local networking = sawdust.core.networking
local mechanics = networking.getChannel('mechanics')

mechanics.skill:useMiddleware('after', 1, function(pipeline)
    --> I'll fill this all out soon I just want to push this for the rodev game jam tmr I love this module
end)

mechanics.skill:with() --> Returns a new call
    :intent('use')
    :data('fireball', mousePosition)
    :timeout(4)
    :invoke() --> Returns a promise
        :finally(function(req)
            local intent, data = req.intent, req.data
            local didUse = (data[1]==true)


        end)
        :catch(function(issue)
            warn('Issue with skill: fireball')
            warn(issue)
        end)

--> In ServerScriptService.Mechanics

local networking = sawdust.core.networking
local mechanics = networking.getChannel('mechanics')

mechanics.skill:handle(function(req, res)
    local intent, data = req.intent, req.data

    res.intent('success')
    res.data('Whatever you\'d need')
    res.send() --> Send the data back
end)

Build a Service

--> In ServerScriptService.SawdustServices

local builder = sawdust.builder
local services = sawdust.services

services:register(builder.new('OtherService')
    :init(function(self, deps) --> 'init' runtime phase
        self.data = 'Hello!' --> Set OtherService.data to 'Hello!'
    end)
    :method('methodName', function(msg) --> Create a new method (OtherService.methodName(msg))
        print(`Method was called, message: "{msg}"`)
    end)
    :inject('init', function(self, deps) --> Inject function into 'init' runtime phase
        print('Injection into OtherService success!')
    end))

services:register(builder.new('ExampleService')
    :dependsOn('OtherService') --> Depend on the OtherService
    :init(function(self, deps) --> :init() phase
        self.otherService = deps.OtherService
    end)
    :start(function(self) --> :start() phase
        print(`Data from other service: "{self.otherService.data}"`)
        self.otherService.methodName('I called the function from ExampleService!')
    end))

services:resolveAll() --> :init() all services
services:startAll() --> :start() all services

--[[

    This should print this, in order:
    'Injection into OtherService success!'
    'Data from other service: "Hello!"'
    'Method was called, message: "I called the function from ExampleService!"'

--]]

---

🧠 Philosophy

Sawdust is designed to:

• Give maximum control to the developer
• Encourage clean runtime logic
• Reduce boilerplate
• Promote discoverabiliy via tooling & naming clarity
• Minimize documentation checks

You get injection + dependency management without losing Luau's flexibility.

---

🚚 Installation

1. Drop the Sawdust folder into ReplicatedStorage
2. Access it on server or client via:

local sawdust = require(game:GetService('ReplicatedStorage').Sawdust)

3. Access the implementations like:

local sawdust = require(game:GetService('ReplicatedStorage').Sawdust)

local services = sawdust.services
local networking = sawdust.core.networking
local maid = sawdust.util.maid

---

🧪 Tests

I've built unit tests for sawdust and all of the implementations (this may not be ALL implementations at time of reading, I may still be working on some.)

📖 Documentation

You can find full documentation & quick start examples + implementation tutorials Here!

---

📚 Modules

Services

Core

Util

---

📜 License

Sawdust is licensed under Apache 2.0.
Contributions are welcome! While not required by the license, if you would like to improve Sawdust or find bugs, please consider contributing or filing a issue report, it means a lot more than you think <3