Skip to content

CyanoTex/bloxus

Repository files navigation

Bloxus

License: MIT

Roblox Knowledge Engine for Claude Code, Codex, OpenCode, and Cursor. Queries 11 data sources, commands 18 Studio tools, runs 6 local API dump subcommands, and combines results across 23 patterns to answer any Roblox development question.

What It Does

Bloxus is an AI coding-assistant skill that automatically activates when you work on Roblox projects. It pulls from:

Source What it covers
API Dump Every class, property, method, event, enum — structured with types, defaults, tags, security
Engine API Docs Code examples and detailed explanations via Context7
Creator Docs Tutorials, guides, Studio features, cloud APIs, UI, physics, networking, monetization
Roblox Studio MCP Live game tree inspection, script reading, Luau execution, console output
Community Packages ProfileService, Promise, Knit, Rodux, Matter, Fusion, Iris + auto-detect from wally.toml
DevForum Search Community discussions, solutions, and announcements
Luau Language Type system, language spec, RFCs, standard library, style guide
API Dump Diffing What changed between Roblox versions
Roblox Status Service health checks

Installation

Claude Code

  1. Run /install-plugin github:CyanoTex/bloxus in Claude Code
  2. Done — Bloxus activates automatically and updates itself

Codex

  1. Copy the codex/ folder to ~/.codex/skills/bloxus
  2. Run node codex/scripts/api-dump.js fetch to cache the API dump on first use
  3. Optional: configure the Context7 MCP server for up-to-date docs lookups

OpenCode

  1. Copy the opencode/ folder into your Roblox project
  2. Copy opencode/opencode.json to your project root (or merge the context7 entry into your existing opencode.json)
  3. Run node opencode/scripts/api-dump.js fetch to cache the API dump on first use

Cursor

  1. Copy the cursor/ folder into your Roblox project
  2. Optional: add the Context7 MCP server to your workspace .mcp.json (see cursor/references/context7.md)
  3. Run node cursor/scripts/api-dump.js fetch to cache the API dump on first use

Requirements

Required

Optional

  • Roblox Studio MCP server — enables live Studio interaction (Step E). Without it, Bloxus still works using all other sources.

Data Sources & Licensing

  • API Dump: Fetched from MaximumADHD/Roblox-Client-Tracker (MIT License). Cached locally with a 7-day TTL. Downloads automatically on first use.
  • API Dump Diffing: Uses git history from the same Client-Tracker repo to compare versions.
  • Context7 sources: Queried live via MCP — no local caching of docs content.
  • DevForum: Public Discourse API — community-generated content, cross-reference with official docs.

Development Setup

After cloning, enable the project git hooks:

git config core.hooksPath .githooks

This wires up automatic version bumping — the pre-commit hook bumps the patch version in plugin.json and marketplace.json on the first code commit of each branch.

Contributing

Want to add Bloxus support for another AI tool? See CONTRIBUTING.md for the edition structure, parity requirements, and submission process.

Notes

  • The cached dump (Full-API-Dump.json) is gitignored — regenerates automatically
  • Bloxus does not store or redistribute any Roblox intellectual property — it fetches documentation on demand
  • Bloxus is updated as Roblox APIs evolve — pull the latest from this repo periodically to stay current

About

Bloxus — Roblox Knowledge Engine for Claude Code

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors