How To Set Up Your Repository

A guide to ensure your addon packages correctly.

Setup Steps

Create a new repository on GitHub for your addon.
Structure your addon files within the repository according to the guidelines below.
Ensure both your Behavior Pack and Resource Pack folders contain a valid `manifest.json` file.
Push your changes to your GitHub repository.
Use the `/package` command in our Discord server, providing the link to your repository.

Directory Structure

For the Addon Packager Bot to correctly package your addon, your repository must follow a specific directory structure. At the root of your repository, the bot looks for a folder that contains "BP" for the Behavior Pack and a folder that contains "RP" for the Resource Pack. The folder names can be anything, as long as they include "BP" or "RP".

Example Structure

Here is an example of a valid repository structure:

my-addon-repo/
├── MyAddon-BP/
│   ├── manifest.json
│   ├── items/
│   └── ... (other behavior pack files)
├── MyAddon-RP/
│   ├── manifest.json
│   ├── textures/
│   └── ... (other resource pack files)
└── ... (other files like README.md, .gitignore, etc.)

Manifest Files

Both the Behavior Pack and Resource Pack folders must contain a valid manifest.json file. The bot uses these files to identify the packs and their dependencies.

Back to Home