Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 2.7 KB

README.md

File metadata and controls

58 lines (43 loc) · 2.7 KB
Raw

ShulkerPi

License: MIT GitHub watchers GitHub stars GitHub commits GitHub branches wakatime made-with-python

ABOUT THE PROJECT

This repository contains a Discord Bot whose goal is to manage a Minecraft server hosted from a Raspberry Pi computer in your living room. This bot can start, stop and reset the server using Bash scripts as well as provide useful information to its users by displaying the world seed, the server ip or even playing statistics.

Distributed under the MIT License. See LICENSE for more information.

GETTING STARTED

CREATING A BOT

  1. You first need to create a Discord application and Bot with administrator permissions. You should follow the Discord documentation and then invite it to your Discord server through the OAuth2 panel on the developer portal.
  2. You must copy the app token on a clipboard

INSTALLATION

This process must be done on the Raspberry Pi containing the Minecraft server. You can do these commands from your home directory.

  1. Cloning the Github Repository
git clone https://github.com/EnguerranVidal/ShulkerPi.git
  1. Going in the Repository Directory
cd ShulkerPi
  1. Creating Conda Environment
conda create --name discordbot python=3.10
conda activate discordbot
  1. Installing ShulkerPi Requirements
pip install -r requirements.txt

RUNNING AT BOOT - CRONTAB

If you want your bot to run at boot from your Raspberry Pi, you must set the botStart.sh.

  1. Firstly, open the crontab file :
sudo crontab -e
  1. You can now add the following line at the end of the file with SHULKER_REPO being the directory of the ShulkerPi bot :
@reboot sudo /bin/bash SHULKER_REPO/scripts/botStart.sh