1.0.2
Documentation update
This commit is contained in:
1 parent
f15ace5865
commit
110518085e
12 files changed
No files matched your search
@@ -0,0 +1,109 @@
|
||||
# Getting Started
|
||||
|
||||
This guide will walk you through the basic process of using RS-MobCages.
|
||||
|
||||
With RS-MobCages, you can capture supported mobs, carry them in your inventory, transport them to another location, and release them when you are ready.
|
||||
|
||||
---
|
||||
|
||||
## The Basic Process
|
||||
|
||||
Using a Mob Cage follows a simple process:
|
||||
|
||||
1. Obtain an empty Mob Cage.
|
||||
2. Capture a supported mob.
|
||||
3. Carry the filled cage to a new location.
|
||||
4. Release the mob.
|
||||
5. Reuse the empty cage.
|
||||
|
||||
---
|
||||
|
||||
## Step 1 — Obtain an Empty Mob Cage
|
||||
|
||||
Before you can capture a mob, you need an empty Mob Cage.
|
||||
|
||||
Make sure you have the cage available in your inventory and place it in your main hand.
|
||||
|
||||
---
|
||||
|
||||
## Step 2 — Find a Supported Mob
|
||||
|
||||
Locate a mob supported by RS-MobCages.
|
||||
|
||||
Not every entity can be captured.
|
||||
|
||||
For example, players cannot be captured, and protected mobs such as named mobs may also be prevented from being captured.
|
||||
|
||||
For a complete list of supported mobs, see:
|
||||
|
||||
➡️ [Supported Mobs](./docs/Supported-Mobs.md)
|
||||
|
||||
---
|
||||
|
||||
## Step 3 — Capture the Mob
|
||||
|
||||
Hold an empty Mob Cage in your main hand.
|
||||
|
||||
Use the cage on a supported mob to capture it.
|
||||
|
||||
If the capture is successful:
|
||||
|
||||
- The mob is removed from the world.
|
||||
- The Mob Cage becomes a filled cage.
|
||||
- The captured mob can now be transported in your inventory.
|
||||
|
||||
The filled Mob Cage stores the information needed to release the mob later.
|
||||
|
||||
---
|
||||
|
||||
## Step 4 — Transport the Mob
|
||||
|
||||
Once captured, the Mob Cage can be carried in your inventory.
|
||||
|
||||
Take the cage wherever you want to move the mob.
|
||||
|
||||
This makes it easier to relocate mobs without using leads, boats, minecarts, or other traditional transportation methods.
|
||||
|
||||
---
|
||||
|
||||
## Step 5 — Release the Mob
|
||||
|
||||
When you reach the desired location, use the filled Mob Cage to release the captured mob.
|
||||
|
||||
The mob will be recreated in the world.
|
||||
|
||||
After the mob has been released, the cage becomes empty and can be used again.
|
||||
|
||||
For more information, see:
|
||||
|
||||
➡️ [Releasing Mobs](./docs/Releasing-Mobs.md)
|
||||
|
||||
---
|
||||
|
||||
## Important Notes
|
||||
|
||||
### Named Mobs
|
||||
|
||||
RS-MobCages protects named mobs from being accidentally captured.
|
||||
|
||||
If a mob has been given a custom name, the plugin may prevent it from being placed inside a Mob Cage.
|
||||
|
||||
This helps protect important or decorative mobs from accidental removal.
|
||||
|
||||
---
|
||||
|
||||
### Players Cannot Be Captured
|
||||
|
||||
Mob Cages are intended for supported mobs only.
|
||||
|
||||
Players cannot be captured.
|
||||
|
||||
---
|
||||
|
||||
### Unsupported Mobs
|
||||
|
||||
If a mob is not supported, RS-MobCages will not capture it.
|
||||
|
||||
For a complete list of supported mobs, see:
|
||||
|
||||
➡️ [Supported Mobs](./docs/Supported-Mobs.md)
|
||||
Reference in new issue
Block a user