https://github.com/bluefrog130/mcaddon
https://github.com/bluefrog130/mcaddon
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bluefrog130/mcaddon
- Owner: BlueFrog130
- License: mit
- Created: 2022-07-06T00:30:22.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-09T04:49:23.000Z (almost 4 years ago)
- Last Synced: 2025-02-21T05:07:01.299Z (over 1 year ago)
- Language: JavaScript
- Size: 48.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Warning
mcaddon and GameTest as a whole is still in beta. Expect bugs and breaking changes!
## Overview
Super fast way to generate a Minecraft Addon project.
- ⚙ Generate Behavior Pack
- 💻 GameTest Integration
- 🔑 Full TypeScript Support
- 🎨 Generate Resource Pack
- ⚡ Incredibly fast builds
## Getting Started
Quickest way to get started:
```bash
npm init mcaddon my-addon
cd my-addon
npm install # or pnpm install, yarn, etc.
npm run dev
```
### Build
Builds and copies all assets over to `development_*_packs`.
```bash
npm run build
```
### Watch
Builds and copies all assets over to `development_*_packs`. Then watches for changes and rebuilds whenever any file gets changed.
```bash
npm run watch
```
### Package
Bundles behaviors and resources and packages them into an `.mcaddon` file.
```bash
npm run package
```
## Packages
| Package |
| --------------------------------- |
| [create-mcaddon](packages/create) |
| [@mcaddon/kit](packages/kit) |
## TODO
- [x] Project generator
- [x] Automatic building/deployment to `development_*_packs`
- [x] GameTest integration
- [ ] Mac/Linux support
- [ ] Dedicated Server support
- [x] Schema Support (via VSCode plugin)
- [ ] mcaddon lang (use JS/TS to create packs)
- [ ] Config file to customize directories
## License
[MIT](LICENSE)