GetAssetPack

Questwork: Quest & Objectives System (Luau)

Questwork: Quest & Objectives System (Luau)
Price
$10
Type
Sprites
Creator
mustafa-sec
Formats
PNG
Dimensions
2D

A Roblox Luau quest system includes eight modules and a code-built journal UI with objectives, progress tracks, claim buttons, and toasts.

Server-authoritative quests and objectives for Roblox: eight Luau modules, Studio demo mode.

Available on

Search by image

Upload a reference to find previews with similar colors, contrast, and detail.

Questwork: Quest & Objectives System (Luau)

Questwork: Quest & Objectives System (Luau)1 / 6
mustafa-sec · itch.io$10
2D
Sprites
License not indexed
  • i Check the terms on the original listing.
Show full terms
FormatPNG

Server-authoritative quests and objectives for Roblox: eight Luau modules, Studio demo mode.

A Roblox Luau quest system includes eight modules and a code-built journal UI with objectives, progress tracks, claim buttons, and toasts.

View original listing

Description

Launch week: 40% off until Oct 17.

Questwork is Luau source code for Roblox developers: eight modules (three shared, three server, two client), plus an optional demo and tests, that add server-authoritative quests and objectives to a Roblox experience.

Free version: Questwork Lite — https://mustafa-sec.itch.io/questwork-lite

Show full description...

Playtest status: owner playtest passed in Roblox Studio on macOS, demo mode. Automated checks are listed under "What was tested"; not all of them passed.

Questwork adds server-authoritative quests and objectives to a Roblox experience. It is Luau source code: eight modules (three shared, three server, two client), plus an optional demo and tests.

You connect the rewards. Questwork does not grant rewards itself. You register an onClaim handler and grant through your own server data layer.

What it does

  • Count quests with objectives. Each quest has an id, a title, one or more objectives (a goal, plus an optional counter), and reward text. Goals and amounts are whole numbers from 1 to 1,000,000; up to 256 quest definitions and up to 64 objectives per quest.
  • Timing and unlock rules. Availability windows, expiry, cooldowns, a repeat cap, and manual unlock with prerequisites are supported.
  • A small server API. init, register, start, onClaim, unlock, addProgress, addCounter, claim, getState and more. Signals: Unlocked, ProgressChanged, Completed, Claimed, Expired and SaveFailed.
  • Progress comes from your server code only. The client cannot report progress; remotes are validated and rate limited (defaults: 5 claims per 10 seconds, 3 snapshot requests per 30 seconds, configurable).
  • Journal UI built from code. Toggle it with the J key or a button. It has quest rows, progress tracks, a Claim button and toasts. It uses solid fallback colours and works without any images; optional skin PNGs are included but unused until you upload them and fill in one SKIN table.
  • Saving through an adapter. The built-in DataStore adapter uses the key Q_<UserId> in a store named Questwork_v1 by default, autosaves every 120 seconds by default, makes up to four attempts per operation (waits of 1, 2 and 4 seconds, plus jitter, between them) and has a 256 KiB JSON cap. You can pass in your own adapter instead.
  • Claims wait for loaded data. By default, claims are refused with NotLoaded while a player's data is not loaded persistently.
  • Demo and Quickstart. Press Play in the included place file and the demo creates a "Visit marker" prompt you can use to try the journal. The README has a short Quickstart.

Studio demo mode

With the default adapter, Studio always runs in demo mode: Questwork uses an in-memory store, never contacts DataStore, and progress is gone when you stop Play. The server prints one warning, Questwork: Studio demo mode, progress not saved, and the journal shows the same note. Real DataStore saving is only exercised on published live servers.

v1.0.2 changes

v1.0.2 is a documentation-only update. Only the top-level Markdown documentation and the LICENSE.txt version header changed; every other file is unchanged from v1.0.1, so the code and the built files are the same.

Code changes since v1.0, carried unchanged in v1.0.2:

  • Fails closed when saving is down on live servers. If saving is unavailable when a live server starts, Questwork hands out no rewards and does not show a false "Studio demo" message.
  • Finished-but-unclaimed quests can stay claimable. By default, a finished quest you have not claimed stays claimable after its expiry time or availability window passes. Set the config option expireUnclaimedOnRefresh = true if you want those quests to expire instead.

