Important

** REQUIRES PYTHON 3.12.7+ **
pip install -U requirements.txt

Caution

Policy for upstream use

#1) Assets that would result in your or others delistment will be considered forbidden.

#2) No cheats, such as grenade trail PK3s, or invisible scopes are permitted.

#3) If you are modifying existing assets, you must include this in your repository description.

#4) Your release tags on your repository must follow semantic versioning.

#5) Ensure you have no stolen assets and provide an index of special thanks & credit attribution.

#6) All assets must be MBII related upon inspection.

Note

Adding your own MBII project

#1) Create a github repository.

#2) On your created repository, place and push your custom assets.

#3) Go to the releases tab, create a release with semantic versioning and the release package as release.zip with your .PK3 inside.

#4) Ensure your .PK3s share static names or they will lose release sync, this is IMPORTANT.

#5) Create a fork of this repository.

#6) Edit repositories.json in the root working directory of the forked repository, fill out the following:

"name" - following the format of your repo URL, "{USER OR ORG}/{REPO NAME}"
"custom_name" - required, a brief name descriptor of your custom asset
"description" - description of your custom asset, default obtained by repository
"url" - your URL to the repository, "https://github.com/{USER OR ORG}/{REPO NAME}"

Respect indentation and properly close brackets, and ensure proper character escapes,
Manage your entries in alphabetical order.

[
    {
        "name": "USERorORG/repository",
        "custom_name": "MyModName",
        "description": "My mod description",
        "url": "https://github.com/USERorORG/repository"
    },
    {
        "name": "USERorORG/repository",
        "custom_name": "MyModName",
        "description": "My mod description",
        "url": "https://github.com/USERorORG/repository"
    }
]

(OPTIONAL)
#7) Edit servers.json in the root working directory of the forked repository, fill out the following:

{
  "server_name": "custom_name"
  -- ensuring the custom_name for content matches the server name in browser entry, in most cases they will usually be named the same
  -- the server name is not strict, but instead looks for your addon in string of server names, best to not hardcode server names to your addons
  - example: "Supremacy": "Supremacy"
}

This will allow content creators to add their addons in the server names of scraped servers, allowing complete addon sync.

#8) Push and commit your changes.

#9) Open a pull request to the merge branch of the upstream repository.