npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mcws

v1.0.0-npm

Published

Minecraft Bedrock or Education Edition WebSocket Server

Downloads

5

Readme

Minecraft WebSocket Server Framework

This framework allows you to easily develop Minecraft WebSocket-based plugins.

Here are some features:

  • Command provided: You can use MCWS.uri function to get commands which can be pasted to connect to the server directly in the command line of Minecraft Bedrock or Education Edition.
  • Friendly interface: This package provides a simple interface to easily start development.
  • Plugin supported: You can develop plugins and use them easily.
  • Hot reload supported: You can hot reload plugin when developing them.
  • Typescript supported: This package is developed by Typescript and you can get friendly type prompts.

How to use:

  1. Import this package
    Use import MCWS from 'mcws' or const { MCWS } = require('mcws') to import constructor.
  2. Start your server
const server = new MCWS({
    port: 11799
})
  1. Connect to Minecraft Use server.uri to get commands to paste. The return of this function will be an array of string. For instance,
[
  '/connect 127.0.0.1:11799',
  '/connect [::1]:11799',
  '/connect 172.19.185.111:11799',
  '/connect [fe80::215:5dff:fece:a2c9]:11799'
]
  1. Waiting for connections Use server.onConnected to handle sockets. Here's an example.
server.onConnected((socket) => {
    console.log('Connected to Minecraft');
    socket.sendCommand('say Hello Minecraft');
});
  1. You can use socket.sendCommand(command: string) to send a command to Minecraft. And you can get the command status by using sendCommand(command: string).then(data => console.log(data)).
  2. You can also use socket.on(eventName: string, callback: (data) => void) to handle events.
  3. Use server.dispose() to close server.
  4. Use socket.use() to activate plugins. Here's an example.
/* plugin type: 

interface pluginStructure {
    uuid: string;
    name: string;
    description: string;
    eventListeners: {
        event: McEventName;
        handler: (data: eventResponse['body']) => void;
        id: number;
    }[];
    onDispose?: CallableFunction;
}
type plugin = (sendCommand: (command: string) => void) => pluginStructure;

*/
const state = socket.use(plugin);
state.dispose(); // remove plugin