arcane-builder
v0.1.0
Published
File-based Discord bot framework CLI
Readme
Arcane Builder
Arcane Builder is a JSON-first Discord bot framework and CLI focused on clean structure, fast iteration, and package-based extensibility.
Documentation
Docs Site: https://ramkrishna-js.github.io/arcane-builder/
Key pages:
- Home:
docs/index.md - Overview:
docs/overview.md - Architecture:
docs/reference/architecture.md - Local Testing:
docs/reference/local-testing.md - GitHub Pages Deploy:
docs/reference/github-pages.md
1. Quick Start
npm install -g arcane-builder
arcane init my-bot
cd my-bot
cp .env.example .env
# set DISCORD_TOKEN in .env
arcane validate
arcane dev2. Core CLI
arcane init <name> [--template default]
arcane create <command|event|package> <name>
arcane dev
arcane start
arcane deploy [--pm2 --name arcanebuilder]
arcane validate [--strict]
arcane package <add|remove|list> [name]3. Why Arcane Builder
- JSON-first command/event/package architecture
- Recursive file scanning for nested project layouts
- Validation before runtime failures
- Hot reload development workflow
- Monorepo-friendly structure direction
4. GitHub Pages Docs Deployment
- Workflow:
.github/workflows/deploy-docs-github-pages.yml - MkDocs config:
mkdocs.yml - Docs source:
docs/ - Build output:
site/
5. Branding
- Primary hero (used above):
assets/branding/banner-social.svg - Secondary wide banner:
assets/branding/banner-horizontal.svg - Features banner:
assets/branding/features.svg - Logo:
assets/branding/logo.svg
6. Made By
Made by Ramkrishna.
7. Open Source
- Contributing guide:
CONTRIBUTING.md - Code of Conduct:
CODE_OF_CONDUCT.md
