bloxxy
v1.4.0
Published
AI-Powered Roblox Game Development CLI
Maintainers
Readme
Bloxxy
AI-Powered Roblox Game Development CLI
Bloxxy is a command-line tool that uses Claude AI to help you build Roblox games faster with production-quality code, built-in security linting, and intelligent project management.
Features
- AI Code Generation: Generate Roblox Lua code from natural language descriptions
- Multiple LLM Support: Claude, OpenAI, Mistral, GLM, and Ollama providers
- Security First: Built-in anti-exploit patterns and security linting
- Project Management: Structured project templates and organization
- Interactive CLI: Beautiful, user-friendly command-line interface
- Configuration Management: Flexible project configuration system
Installation
Global Installation (Recommended)
npm install -g bloxxyDevelopment Installation
git clone <repository-url>
cd bloxxy
npm install
npm linkQuick Start
Interactive Mode (Recommended)
Simply run bloxxy without any arguments to enter interactive mode:
bloxxyThis launches an interactive session where you can use commands continuously without typing "bloxxy" each time:
🧱 bloxxy> / # Shows interactive command menu
🧱 bloxxy> /init
🧱 bloxxy> /config set api-key sk-ant-...
🧱 bloxxy> /generate create a damage system
🧱 bloxxy> @read package.json
🧱 bloxxy> @search function src/
🧱 bloxxy> @run git status
🧱 bloxxy> /help
🧱 bloxxy> /exitTraditional CLI Mode
- Initialize a new project
bloxxy init- Configure your API key
bloxxy config set api-key sk-ant-...- Generate code (Coming Soon)
bloxxy generate "create a damage system"Commands
Interactive Mode Commands
When in interactive mode, use these slash commands:
/help- Show all available commands/init- Initialize a new project/status- Show project status/projector/info- Show current project info/config get <key>- Get configuration value/config set <key> <value>- Set configuration value/config list- List all configuration/generate <prompt>- Generate code (coming soon)/review <path>- Review code (coming soon)/clearor/cls- Clear the screen/exitor/quitor/q- Exit interactive mode
Note: Commands work with or without the / prefix in interactive mode!
Interactive Command Palette
Type / by itself to open an interactive command palette where you can browse and select commands using arrow keys.
@ Shortcuts (Amp-style)
For quick actions, use @ shortcuts:
@read <file>- Read and display file contents@search <pattern> [path]- Search for text in files@edit <file>- Edit a file (coming soon)@run <command>- Run a shell command@list [path]- List directory contents@help- Show @ shortcuts help
Tip: Use Tab completion for both / commands and @ shortcuts!
Traditional CLI Commands
bloxxy init- Initialize a new Bloxxy projectbloxxy status- Show current project statusbloxxy config <action> <key> [value]- Manage configurationbloxxy config get <key>- Get configuration valuebloxxy config set <key> <value>- Set configuration valuebloxxy config list- List all configuration values
Code Generation (Coming Soon)
bloxxy generate <prompt>- Generate code from descriptionbloxxy generate-ui <prompt>- Generate UI componentsbloxxy generate-module <name>- Generate a Lua modulebloxxy batch <file>- Batch generate from file
Code Quality (Coming Soon)
bloxxy review <path>- Review code for issuesbloxxy lint <path>- Lint generated code
Templates (Coming Soon)
bloxxy templates- List available templatesbloxxy create-from-template <name>- Create from template
Help
bloxxy help- Show help menubloxxy --version- Show version
Configuration
Bloxxy uses a bloxxy.config.json file in your project root:
{
"project_name": "My Game",
"roblox_user_id": 123456789,
"src_path": "./src",
"output_path": "./output",
"api_key": "",
"agent_settings": {
"model": "claude-sonnet-4-20250514",
"temperature": 0.7,
"max_tokens": 4000,
"ask_clarifying_questions": true
},
"code_generation": {
"include_comments": true,
"include_error_handling": true,
"anti_exploit_level": "high",
"code_style": "idiomatic_lua"
},
"linting": {
"enabled": true,
"security_level": "strict",
"performance_level": "medium"
}
}Project Structure
After running bloxxy init, your project will have this structure:
my-game/
├── bloxxy.config.json
├── src/
│ ├── ReplicatedStorage/
│ ├── ServerScriptService/
│ ├── StarterPlayer/
│ └── StarterGui/
├── templates/
└── .bloxxy/Requirements
- Node.js >= 14.0.0
- API key for your preferred LLM provider:
- Claude API key (get one at https://console.anthropic.com)
- OpenAI API key (get one at https://platform.openai.com)
- Mistral AI API key (get one at https://console.mistral.ai)
- GLM API key (get one at https://open.bigmodel.cn)
- Ollama (local setup required)
Development
Building from Source
npm install
chmod +x bin/bloxxy.js
npm linkProject Architecture
bloxxy/
├── bin/ # Entry point
├── src/
│ ├── cli/ # CLI commands
│ ├── core/ # Core logic
│ ├── utils/ # Utilities
│ └── templates/ # Config templates
└── templates/ # Project templatesRoadmap
- [x] Phase 1a: Foundation (CLI, config, project setup)
- [x] Interactive Mode (Claude Code-style REPL)
- [x] Red Brick Theme & Branding
- [ ] Phase 1b: Claude API integration
- [ ] Phase 2: Code generation
- [ ] Phase 3: Security linting
- [ ] Phase 4: Templates system
- [ ] Phase 5: Advanced features
Contributing
Contributions are welcome! Please read the contributing guidelines before submitting PRs.
License
MIT
Support
- Documentation: https://bloxxy.dev/docs (coming soon)
- Issues: https://github.com/your-repo/bloxxy/issues
- Discord: https://discord.gg/bloxxy (coming soon)
Built with Claude AI by Anthropic