Nothing else is described as changed in v1.0.2.

What was tested

  • Playtest: owner playtest passed in Roblox Studio on macOS, demo mode.
  • Automated checks (checks/final3-* and checks/rojo-*3.txt in the zip), run on the v1.0.1 source. The source is unchanged in v1.0.2 and the checks were not rerun for v1.0.2. Rojo built the place file and both model files, exit 0 each. StyLua (stylua --check src demo tests): exit 0 with empty output. Selene: 0 errors, 5 warnings (variable shadowing in the Signal module), 0 parse errors; its exit code was 1 because of the warnings. Tool versions as given in the zip's README: Rojo 7.7.0, StyLua 2.5.2, Selene 0.32.0.
  • Not passing: luau-analyze (standalone, no Roblox definitions) exited 1 with diagnostics, mostly unknown Roblox globals and types plus some type-inference errors. A second run with Roblox type definitions did not run because the tool did not recognise the option, so nothing was analysed. The project's static forbidden-pattern scan (a heuristic script that was written before the optional skin) exited 1: it flags rbxassetid and ImageLabel in the optional skin code in QuestUI.luau.
  • Not run (no results recorded): the Luau test runner (16 authored specs), the integration tests, a two-player test and any DataStore test.
  • The checks/final2-* and checks/rojo-build2.txt files in the zip are the earlier v1.0 results; checks/final3-comparison.txt compares them with the v1.0.1 runs.

What was not tested

  • DataStore tests are not claimed run. DataStore saving has not been tested in a published place or on a live server.

Good to know

  • No session locking. The built-in DataStore adapter has no session locking or revision conflict detection. For cross-server correctness, supply your own session-locking adapter. Do not use the built-in adapter as a transactional economy store.
  • Not a transactional payout. A reward can already be granted before a failed save is detected, so make your onClaim grants idempotent.
  • Reward tables are sent to the client. All registered definitions, including locked and future quests and their reward tables, are visible to the owning client. Keep secrets out of rewards.
  • Never forward client ids or amounts into addProgress or addCounter; validate gameplay on the server.
  • Out of scope for v1: NPC dialogue and quest-giver prompts, per-objective timers, cross-server messaging and shared or party quests, and a visual quest editor.
  • Test saving in a private place first. Test the save path on a published, private experience before you rely on it.

Licence (summary)

Questwork v1.0.2 Single-Developer Commercial Licence, copyright Fortress MSSP LLC. Non-exclusive, non-transferable and non-sublicensable. One named developer may use and modify Questwork and include it in any number of Roblox experiences, including ones that earn revenue. You may not resell, redistribute, sublicense, rent, lend or give away the source, share it with anyone who does not hold their own licence, or post it in a public repository or marketplace listing. You may not remove the copyright notice or claim to be the author. Each extra developer who needs the source needs their own licence. Questwork is provided as-is, without warranty, and liability is capped at the amount you paid. The licence ends automatically if you break its terms. This is a summary; the full licence text governs. The full text is in LICENSE.txt in the download.

AI disclosure

AI disclosure: The icon and cover image were generated with AI. The Luau source code and documentation for Questwork were written with AI assistance.

What's in the zip

Questwork_v1.0.2.zip has 65 files. Files sit at the root of the zip, with no wrapper folder.

Source (src/, 8 modules)

  • src/shared/Types.luau
  • src/shared/Schema.luau
  • src/shared/Signal.luau
  • src/server/QuestService.luau
  • src/server/Persistence.luau
  • src/server/RemoteGate.luau
  • src/client/QuestClient.luau
  • src/client/QuestUI.luau

Optional demo (demo/)

  • demo/server/Demo.server.luau
  • demo/client/DemoClient.client.luau

Tests (tests/)

  • tests/Runner.server.luau
  • tests/Specs.luau
  • tests/Integration.server.luau
  • tests/static-check.py

