Skip to content
This repository has been archived by the owner on Mar 27, 2022. It is now read-only.

cpolanec/minecraft-server-controller

Repository files navigation

Minecraft Server Controller

Resources for managing a Minecraft server farm (e.g. getting server and user information, shutting down idle servers, etc.)

deploy codecov license Contributor Covenant

Overview

This application is mainly a set of Lambda functions that are chained together into workflows. These workflows are meant to save compute costs and backup game data. Here is a breakdown the main application components:

Component Value
Lambda functions Foundational capabilities for interacting with the game servers
API Gateway Simple means to invoke/integrate the Lambda functions
Step Functions Combine the functions into useful workflows
Event Bridge Triggers the Step Function workflows

The following diagram provides more details on the AWS service integrations involved in this application deployment:

overview

Getting Started

The following instructions can help get this repo running in your AWS account:

  1. Configure local development environment
  2. Prepare your AWS account
  3. Define local environment variables
  4. Learn Makefile rules to deploy the app
  5. Run the API methods

More Information

The following resources are also available: