How to install No Potion Particles Mod [ DOCUMENTATION ]

[josephdpurcell]

This is a non-exhaustive guide on how to install the No Potion Particles mod from foxynotail using the itzg/docker-minecraft-bedrock-server project.

I thought this would be a nice companion to the README of this project. I'm using the same terminology of "mod" instead of addon or pack, etc.

NOTE: There's at least two ways to do this, one is to put everything into the worlds directory as explained in #194 (comment). That seems like a better approach. But, I didn't follow that approach.

Requirements

This assumes you're using this project to run your Minecraft server.

It assumes you know how to read and edit JSON. If you do not check out a "Tutorial" here https://github.com/burningtree/awesome-json#tutorials.

1 - Download the mod

Go to https://foxynotail.com/resource-packs/no-potion-particles and click the download latest button. CAUTION! It is not advised to go around the Internet clicking random links. I've noticed Minecraft websites have a large number of ads and fake download links. foxynotail's site is pretty good, but please be careful.

Mods will come in different extensions so these instructions may differ for other mods.

The file you get in this case will be no-potion-particles-v1.0.0.mcpack and here is the md5sum and shasum for the file I downloaded 2023-12-16:

$ shasum no-potion-particles-v1.0.0.mcpack 
16978d443ed3b8f98a26ba40ab615fd9f0f710d7  no-potion-particles-v1.0.0.mcpack

$ md5sum no-potion-particles-v1.0.0.mcpack 
29ce794e5c48f43108591324b58911c1  no-potion-particles-v1.0.0.mcpack

2 - Obtain the Version, UUID, and Type

Well, its a .mcpack file which is just a zip file. So we can unzip it using your favorite unzipper.

Inside of it you'll have a manifest.json file:

$ cat manifest.json 
{
    "format_version": 2,
    "header": {
        "description": "Pack By §6FoxyNoTail§r | Removes Potion & Beacon Particles | @foxynotail | Visit §9www.foxynotail.com§r for more packs and add-ons | © 2020, FoxyNoTail",
        "name": "§6Foxy's§r §l§bNo Potion Particles§r v1.0.0 [R]",
        "uuid": "3648da5b-9422-43e1-af28-8e65a95c87e8",
        "version": [1, 0, 0],
        "min_engine_version": [ 1, 16, 0 ]
    },
    "modules": [
        {
            "type": "resources",
            "uuid": "bd1ce7d7-c606-4015-9971-e3411683b1bb",
            "version": [1, 0, 0]
        }
    ]
}

You can see the UUID is 3648da5b-9422-43e1-af28-8e65a95c87e8 and version is 1.0.0.

Finding the type is tricky. There's two ways to know the type.

One way is to read the manifest.json itself. Looking at the Microsoft documentation https://learn.microsoft.com/en-us/minecraft/creator/documents/comprehensivepackcontents?view=minecraft-bedrock-stable#manifestjson it seems you can tell based on "type". The type is found in the manifest.json file in the "modules" section you'll see "type": "data" or "type": "resources". If it's data its a behavior pack and if its resources its a resource pack.

In this case, the type in the manifest.json is "resources" so we know its a resource pack.

Another way to tell is the file extension of the downloaded mod. Generally a behavior pack has .mcaddon extension and resource pack has .mcpack extension.

This one was a .mcpack so we know its a resource pack.

3 - Copy the mod file

First, your Minecraft server should have a data directory somewhere, it depends on how you set it up. In my case I mounted the local directory, you can see my docker-compose.yml in #194 (comment).

The file we're going to copy there is the .mcpack file we downloaded. Other mods might require copying a file that was actually nested inside of a downloaded zip, so this may look different for other mods.

Our mod is a resource pack so we'll move it in into that directory like so:

$ cp ~/Downloads/no-potion-particles-v1.0.0.mcpack ./data/resource_packs/

$ ls data/resource_packs/*.mcpack
data/resource_packs/no-potion-particles-v1.0.0.mcpack

4 - Update the valid_known_packs.json

Edit the data/valid_known_packs.json file. This file is a JSON array of objects. Each object is in the format:

        {
                "file_system" : "RawPath",
                "path" : "{path}",
                "uuid" : "{uuid}",
                "version" : "{version}"
        }

Where {path} is the path relative from your data directory to the mod, {uuid} is your mod's UUID found in the manifest, and {version} is the version of your mod as a string.

In our case we'll add it like so:

        {
                "file_system" : "RawPath",
                "path" : "resource_packs/no-potion-particles-v1.0.0.mcpack",
                "uuid" : "3648da5b-9422-43e1-af28-8e65a95c87e8",
                "version" : "1.0.0"
        }

Note: after restarting the server you may notice this file changes in ordering of the contents. That's OK.

5 - Update world_resource_packs.json

In a basic installation with one world you will find your world_resource_packs.json file here: data/worlds/Bedrock level/world_resource_packs.json.

If you have never added a mod before you will need to create this file.

The contents of the file will include your mod's UUID and version, but the version is written as an array instead of a string (so instead of a semver string 1.0.0 you would write [ 1, 0, 0 ].

Here is what ours will look like:

[
        {
                "pack_id" : "3648da5b-9422-43e1-af28-8e65a95c87e8",
                "version" : [ 1, 0, 0 ]
        }
]

6 - Restart the server and connect

Restart your server. In the case of using docker compose you would run:

docker compose stop

Then:

docker compose up

You will not see the mod listed on startup in the server logs. Instead, connect to the server from one of your Minecraft clients and you will be prompted to "Download & Join" which will install the resource pack.

As foxynotail calls them, no more fart bubbles!