Built files and Rojo projects

  • Questwork_v1.0.1.rbxlx (place file with the modules, demo and tests)
  • Questwork_v1.0.1.rbxm (modules only)
  • QuestworkOptional_v1.0.1.rbxm (demo and tests)
  • default.project.json
  • package.project.json
  • extras.project.json

Documentation and licence

  • README.md
  • CHANGELOG.md
  • DESIGN.md
  • CHECKS-Questwork.md
  • FIX_Questwork.md
  • OWNER_STUDIO_TEST.md
  • PUBLISH_CHECKLIST.md
  • LICENSE.txt

Tool configuration

  • .luaurc
  • selene.toml
  • stylua.toml

Check output (checks/, 20 files)

  • checks/final2-artifact-grep.txt
  • checks/final2-format.txt
  • checks/final2-luau-analyze.exit
  • checks/final2-luau-analyze.txt
  • checks/final2-selene.exit
  • checks/final2-selene.txt
  • checks/final2-stylua.exit
  • checks/final2-stylua.txt
  • checks/final3-artifact-grep.txt
  • checks/final3-comparison.txt
  • checks/final3-luau-analyze-roblox.txt
  • checks/final3-luau-analyze.txt
  • checks/final3-selene.txt
  • checks/final3-static-scan.txt
  • checks/final3-stylua.txt
  • checks/rojo-build2.txt
  • checks/rojo-build3.txt
  • checks/rojo-default3.txt
  • checks/rojo-extras3.txt
  • checks/rojo-package3.txt

Optional UI skin PNGs (assets/ui/, 14 files; not Roblox assets until you upload them)

  • assets/ui/questwork_icon_512.png
  • assets/ui/questwork_thumbnail_1920x1080.png
  • assets/ui/questwork_ui_claim_button.png
  • assets/ui/questwork_ui_journal_button.png
  • assets/ui/questwork_ui_panel_bg.png
  • assets/ui/questwork_ui_progress_fill.png
  • assets/ui/questwork_ui_progress_track.png
  • assets/ui/questwork_ui_row_bg.png
  • assets/ui/questwork_ui_status_active.png
  • assets/ui/questwork_ui_status_claimed.png
  • assets/ui/questwork_ui_status_completed.png
  • assets/ui/questwork_ui_status_expired.png
  • assets/ui/questwork_ui_status_locked.png
  • assets/ui/questwork_ui_toast_bg.png

Setup

  • Unzip the download.
  • To look around first: double-click Questwork_v1.0.1.rbxlx, or in Roblox Studio use File > Open from File. It opens as a local, unsaved place; opening it does not publish anything.
  • Press Play (F5). The demo script starts the service and creates a "Visit marker" prompt. Toggle the journal with J or its button. Tip: the character spawns facing away from the marker, and the marker is not visible from spawn. Turn around and walk toward negative Z to reach it.
  • To use Questwork in your own place with Rojo: use default.project.json with Studio's Rojo plugin (rojo serve), or build with rojo build default.project.json -o Questwork_v1.0.1.rbxlx.
  • Manual placement: shared modules go in ReplicatedStorage/Questwork; server modules in ServerScriptService/QuestworkServer; client modules in StarterPlayer/StarterPlayerScripts/QuestworkClient. Keep the module names. package.project.json is modules only; extras.project.json holds the demo and tests.
  • Call init, register, onClaim and start from a server script, as in the README Quickstart; on the client, require QuestClient and QuestUI, call client.start() and UI.mount(client).
  • To run the authored specs (16), set the Runner script's RunTests attribute to true before Play and follow OWNER_STUDIO_TEST.md. No results from running these specs are recorded.

System requirements

  • Roblox Studio.
  • Rojo is optional (it is used for the setup in step 4); the builds were made with Rojo 7.7.0.
  • To test real DataStore saving you need a published, private experience; with the default adapter, Studio itself always uses the in-memory demo mode.

Tags

datastoreLuauobjectivesquestsquest-systemRobloxRoblox Studiorojoserver-authoritativeUser Interface (UI)

Downloads