Getting Started

Roadmap

Most of the original roadmap shipped in v2.4. What remains is community reach | the YouTube showcase and the awesome-roblox listings. The framework itself is feature-complete for the foreseeable future.

Status key  |  ● Next up | actively being worked on    ● Future | on the horizon    ● Shipped | done
Harpy | Outbound HTTP Client SHIPPED
Server-side HttpService wrapper for calling external APIs from inside a Roblox game
  • Base URL and shared headers set once; every subsequent call reuses them | no repeated config
  • Callback style (:Get / :Post / :Put / :Delete) and Promise style (:GetAsync etc.) in the same API
  • Automatic retry with exponential backoff on 5xx and connection errors; 4xx returned immediately
  • Consistent response shape: { ok, status, data, headers, raw } | body JSON-decoded automatically
  • See Harpy
YouTube Showcase | Gun Framework NEXT
Full gun framework built live on YouTube demonstrating RoExpress end to end
  • Routes for shooting, reloading, and damage validation; Stream for hit reporting; Codec for match state responses
  • Shows the complete pipeline from client request to server validation in a single real project
  • Now that Stream and Deflate are shipped, the video will reflect the final API
  • See YouTube for the planned episode breakdown
awesome-roblox Submission FUTURE
Submit RoExpress to both curated Roblox resource repositories on GitHub
  • awesome-roblox/awesome-roblox and elevenpassin/awesome-roblox
  • Planned after the YouTube series ships so the listing reflects the full capability with a video walkthrough to point to
Documentation Rebuild SHIPPED
Flat per-page docs site with sidebar, search, and individual SEO-indexable pages
  • Separate HTML page per module and concept | 44 pages total
  • Full sidebar with 9 sections: Getting Started, Server API, Client API, New in v2, Shared, Examples, Guides, Community, Reference
  • Live search across all pages via nav.js search index
  • Individual pages rank independently | e.g. /docs/pages/stream.html for "Roblox state sync"
Automatic Retry SHIPPED v2.4
Failed requests handle themselves gracefully without developer intervention
  • Exponential backoff on network errors and timeouts | 1s → 2s → 4s
  • Configurable max attempts globally at construction or overridden per request
  • Transparent to the caller | promises and callbacks resolve normally on retry success
  • See Network
Deflate Compression SHIPPED v2.4
Codec upgraded from LZ77 to full Deflate | LZ77 sliding window plus Huffman entropy coding
  • Huffman entropy coding stage added on top of the existing LZ77 pass | better ratios on repetitive JSON payloads
  • Same opt-in API | { compress = true } per route, nothing changes for existing users
  • See Codec
Stream | Generic Channels SHIPPED v2.4
Stream rebuilt as schema-defined typed channels, not a hardcoded FPS singleton
  • Declare field names and types; Stream handles buffer pack/unpack automatically
  • Works for anything: wheel rotation, physics state, weather, economy | not only shooters
  • Delta compression built in | only changed records sent per tick
  • See Stream and the FPS Stream guide
Improved Typing SHIPPED v2.4
Typed GetApp() / GetNetwork() accessors and better exported types
  • RoExpress.GetApp() and RoExpress.GetNetwork() return fully-typed instances
  • NetworkResponse, NetworkPayload, and other internal types exported from the public surface
  • See Types
Compact Handler Arguments SHIPPED v2.3
Handler signatures slim from four arguments down to two | no migration required
  • New compact: app:Get("/route", function(req, res))
  • req.player and req.raw available when the old args are needed
  • Detection via debug.info | existing four-arg handlers continue working without changes
  • See App

See also

Changelog | full version history  ·  Stream | channel API  ·  Codec | Deflate compression  ·  Network | request/response & retry