Skip to content
This repository was archived by the owner on Apr 9, 2026. It is now read-only.

Repository files navigation

This project has been archived, mostly because of project burnout

MineSharp: minecraft hosting made easy

MineSharpAPI is an experimental C# project inspired by Pterodactyl and similar server management panels.
It is currently being developed as a learning and experimental platform for managing Minecraft servers using .NET

The core idea behind the project is making a strong base on the backend and a infinetly customizable frontend

⚠️ Important: This project is still in early development.
It is not ready for production use and should not be used in any live or critical environment.


🚧 Project Overview

MineSharpAPI aims to provide an API-based backend for managing and monitoring Minecraft servers and related user operations.
While currently limited in features, the goal is to create a fast and user friendly backend to be expanded upon (i hate doing frontend).


🧩 Technologies Used

  • .NET 9 / ASP.NET Core
  • Entity Framework Core (PostgreSQL)

🛠️ Setup (Development Only)

  1. Clone the repository

    git clone https://github.com/yourusername/MineSharpAPI.git
    cd MineSharpAPI
  2. Configure the database connection Edit the connection settings in Program.cs:

  3. Run the API

    dotnet run
  4. Access it locally:

    http://localhost:5000
    

🧭 Development Roadmap

🔹 Core API and Database

  • Basic ASP.NET Core setup
  • Entity Framework integration with PostgreSQL
  • Validation and error handling middleware
  • Logging and monitoring improvements

🔹 Authentication & Security

  • API key authentication system
  • User management and role-based permissions
  • Token-based authorization for third-party clients

🔹 Minecraft Server Management

  • Server start/stop/restart API endpoints
  • Container integration (Docker)
  • [~] Resource monitoring (CPU, RAM, Disk, etc.)

🔹 Developer & Integration Tools

  • REST API documentation (Swagger / OpenAPI)
  • WebSocket layer for live status updates

⚠️ Disclaimer

This software is provided as-is, without any guarantees or support.
Use it only for learning or testing purposes.
Any feature, structure, or API endpoint may change at any time.


📄 License

MIT License – feel free to read and learn from the code,
but do not deploy it in production environments.

About

A pterodactyl-like backend for running minecraft servers

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages