Skip to content

Commit 3d017ac

Browse files
committed
updated readme
1 parent 722776e commit 3d017ac

File tree

3 files changed

+5468
-1
lines changed

3 files changed

+5468
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,25 @@
11
# ClaimAPI
2-
ClaimAPI
2+
3+
ClaimAPI is a [BeAPI](https://github.com/MCBE-Utilities/BeAPI) module that allows players to create claimed boundaries so that untrusted players can not interact with that claimed land.
4+
5+
The module can be either imported as a Minecraft Bedrock Addon or be used within another BeAPI project.
6+
7+
## Installing as an Addon
8+
* Requirements
9+
* [Minecraft Bedrock ^1.18.10.x](https://minecraft.net/)
10+
11+
To download and install, download the latest .mcpack release from [here](https://github.com/MCBE-Utilities/ClaimAPI/releases/tag/1.0.0).
12+
Once you have downloaded the addon, import the .mcpack into Minecraft Bedrock.
13+
Then, create a new world, or add to existing, and make sure to enable Gametest Framework.
14+
Finally, you now have ClaimAPI installed on your Bedrock world.
15+
16+
## Installing as a Dependency
17+
* Requirements
18+
* [node.js](https://nodejs.org/)
19+
* [BeAPI](https://github.com/MCBE-Utilities/BeAPI)
20+
* [Minecraft Bedrock ^1.18.30.x](https://minecraft.net/)
21+
22+
To download and install, you can either git clone this repo and use the mcpe pack, or run the command below in your BeAPI project.
23+
```npm install @mcbeutils/claimapi```
24+
Once you have done that, you can now import "@mcbeutils/claimapi" into your main project.
25+
![image](public/import.png)

0 commit comments

Comments
 (0)