Skip to content

BrewTheFox/ReKITtyPaw

Repository files navigation

ReKITtyPaw

ReKITtyPaw

ReKITtyPaw

ReKITtyPaw

What is this?

ReKITtyPaw is a Minecraft bot designed to simplify the setup of kit delivery bots in anarchy servers. Developed in JavaScript using the Mineflayer library, ReKITtyPaw aims to simplify the configuration process through an easy-to-use JSON file.

Key Features:

  • Easy to configure.

  • Compatible with almost* any server.

  • Made to be used together with discord.

How to install:

  • First of all clone the git repository of the project with this command:

git clone https://github.com/BrewTheFox/ReKITtyPaw.git ./ReKittyPaw
  • Then change the directory to ReKittyPaw:

cd ReKittyPaw
  • Install the project dependencies:

npm install

How to configure:

After you have installed the project, you should configure it in the file ./config.json. There are some important things to take into consideration.

  • Keywords

    Keyword Replaced With Used in
    {{User}} The minecraft username of the person that requested the delivery. UTPCancelMSG, UTPAcceptMSG, ExpiredTP, AcceptTPASK, ErrorMessage, UnstockedItemMessage
    {{TPAcceptTime}} The time that you've set on TPAcceptTime converted to seconds. AcceptTPASK
    {{RequestID}} A randomly generated uuid generated after the user requested the kit. ExpiredTP, AcceptTPASK, ErrorMessage, UnstockedItemMessage
    {{MinuteKitDelay}} Replaced with the value of MinuteKitDelay in the config file. KitDelayMessage
  • The example ./config.json file

    Keyword Content Usage
    token havfYeMZVkMmAfz0TiNmyFYcGk19rdSG1xV11NP2Cp8yP6pygeQndRLSyNezpCz0T9Y2BpDm3JwNUrFcUhuNtVVwzP3d2Rzwe6uw This is your discord bot token
    username MyNameIsBot Bot's minecraft username
    password ThisIsMyPassword If the server needs authentication here is where you should put the bot password
    host RandomAnarchyServer.net The minecraft server IP Address
    port 12345 The minecraft server port
    version 1.18.1 The minecraft server version
    TPDelay 5000 The delay the bot will need to wait after the user accepted the teleport request
    HomeDelay 8000 The delay the bot will need to wait after "/home" is written
    LavaCoords [-14, 65, 0] A array containing the coordinates of the lava formatted [X,Y,Z]
    TPAcceptTime 15000 How much time does the bot gives the user to accept the teleport request (Miliseconds)
    MaxDeliverKits 10 How many kits can deliver the bot per request
    BotOwner ThisIsYourMinecraftUsername Your minecraft username
    HomeMessage You are now in home The message that shows up in the minecraft chat when you've successfully teleported to your home
    HomeCancelMSG Pending teleportation request cancelled. The message that shows up in the minecraft chat when you didn't teleport to your home
    AfterRegisterMSG Successfully registered! The message that shows up in the minecraft chat when you register in the server
    AfterLoginMSG You have successfully logged in! The message that shows up in the minecraft chat when you login in the server
    RegisterMSG Please use /register 'Password' 'Password' to register. The message that shows up in the minecraft chat that asks you to register
    LoginMSG Welcome again. Please use /login 'Password' to start enjoying. The message that shows up in the minecraft chat that asks you to login
    UTPCancelMSG [RandomTPA] {{User}} cancelled your petition! The message that shows up when the user cancels your teleport request
    UTPAcceptMSG [RandomTPA] {{User}} Teleported to you! The message that shows up when the user accepts your teleport request
    AcceptTPASK You have {{TPAcceptTime}} seconds to accept your request that have the id {{RequestID}} before it cancels. The message that the bot sends to the player before sending the teleport request
    ExpiredTP The request with the id {{RequestID}} expired. The message that the bot sends after the teleport request expired
    UnstockedItemMessage One of the items that you have requested is not in stock, please try again later :( The message that the bot sends if there is no stock of certain item
    ErrorMessage There was a problem delivering the kit, please try again later :( The message that the bot sends if the delivery is cancelled
    KitSelectionMenuTitle Selection Menu - Ranarchy The discord menu embed title
    MinuteKitDelay 5 How long does the user will need to wait before begin able to request another kit
    KitDelayMessage Hey hold on you didn't wait the {{MinuteKitDelay}} minutes delay :( The message that shows up in discord when the user didn't wait the delay
    EmbedTitle Request a delivery. The /menu embed title
    Embed1Title How to? The /menu sub-embed 1 title
    Embed1Content Just click the button down this text The content of the sub-embed 1
    Embed2Title The /menu sub-embed 2 title
    Embed2Content The content of the sub-embed 2
    Embed3Title The /menu sub-embed 3 title
    Embed3Content The content of the sub-embed 3
    KitMenuOpenText Request your kit NwN The text of the button for opening the kit delivery menu
    ServerRestartError We're sorry. Our Server restarted, please try filling the form again. The error that should show up on discord when a user tries to complete a delivery but the bot restarted
    MinecraftEmptyServerError Hey. you're not on the Minecraft Server. The error that should show up on discord when there's no one in the minecraft server
    NameAskMessage Now tell me. which one is your nickname? The discord embed title of the name ask menu
    GenericError We're sorry. there was a problem handling your request. A Generic error that the discord bot will send when the error is unknown
    VoucherText Thank you for using Ranarchy delivery bot. Please wait some time for the bot to be available and delivers your kit. The discord text that will be sent on the voucher
    VoucherTitle Thank You! The title that shows up on the voucher after a kit request.
    VoucherUserField Username: The text that is over the username of the player.
    VoucherKitField Kits: The text that is over the selected kits.
    KitsDict {"KitOption1":"wither_skeleton_skull", "KitOption2":"detector_rail"} A dictionary that contains the kit options in format "kit":"representativeblock"
    RepresentativeKitEmoji 🍕 This is the emoji-text that will be shown for every kit added to the request
    SelectedKitEmoji 🌏 This is the emoji-text that will be shown at the sides of a selected kit
    UnSelectedKitEmoji 🧨 This is the emoji-text that will be shown at the sides of a non selected kit
    IsSlashKillAllowed true This should be true if you can use /kill on the server
    UserTryingToDeliverToBotError What are you doing?? This is the error that shows up when a user tries to send a kit to the bot
    ModalPlaceHolder Username... This is the placeholder of the modal input
    ModalLabel Input: This is the label that goes over the input
    ModalAskTitle What's your minecraft nickname This is the title of the modal.
    • The to-build structure

    Structure

    As you can see there are two main things here, a double chest and a marker block, the marker block is pointing at KitOption1, so when the user selects KitOption1 the bot will go to the wither skelleton skull an then the bot will open the chest. So you should put the KitsDict value as {"KitName":"representative_block"} so the structure can be detected.