This project is designed for Minecraft Clients/Modpacks to have a base WebSocket for their cosmetic systems.

To setup the WebSocket you can run the following commands:

git clone https://github.com/ethan-davies/MinecraftWebSocket.git

That will clone the repository to your current locatation. Please do note that you must have git installed for this to work. After that, you can cd into the directory by doing:

cd MinecraftWebSocket

Then, install the packages by running

npm install
# or
yarn install
# or 
pnpm install

Finnaly, if you would like to run the WebSocket run

npm run dev
# or
yarn dev
# or
pnpm dev

For connecting to the WebSocket please refer to this section

The whole idea of the Minecraft WebSocket is for it to be customisable for the clients needs. Here are some of the things that you can change and how:

• Port
  • The Port can be customised through the .env under the PORT value. If not set this will default to 3000
• validTypes
  • You can customise the validTypes through the enums.ts file and add a custom reponse in the switch case within handleMessage.ts
• defaultMessages
  • Default messages are mostly found in the two files: handleMessage.ts and index.ts
• Anything
  • This project is open sourced so you can customise anything to your likings

Connecting a client to your WebSocket will vary based on the langauge. However, I have gave a basic demonstration in how to use it in JavaScript. This can be found in the connect.js file which is easily ran by running the connect script. You can use this JavaScript file to simulate a connection from your client for testing purposes.