MineServe Documentation

Last updated: January 2026 · v1.3.1

Introduction

MineServe is an open-source local Minecraft server manager. It provides a modern interface to create, manage and monitor your Minecraft servers without needing command line tools.

💡 Open Source MineServe is completely free and open-source under the ISC license. Contributions are welcome!

Key Features

Create and manage Vanilla, Paper, Spigot, Forge, Fabric servers
Real-time dashboard with monitoring (RAM, players, TPS)
Integrated console with syntax highlighting
Player management (ban, kick, OP, whitelist)
Mod/plugin installation via Modrinth API
Automatic updates
Available in English and French

Installation

Requirements

Software	Minimum Version	Note
Windows	10 / 11	64-bit required
Java	17+	For Minecraft server

Download

Download the latest version from GitHub Releases.

# Direct download
MineServe-Setup-1.3.1.exe

Quick Start

Launch MineServe after installation
Click on "Create Server"
Choose the server type (Vanilla, Paper, etc.)
Select the Minecraft version
Configure allocated RAM
Click "Start"

✓ That's it! Your server is now online at localhost:25565

Tech Stack

MineServe is built with modern technologies:

Technology	Role	Version
`Electron`	Desktop framework	30.x
`React`	User interface	18.x
`TypeScript`	Main language	5.x
`Vite`	Build tool	7.x
`Tailwind CSS`	Styling	3.x
`Framer Motion`	Animations	11.x

Project Structure

MineServe/ ├── electron/ # Electron main process │ ├── main.ts # Entry point │ ├── preload.ts # Secure IPC bridge │ └── ipc/ # IPC handlers ├── src/ # React code (renderer) │ ├── components/ # UI components │ ├── pages/ # App pages │ ├── hooks/ # Custom hooks │ ├── i18n/ # Translations EN/FR │ └── App.tsx # Root component ├── resources/ # Assets (icons) ├── package.json └── vite.config.ts

IPC Communication

The app uses Electron's IPC system for communication between the renderer (React) and main process (Node.js).

IPC Call Example

// Renderer side (React)
const serverInfo = await window.electron.getServerStatus();

// Main side (Electron)
ipcMain.handle('get-server-status', async () => {
  return { online: true, players: 5 };
});

Dashboard

The dashboard displays in real-time:

Server Status - Online / Offline
Connected Players - List with avatars
RAM Usage - Real-time graph
TPS - Server ticks per second

Console

The integrated console lets you view server logs and execute Minecraft commands directly.

# Command examples
/say Welcome to the server!
/gamemode creative Steve
/tp @a 0 100 0

Player Management

Available actions for each player:

/kick [player] - Temporarily remove
/ban [player] - Permanently ban
/op [player] - Give operator rights
/whitelist add [player] - Add to whitelist

Addons (Modrinth) New

Search and install mods and plugins directly from Modrinth without leaving the app.

⚠️ Compatibility Always verify that the mod/plugin is compatible with your Minecraft version and server type (Forge, Fabric, Paper, etc.).

Development Environment

Dev Requirements

Node.js 18+
Git
VS Code (recommended)

Setup

# Clone the repo
git clone https://github.com/MikAmaral123/MineServe.git
cd MineServe/Application

# Install dependencies
npm install

# Run in dev mode
npm run dev

Production Build

# Generate Windows installer
npm run build

# Generated files in release/
├── MineServe-Setup-X.Y.Z.exe
└── latest.yml

Contributing

Contributions are welcome! Here's how to proceed:

Fork the repository
Create a branch (git checkout -b feature/my-feature)
Commit your changes
Push and open a Pull Request

Report a Bug

Open an Issue with a detailed description and steps to reproduce the problem.