Skip to content

A Flask REST API that serves a list of online players in a Minecraft Realms server

Notifications You must be signed in to change notification settings

bhnord/minecraft-realms-api-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Minecraft Realms API Server (Discord Bot Integration)

This server displays players online in your realms server(s) it hosts a basic local server to serve the Minecraft Realms API it works in tandem with the bot developed here that displays this information in Discord

Setup

Entering your login information

  1. create a new file called .env in the base path.
  2. in the .env file, enter your username, email, and password, as well the server id of the Realms server you want to track in the following format:
USERNAME="your_username_here"
EMAIL="your_email_here"
PASSWD="your_passwd_here"
SERVER_ID="your_server_id_here"

Use the Realms API (see here) to find out your server ID

Running a virtual environment

run the following comamnds (Unix)

  1. python3 -m venv .venv to setup a virtual environment
  2. source ./.venv/bin/activate to enter the virtual environment
  3. pip install -r requirements.txt to install the necessary dependencies

Running the Application

run the flask app (flask run) and the server will start up

About

A Flask REST API that serves a list of online players in a Minecraft Realms server

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages