https://github.com/legopitstop/build-mcpack-action
This action compiles your addon or pack into an installable file.
https://github.com/legopitstop/build-mcpack-action
action bedrock build mcpack minecraft publish
Last synced: 2 months ago
JSON representation
This action compiles your addon or pack into an installable file.
- Host: GitHub
- URL: https://github.com/legopitstop/build-mcpack-action
- Owner: legopitstop
- Created: 2024-12-20T02:37:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-29T23:01:54.000Z (over 1 year ago)
- Last Synced: 2025-05-16T00:41:29.769Z (about 1 year ago)
- Topics: action, bedrock, build, mcpack, minecraft, publish
- Language: Python
- Homepage: https://github.com/marketplace/actions/build-mcpack-action
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# build mcpack action
This action compiles your addon or pack into an installable file.
## Features
- Customize the name of the generated artifact using patterns.
- Automatically creates a `contents.json` file listing all files included in the pack.
- Minifies all JSON files to reduce file size.
- Handles behavior packs, resource packs, and skin packs.
- Enable detailed logging for debugging purposes.
## Usage
Your YML file in `.github/workflows`
```yml
name: Build and Publish MCPACK
on:
# Run this workflow manually from the Actions tab
workflow_dispatch:
permissions:
packages: write
contents: write
id-token: write
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Bundle and create release.
id: custom_action
uses: legopitstop/build-mcpack-action@v1
with:
buildScript: "build.py"
input: src/
output: dist/
outputPattern: "NAME_ABBR-VERSION.mcpack"
```
With a reposotry structed like:
```txt
📃build.py
📁src/
├── 📁behavior_pack/
│ └── 📃manifest.json
├── 📁resource_pack/
│ └── 📃manifest.json
└── 📁skin_pack/
└── 📃manifest.json
```
## Build Script
An example build script. This is where you can automate things like generating loot tables or recipes using Python with [mcaddon](https://pypi.org/project/mcaddon/).
```Python
# File: build.py
from argparse import ArgumentParser
def build():
parser = ArgumentParser()
parser.add_argument("--example", action="store_true")
args = parser.parse_args()
log.info("Starting pack build with args: %s", args)
# Adds output.txt to behavior pack
with open('behavior_pack/output.txt', 'w') as fd:
fd.write('Hello, World!')
```
## inputs
| Name | Type | Description |
| --------------- | ------ | ---------------------------------------------- |
| `buildScript` | String | The python script to build your addon, if any. |
| `input` | String | The directory to look for packs. |
| `output` | String | The directory to place the built artifacts |
| `outputPattern` | String | The name of the compiled file. |
## outputs
| Name | Type | Description |
| ------- | ------ | ------------------------------------------------------- |
| `packs` | String | JSON array containing the metadata of all bundled packs |
## Pack Metadata
| Name | Type | Description | Examples |
| --------- | ------ | -------------------------- | ------------------------ |
| `uuid` | String | The packs UUID | |
| `version` | String | The packs version | |
| `type` | String | The type of pack | behavior, resource, skin |
| `name` | String | The packs name | |
| `abbr` | String | The abbreviated pack type. | BP, RP, SP |