Kyuta Bot - Minecraft ChatBridge

Kyuta is discord chat-bridge integration for minecraft based on the bedrock-protocol library and functions similarly to ! Pixel's BDScord. Simply put we are attaching a dummy client to the selected multiplayer server and using that dummy account to intercept incoming and outgoing packets to read them and transmit their data. While application such as BDScord have more server modding capibilities, Kyuta can be used on any server despite whether you have access to server files or not. However Kyuta will still need operator perms to send messages from discord.

Commands - Usage

After installing the bot to get started all you simply have to do is run k!help to get a list of all the commands and how to use them. Here is a more detailed description of the useful commands:

• Listen

  To iniate listening to a server run the command k!listen followed by the host, port, and version of the server you wish to connect to. A fully completed command will look like this: k!listen 127.0.0.1 19132 1.17.40 . No commas need to be added inbetween paramaters.

  

  Once listening to a server Kyuta will bridge all messages inbetween the discord channel and Mincraft. Using the prefix %runraw% before any minecraft command will run it ingame just as normal, for example sending the message %runraw%summon creeper 1 20 1, will summon a creeper at 1, 20, 1. (This works well in tandem with TrapDoor to be able to see farm rates / server performance without having to be ingame!)

• Ping

  To ping a server simply run k!ping with the same paramaters as listen, except the version isnt needed. The ping command will return basic information about the queried server such as: the Header, Players Online, Max PLayers, Gamemode, Server ID, and Protocol

  

• Register

  The Register command is an optional command that will register information on the user running the command to an internal database to personalize their webhooks. To use the command properly nickname yourself as your ingame name and run the command. Your nickname, username, highest role colour, and your profile picture will be stored to customize your webhooks and help people know who is who. These two pictures below demonstate this, the first is without registration and the second is with registration

  

  

  As you can see the webhook will change to be more personalized with the registration. Server Admins can also manually register user with the following syntax: k!register manual gamerTag discordName avatarURL hexColour.

• ServerInfo

  Before using serverInfo you have to be listening to a server, once you are listening just run k!serverInfo to bring up and embed with important information on the server. If detailedInfo in config.json is set to true, more sensitve information will be displayed that could possibly cause issues if public.

  

  

Once you gave finished the setup you are ready to work! Here are a few extra tidbits i dont know where else to put:

• Sadly there are no ways currently to send an image ingame so this will have to suffice

  

• Replying is just translated like this so no one gets confused about who is speaking to who

  

• Markdowns are translated both to discord and from discord, unfortunately underlining and strikethrough markdowns dont work on the minecraft side of the bridge because of this annoying bug. (Please upvote!)

  

  

• Other basic features such as leaving, joining, and dying are all displayed aswell - commands are logged internally or can be output to the discord if "sendCommands" is set to true.

  

Installation

To start the instalation setup you can either download the latest release and unzip it, or clone the latest commit with git clone https://github.com/Sierrawastaken/Kyuta-bot.git, then cd into the directory (This might not be the most stable so i would recommend using the latest release). Then once inside the folder create a new file called config.json and create a new config file using this format. If you are using a version of Kyuta higher than v1.2, create the config.json file in the data folder. You dont have to copy the comments though as they will throw some errors.

{   
    // fill these values out with yours
    "token": "YOUR BOT TOKEN HERE",
    "webhook": "YOUR WEBHOOK LINK HERE",
    "botAv": "YOUR BOT AVATAR LINK HERE",
    "adminRoleId": "YOUR ADMIN ROL ID HERE",

    // you can change these whenever this is just the default
    "prefix": "k!",
    "runRawPrefix":"%runraw%",

    // if set to true DynamicListening will ask for a new host everytime
    // rather than using whats set in the config - useful if non-hosters are
    // setting up / using it
    "DynamicListening": true,
    
    // if set to true commands run will be output to the discord
    // through the webhook
    "sendCommands": true,

    // if set to true serverInfo will display more sensitive information
    "detailedInfo": true,

    // this will be used if DynamicListening is set to false
    // or if you enter no paramaters
    "host": "127.0.0.1",
    "port": 19132,
    "version": "1.17.40"
}

Once you have created your config file you can run your bot. First open up a terminal (make sure you are in the right directory) and run npm install. This will install all the required packages from the packages.json file. After thats finished installing you should be all ready to run the bot - simply run npm start to start it up. You should see the terminal log logged in as Kyuta or whatever you named your bot. Thats it! Its all set up, simply run k!help or read above to use it from there. You should also note the current releases randomize the ending of the chatbridge name (Kyuta37; Kyuta56), if you host a server with whitelisting it may be easier to have it not randomize the ending. To change that navigate to the serverConnect.js file (./remoteUses/serverConnect.js) and change the random constant to a number. (Its random for now so that several clients can connect at once without conflicts)

Made by Sierra#7079 with love :lovethat:

Join Auxo or Stratos if you need help with anything!