Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create WebSocket #956

Open
wants to merge 1 commit into
base: wiki
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/WebSocket/index.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make folders use snake_case, in this case, web_socket.

Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Getiing Started
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix the typo.

---


# What is WebSocket?

WebSocket is a protocol enabling real-time, two-way communication between a client and server over a persistent connection.

# How can WebSocket be used in Minecraft?
You can subscribe to events and inspect packets to use external APIs in Minecraft.

# Installation Guide
Create a folder and run this command in the terminal.
```bat
npm init -y
npm install ws uuid
```
Once the ``package.json``, ``package-lock.json``, and ``node_modules`` have been created, the installation is complete

If the installation is complete, create an ``index.js`` file inside the folder.

Next, run the command prompt as an administrator and execute the following command.
```bat
CheckNetIsolation LoopbackExempt -a -n="Microsoft.MinecraftUWP_8wekyb3d8bbwe"
```
If you are using the beta version of Minecraft, execute the following command.
```bat
CheckNetIsolation LoopbackExempt -a -n="Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe"
```
This is to prevent WebSocket connection failure.