Installation

This guide walks you through installing Obsidian Essentials on your Minecraft Bedrock world or realm.

Requirements

Before installing, make sure your setup meets these requirements:

Minecraft Bedrock Edition version 1.21.0 or higher
A world or realm where you have operator (OP) permissions
The Obsidian Essentials add-on file (.mcaddon)

Step 1 - Import the Pack

Locate the Obsidian Essentials .mcaddon file you downloaded.
Double-click the file. Minecraft should open automatically and begin importing both the Behavior Pack and Resource Pack.
Wait for the import confirmation message to appear in Minecraft.
If the packs do not import automatically, close Minecraft if its open, then open the file from your file manager.

Step 2 - Apply the Packs to Your World

The .mcaddon contains a linked Behavior Pack and Resource Pack. Activating the Behavior Pack will automatically activate the Resource Pack as well.

For a Local World

Open Minecraft and go to Play.
Find your world and click the Edit (pencil) icon.
Select Behavior Packs from the left menu. Under My Packs, find Obsidian Essentials and click Activate. The Resource Pack will activate automatically.
Still in the world settings, scroll down to Experiments and make sure Beta APIs (also listed as Scripting APIs on some versions) is enabled. The add-on will not work without this.
Click Play to launch the world.

If Minecraft prompts you to confirm enabling experiments when activating the pack, click Activate Experiments. If it does not prompt you, check the Experiments section manually before launching.

For a Realm

Open Minecraft and go to Realms.
Select your realm and click the Edit (pencil) icon.
Go to Behavior Packs, find Obsidian Essentials under My Packs, and click Activate. The Resource Pack will activate automatically.
Confirm that Beta APIs is enabled under the Experiments section of the realm settings.
The changes will apply the next time players join the realm.

Step 3 - Verify Installation

Once in the world:

Make sure you have operator status (OP).
Run the owner setup command. Nothing will work until this is done:
```
/scriptevent realm:setup
```
Once setup is complete, type the following in chat to confirm the add-on is running:
```
!version
```
You should see the current version number in chat.

Troubleshooting Installation

The packs are not showing up in my pack list. Make sure the .mcaddon file imported successfully. Try closing and reopening Minecraft, then check under Behavior Packs.

Commands are not working. Confirm that experimental features are enabled in your world settings. Also check that the behavior pack is actually active on the world, not just imported.

I get an error about "Beta APIs". Go to your world settings, find Experiments, and enable Beta APIs. Save and relaunch.

Next Steps

Once installed, move on to First Setup to configure the add-on and claim your owner role.