开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

Minecraft info bot

Discord Download

This project is not releated to Mojang and respects it's guidelines. Minecraft is a trademark of Mojang Synergies AB.

Minecraft info is a Discord bot written 100% in Node.js

Please note: information like the bot's token has been removed. Start the program for the first time to generate a .env file and insert your token in it or set the DISCORD_TOKEN variable in your environment

Default prefix: !

Commands

ping

Returns the response time between when the command is received and when the answer is sent

Usage: !ping

help

Displays the command list. If a command is specified, gives additional info about the command. The command always works even with the default prefix

Usage: !help [command]

prefix

Displays the current prefix for the server. Can be used with the following arguments

• set <prefix>: Changes the prefix if the user has the necessary permissions
• role: Lists all the roles who can manage the prefix
• role set <@role> [role...]: Resets the authorised roles and adds the specified ones
• role add <@role> [role...]: Adds the specified roles to the authorised roles
• role remove <@role> [role...]: Removes the specified roles from the authorised roles
• role clear: Removes all the roles from the authorised roles

Usage: !prefix

server

Gives information about the server

Usage: !server <ip address>

uuid

Displays the uuid of the specified player

Usage: !uuid <name>

player

Displays player's name, uuid, skin, cape and name history

Usage: !player <uuid/name>

install

Sends the link to the installation paragraph of this file

Usage: !install

repo

Sends the link to this repository

Usage: !repo

provider

Sends the link to the services the bot uses

Usage: !provider

version

Returns the bot's version

Usage: !version

Installation

You can download the bot files locally and host it on your own or add the official one

Git and Node

These steps are the same for both git and downloading a .zip archive

1. Download the repository using git with git clone https://github.com/Jystro/Minecraft-info-bot or by downloading a zip file and unzipping it
2. Open a terminal in the directory of the package.json file
3. Run the command bash node.sh. The code will now create two files
4. You can set the env variable DISCORD_TOKEN to your token or write it after the = character in the .env file. You can get a token here
5. Run bash node.sh again

Docker

If you have Docker installed on your machine, another option is to use a Dockerfile

There are two available options for Dockerfiles, the first being Dockerfile.lightweight and the second one Dockerfile.standalone. To install either of them, remove the extention and set the DISCORD_TOKEN environmental variable. Dockerfile.standalone requires an additional BOT_VERSION variable

• Dockerfile.lightweight: lighter, requires the repository to be locally installed. Approximate size: 65.38 MB
• Dockerfile.standalone: doesn't require any additional file. Approximate size: 79 MB

To create a lightweight container called "minecraft-info-bot", edit Dockerfile.lightweight and add your token after the DISCORD_TOKEN variable. Execute docker.sh using bash and wait for the container to be up and running

Important: Data will not be persisted if you don't use a volume or a bind mount, check docker.sh for an example of bind mount

If you need help with the bot, join the Discord server

Contributing

If you wish to contribute to this repository, please follow the indications in CONTRIBUTING.md

Acknowledgments

• Servers' info: Minecraft Server Status
• Skins and avatars: Crafatar

Libraries

• discord.js
• dotenv
• mojang-api