Merge remote-tracking branch 'origin/master'
All checks were successful
Publish Package / build (push) Successful in 20s
All checks were successful
Publish Package / build (push) Successful in 20s
This commit is contained in:
commit
2f17c4d218
30
README.md
30
README.md
@ -1,31 +1,3 @@
|
|||||||
# Minecraft Utilities - Javascript Library
|
# Minecraft Utilities - Javascript Library
|
||||||
|
|
||||||
The JavaScript library for the Minecraft Utilities API.
|
See [The Website](https://mcutils.xyz) or [Minecraft Utilities Documentation](https://mcutils.xyz/documentation) for more information.
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Install the package using npm:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install mcutils-library
|
|
||||||
```
|
|
||||||
|
|
||||||
Get player:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import { getPlayer, CachedPlayer } from "mcutils-library";
|
|
||||||
|
|
||||||
const cachedPlayer = await getPlayer(playerId);
|
|
||||||
|
|
||||||
console.log(player);
|
|
||||||
```
|
|
||||||
|
|
||||||
Get Server:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import { getServer, CachedJavaMinecraftServer } from "mcutils-library";
|
|
||||||
|
|
||||||
const cachedServer = await getServer(ServerPlatform.Java, "hypixel.net");
|
|
||||||
|
|
||||||
console.log(server);
|
|
||||||
```
|
|
Loading…
Reference in New Issue
Block a user