Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Installation: Difference between revisions

From Leaf Essentials
Added installation guide
Line 1: Line 1:
__NOTOC__
{| style="width: 100%; background: var(--color-surface-1); border: 1px solid var(--color-surface-2); border-radius: 8px; padding: 20px;"
{| style="width: 100%; background: var(--color-surface-1); border: 1px solid var(--color-surface-2); border-radius: 8px; padding: 20px;"
| [[File:LeafEssentials_Logo.png|right|150px]]
|
__NOTOC__
{| style="width: 100%; background: var(--color-surface-1); border: 1px solid var(--color-surface-2); border-radius: 8px; padding: 20px;"
| [[File:Leaf Logo|right|150px]]
== Installation Guide ==
== Installation Guide ==
This guide will walk you through installing '''Leaf Essentials''' on your Minecraft Bedrock world, Realm, or Server.
This guide will walk you through installing '''Leaf Essentials''' on your Minecraft Bedrock world, Realm, or Server.
Line 11: Line 7:
=== 1. Download the Packs ===
=== 1. Download the Packs ===
Leaf Essentials consists of two parts. You must have '''both''' for the addon to function correctly:
Leaf Essentials consists of two parts. You must have '''both''' for the addon to function correctly:
* **Behavior Pack (BP):** Handles the logic, commands, and systems.
* '''Behavior Pack (BP):''' Handles the logic, commands, and systems.
* **Resource Pack (RP):** Handles the menus, UI, and visual elements.
* '''Resource Pack (RP):''' Handles the menus, UI, and visual elements.


> [!IMPORTANT]
{| style="width: 100%; background: #2B1515; border: 1px solid #4C1E1E; border-radius: 8px; padding: 5px; color: #DB6D6D;"
> Always ensure you are using matching versions of both the Behavior and Resource packs.
|
Always ensure you are using matching versions of both the Behavior and Resource packs.
|}


---
----


=== 2. Enabling Experimental Toggles ===
=== 2. Enabling Experimental Toggles ===
Because Leaf Essentials uses advanced scripting features, you '''must''' enable the following experiments in your world settings:
Because Leaf Essentials uses advanced scripting features, you '''must''' enable the following experiments in your world settings:


* **Beta APIs** (Required for the script engine)
* '''Beta APIs''' (Required for the script engine)
* **Holiday Creator Features** (Recommended)


'''To enable these:'''
'''To enable these:'''
# Go to your World Settings.
# Go to your World Settings.
# Scroll down to the **Experiments** tab.
# Scroll down to the **Experiments** tab.
# Toggle **Beta APIs** to "On."
# Toggle '''Beta APIs''' to "On."
# Acknowledge the warning (Minecraft will create a copy of your world).


---
----


=== 3. Applying the Packs ===
=== 3. Applying the Packs ===
# In your World Settings, navigate to **Active Packs**.
# In your World Settings, navigate to '''Active Packs'''.
# Under **Resource Packs**, find Leaf Essentials and click **Activate**.
# Under '''Resource Packs''', find Leaf Essentials and click '''Activate'''.
# Under **Behavior Packs**, find Leaf Essentials and click **Activate**.
# Under '''Behavior Packs''', find Leaf Essentials and click '''Activate'''.
# Ensure Leaf Essentials is at the '''top''' of your load order if you have other addons installed.
# Ensure Leaf Essentials is at the '''top''' of your load order if you have other addons installed.


---
----


=== 4. Setting Up Admin Permissions ===
=== 4. Setting Up Admin Permissions ===
Line 47: Line 43:
<code>/tag @s add admin</code>
<code>/tag @s add admin</code>


Once added, you can access the main menu by typing:
Once added, you can access the main menu by going to the '''Items''' section of the creative inventory scroll down and grab the [[Config UI]] Item and right click.
<code>/scriptevent leaf:open</code>
''(Or simply use the custom item provided in your inventory if enabled).''


---
----


=== 5. Installation on Realms & Servers ===
=== 5. Installation on Realms & Servers ===
* **Realms:** Apply the packs to a local world first, ensure Experiments are on, and then upload that world to your Realm slot.
* '''Realms:''' Apply the packs to a local world first, ensure Experiments are on, and then upload that world to your Realm slot.
* **Servers (BDS):** # Extract the `.mcaddon` file.
* '''Servers (BDS):''' Extract the ''.mcaddon'' file.
# Place the BP in the `behavior_packs` folder and the RP in the `resource_packs` folder.
# Place the BP in the '''behavior_packs''' folder and the RP in the '''resource_packs''' folder.
# Update your `world_behavior_packs.json` and `world_resource_packs.json` with the pack UUIDs.
# Update your '''world_behavior_packs.json''' and '''world_resource_packs.json''' with the pack UUIDs.


---
----


{| style="width: 100%; background: var(--color-surface-1); border: 1px solid var(--color-surface-2); border-radius: 5px; padding: 10px;"
{| style="width: 100%; background: var(--color-surface-1); border: 1px solid var(--color-surface-2); border-radius: 5px; padding: 10px;"
| '''Need help?''' Join our [https://discord.gg/yourlink Discord Support] or check the [[Frequently Asked Questions|FAQ]].
| '''Need help?''' Join our [https://discord.gg/yourlink Discord] For help or check the [[Frequently Asked Questions|FAQ]].
|}
|}
[[Category:Documentation]]

Revision as of 07:32, 16 February 2026

Installation Guide

This guide will walk you through installing Leaf Essentials on your Minecraft Bedrock world, Realm, or Server.

1. Download the Packs

Leaf Essentials consists of two parts. You must have both for the addon to function correctly:

  • Behavior Pack (BP): Handles the logic, commands, and systems.
  • Resource Pack (RP): Handles the menus, UI, and visual elements.

Always ensure you are using matching versions of both the Behavior and Resource packs.


2. Enabling Experimental Toggles

Because Leaf Essentials uses advanced scripting features, you must enable the following experiments in your world settings:

  • Beta APIs (Required for the script engine)

To enable these:

  1. Go to your World Settings.
  2. Scroll down to the **Experiments** tab.
  3. Toggle Beta APIs to "On."

3. Applying the Packs

  1. In your World Settings, navigate to Active Packs.
  2. Under Resource Packs, find Leaf Essentials and click Activate.
  3. Under Behavior Packs, find Leaf Essentials and click Activate.
  4. Ensure Leaf Essentials is at the top of your load order if you have other addons installed.

4. Setting Up Admin Permissions

Once you load into the world, Leaf Essentials needs to know who the administrator is.

Run the following command in chat: /tag @s add admin

Once added, you can access the main menu by going to the Items section of the creative inventory scroll down and grab the Config UI Item and right click.


5. Installation on Realms & Servers

  • Realms: Apply the packs to a local world first, ensure Experiments are on, and then upload that world to your Realm slot.
  • Servers (BDS): Extract the .mcaddon file.
  1. Place the BP in the behavior_packs folder and the RP in the resource_packs folder.
  2. Update your world_behavior_packs.json and world_resource_packs.json with the pack UUIDs.

Need help? Join our Discord For help or check the FAQ.