\n\n`aether` (alias: `aet`) is the official developer toolkit for creating, building, developing, and packaging **extensions** and **themes** for the [Aether Minecraft Launcher](https://github.com/Aether-Launcher/Aether). It lets developers scaffold new projects, hot-reload them into the local launcher, and package them securely into `.aex` (extension) or `.theme` (appearance pack) format.\n\n---\n\n## Installation\n\n### Via npm (Recommended — No Go required)\n\nYou can run commands instantly without installing using `npx`:\n\n```bash\nnpx @aethermc/cli init my-extension com.example.myext\n```\n\nOr install globally to get `aether`, `aet`, and `aether-cli` in your terminal:\n\n```bash\nnpm install -g @aethermc/cli\n```\n\n### Via Go\n\nIf you have Go installed, you can compile and install directly from source:\n\n```bash\ngo install github.com/Aether-Launcher/aether-cli/...@latest\n```\n\nMake sure your Go bin directory is on `PATH` (`$(go env GOPATH)/bin` on macOS/Linux, `%USERPROFILE%\\go\\bin` on Windows), then open a new terminal and run:\n\n```bash\naether help\n# or using the short alias:\naet help\n```\n\n---\n\n## Commands\n\nYou can run any command using either `aether`, `aet`, or `aether-cli`.\n\n### `init` — Scaffold a new project\n\n```bash\n# Scaffold a new extension\naether init \n\n# Scaffold a new theme\naether init --theme\n```\n\n| Flag | Alias | Description |\n|:---|:---|:---|\n| `--theme` | `-t` | Scaffold a theme instead of an extension |\n\n**Extension output:**\n```\n/\n├── manifest.json # Extension metadata (id, name, version, permissions, api)\n├── package.json # npm typings dep (@aethermc/sdk)\n├── main.js # Backend sandbox entry point (Goja)\n└── ui/\n └── index.html # Frontend rendered in a sandboxed iframe\n```\n\n**Theme output:**\n```\n/\n├── package.json # Theme metadata (id, name, version, author, css, overwrite)\n├── theme.css # CSS overrides (Aether :root design tokens pre-filled)\n├── overwrite.json # Optional asset overrides (sidebar-logo, background, etc.)\n└── README.md\n```\n\n---\n\n### `dev` — Live extension hot-reloading\n\n```bash\n# Watch and hot-sync the current extension directory to Aether\naether dev\n# or\naet dev\n```\n\nValidates `manifest.json`, deploys the extension directly to your local Aether Launcher directory (`%APPDATA%\\Aether\\extensions\\` on Windows, `~/Library/Application Support/Aether/extensions/` on macOS, `~/.local/share/Aether/extensions/` on Linux), and continuously watches for file changes to keep the launcher in sync.\n\n---\n\n### `validate` — Validate an extension or theme\n\n```bash\n# Validate extension (reads manifest.json)\naether validate\n\n# Validate theme (reads package.json)\naether validate --theme\n```\n\n**Auto-detection:** if `manifest.json` is absent but `package.json` is present, the project is automatically treated as a theme.\n\n| Flag | Alias | Description |\n|:---|:---|:---|\n| `--theme` | `-t` | Force theme validation mode |\n\n**Extension checks:** `manifest.json` exists, valid JSON, required fields: `id`, `name`, `version`, `main`, `api`.\n\n**Theme checks:** `package.json` exists, valid JSON, required fields: `id`, `name`, `version`, CSS file referenced by `css` field actually exists on disk.\n\n---\n\n### `build` — Package into .aex or .theme\n\n```bash\n# Build extension → -.aex\naether build\n\n# Build theme → -.theme\naether build --theme\n```\n\n**Auto-detection:** same logic as `validate` — detects project type automatically.\n\n| Flag | Alias | Description |\n|:---|:---|:---|\n| `--theme` | `-t` | Force theme build mode |\n\nRuns validation first, then packages all project files into a zip-format archive, automatically excluding `.git/`, `node_modules/`, and existing archive files.\n\n---\n\n### `help` — Show help\n\n```bash\naether help\n# or\naet help\n```\n\n---\n\n## Quick Start — Extension\n\n```bash\naet init my-extension com.example.myextension\ncd my-extension\nnpm install # installs @aethermc/sdk for TypeScript types\naet dev # live test in local launcher\naet validate\naet build\n# → com.example.myextension-1.0.0.aex\n```\n\n## Quick Start — Theme\n\n```bash\naet init my-theme com.example.mytheme --theme\ncd my-theme\n# Edit theme.css to customise colours, radii, spacing...\naet validate\naet build\n# → com.example.mytheme-1.0.0.theme\n```\n\n---\n\n## Extension SDK\n\nThe scaffolded extension includes a dependency on [`@aethermc/sdk`](https://www.npmjs.com/package/@aethermc/sdk) — the official TypeScript SDK for Aether extensions. It provides full type definitions for the `Aether` global API and helper utilities:\n\n```bash\nnpm install --save-dev @aethermc/sdk\n```\n\nSee the [Aether SDK repository](https://github.com/Aether-Launcher/Aether-SDK) for full documentation.\n\n---\n\n## Publishing Your Extension\n\nOnce built, submit your `.aex` file alongside an entry in `index.json` to the [Aether Extension Registry](https://github.com/Aether-Launcher/Aether-Extensions) by opening a Pull Request. All extensions must comply with the [Aether Extension API License](https://github.com/Aether-Launcher/Aether-SDK/blob/main/LICENSE) — closed-source extensions are allowed, subject to Aether review.\n\n---\n\n## Development\n\nThe CLI is written in Go and uses only the standard library to keep the binary small and dependency-free.\n\n```bash\n# Build and install locally\ngo install ./...\n\n# Run either command\naether help\naet help\n```\n\n---\n\n## License\n\nLicensed under the GNU General Public License v3.0 only. See [LICENSE](LICENSE).\n","readmeFilename":"README.md"}
![\"Discord\"](\"https://img.shields.io/badge/discord-Join%20our%20Discord-5865F2?logo=discord&logoColor=white&style=for-the-badge\"){kind=icon}
\n \n