Giter Club home page Giter Club logo

papyrus-bot's Introduction

Papyrus Bot for Minecraft Bedrock Edition

This is a bot that will join your Minecraft Bedrock Edition server, and serve up chat messages and player positions on a WebSocket for PapyrusCS.

Your server must have online-mode=false and allow-cheats=true.

Launching

Create a systemd service (or run the Docker command from the command line) somewhere, setting the MINECRAFT_SERVER_HOST and optionally MINECRAFT_SERVER_PORT addresses:

[Unit]
Description=Minecraft Bot

[Service]
ExecStart=/usr/bin/docker run --rm --name=papyrus -p 80:8080 -e MINECRAFT_SERVER_HOST=your.minecraft.server hachque/papyrus-bot
Restart=always

[Install]
WantedBy=multi-user.service

Then systemctl enable minecraft-bot.service && systemctl start minecraft-bot.service.

When the bot joins the server, you must change set permission level to operator. You must do this whenever the bot reconnects, as it uses a unique user ID every time.

Usage

The command above will serve up a WebSocket on port 80. There's no Papyrus map software that uses this endpoint... yet.

Features

This bot has the following features:

  • Monitors chat messages
  • Periodically checks player positions in the Overworld
  • Correctly detects when people are in the Nether or The End (and doesn't try to show their position, due to Bedrock limitations)
  • Automatically goes to sleep so that players can still skip time overnight

Demo

You can see one of these WebSockets in action by connecting to ws://june-mc-websocket.redpoint.games with Simple WebSocket Client. Depending if there are people on the server, you'll see something like this:

A screenshot

License

This software uses LGPL licensed libraries, in particular https://github.com/NukkitX/Protocol.

papyrus-bot's People

Contributors

hach-que avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.