Minecraft info bot

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 TypeScript

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

Commands

help

Displays this page

Usage: !help

install

Sends the link to the installation paragraph of this file

Usage: !install

ping

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

Usage: !ping

player

Displays player's name, uuid, skin, cape

Note: Name history is no longer supported as Mojang have removed it from their API

Usage: !player <uuid/name>

repo

Sends the link to this repository

Usage: !repo

server

Gives information about the specified minecraft server

Usage: !server <ip address>

uuid

Displays the uuid associated with the specified player name

Usage: !uuid <name>

version

Returns the bot's version

Usage: !version

Installation

You can download the bot files locally and host it on your own using Node or add the already hosted bot

Git and Node

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

Download the repository using git with git clone https://github.com/Jystro/Minecraft-info-bot or by downloading a zip file and unzipping it
Open a terminal in the directory of the package.json file
Run the command npm install to download the necessary packages
Run npm start afterwards to start the bot. The first time the bot will generate some files and shut down
Follow the instructions and set the env variable DISCORD_TOKEN to your token or write it in the .env file. You can get a token here
Restart the bot once the token is set to login to Discord

Docker

If you have Docker installed on your machine, clone the repository and build the image from Dockerfile. Docker-compose.yml example is also available

Otherwise,

Remember to set the DISCORD_TOKEN and DISCORD_CLIENTID environmental variables and to create a volume for presistent data. You can find the Client_id by activating developer settings in Discord and right clicking the bot's profile -> Copy User Id

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

Contributing

If you wish to contribute to this repository please fork it

Acknowledgments

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

jystro / minecraft-info-bot Goto Github PK