Skip to content

Commit e66a608

Browse files
committed
feat(github): added nice README
1 parent bf35b20 commit e66a608

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
![banner](./.github/assets/banner.png)
2+
3+
<p align="center">
4+
Webhook API is an API that makes dealing with Discord Webhooks much easier than using raw requests. API covers 100% support for HTTP modules and supports worlds!
5+
</p>
6+
7+
# 📦 INSTALLATION
8+
1. Navigate to [releases](https://github.com/m0lc14kk/WebhookAPI/releases) and download the latest one.
9+
10+
2. Install `index.js`, `index.d.ts` and `index.js.map` files and drag them into your project. If you're using TypeScript, you might want to change file extensions to `.ts` instead.
11+
12+
3. Start using our API.
13+
14+
It's that simple!
15+
16+
# 📌 REQUIREMENTS
17+
If you are using BDS (Bedrock Dedicated Server), you should use `Webhook` class. If you are using world, you're forced to use `WebSocketWebhook`.
18+
19+
- ### BDS:
20+
- Activate **Experimental Beta API** in a world.
21+
- Add `@minecraft/server-net` module to server's permissions (`config/default/permissions.json`):
22+
```json
23+
{
24+
"allowed_modules": [
25+
// Other modules does not matter.
26+
"@minecraft/server-gametest",
27+
"@minecraft/server",
28+
"@minecraft/server-ui",
29+
"@minecraft/server-admin",
30+
"@minecraft/server-editor",
31+
"@minecraft/server-net" // Paste this module at the end of a file.
32+
]
33+
}
34+
```
35+
- Add `@minecraft/server-net` to pack's manifest:
36+
```json
37+
{
38+
"dependencies": [
39+
// Other dependencies.
40+
{
41+
"module_name": "@minecraft/server-net",
42+
"version": "1.0.0-beta" // Version does not matter.
43+
}
44+
]
45+
}
46+
47+
- ### Worlds:
48+
- Download `websocket.zip` from [releases](https://github.com/m0lc14kk/WebhookAPI/releases) and check README for next steps of a WebSocket server deployment.
49+
- Copy end-point of a WebSocket Server from command.
50+
- Open your world and connect to the websocket via `/wsserver` command:
51+
```sql
52+
/wsserver <end-point>
53+
```

0 commit comments

Comments
 (0)