Installation: Difference between revisions
Added installation guide |
|||
| Line 1: | Line 1: | ||
{| 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;" | ||
| | | | ||
== 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. | ||
* | * '''Resource Pack (RP):''' Handles the menus, UI, and visual elements. | ||
{| 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. | |||
|} | |||
--- | ---- | ||
=== 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) | ||
'''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 | # Toggle '''Beta APIs''' to "On." | ||
--- | ---- | ||
=== 3. Applying the Packs === | === 3. Applying the Packs === | ||
# In your World Settings, navigate to | # In your World Settings, navigate to '''Active Packs'''. | ||
# Under | # Under '''Resource Packs''', find Leaf Essentials and click '''Activate'''. | ||
# Under | # 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 | 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 === | === 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. | ||
# Place the BP in the | # Place the BP in the '''behavior_packs''' folder and the RP in the '''resource_packs''' folder. | ||
# Update your | # 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 | | '''Need help?''' Join our [https://discord.gg/yourlink Discord] For help or check the [[Frequently Asked Questions|FAQ]]. | ||
|} | |} | ||