Skip to content

CalaKuad1/Minecraft-Local-Server-GUI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

71 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Logo

๐ŸŽฎ Minecraft Local Server GUI

The ultimate tool for installing and managing Minecraft servers โ€” beautiful, modern, and effortless.

Download Windows Download Linux

Electron React FastAPI Java


Dashboard Screenshot

โฌ‡๏ธ Download & Install

One-click installation โ€” No Python or Java required!

Platform Download
Windows ๐Ÿ“ฆ Download Installer (.exe)
Linux ๐Ÿ“ฆ Download AppImage (.AppImage)

Note: The app automatically downloads and manages Java for you. Just install and play!


โœจ Features

๐Ÿš€ Server Management

  • One-click server creation โ€” Vanilla, Paper, Spigot, Forge
  • Multiple server profiles โ€” Switch between servers instantly
  • Live console with real-time logs and command input
  • Start/Stop controls with visual status indicators
  • Server Conflict Guard โ€” Prevents running multiple servers simultaneously with an integrated stop-and-switch flow

โ˜• Automatic Java

  • Zero configuration โ€” Java 8/17/21 downloaded automatically
  • Smart detection โ€” Matches Java version to Minecraft version
  • No more errors โ€” Eliminates UnsupportedClassVersionError
  • Isolated installations โ€” Won't affect your system Java

๐Ÿ“Š Dashboard

  • Real-time stats โ€” CPU, RAM, and uptime monitoring
  • One-Click Public Server โ€” Use Pinggy (Experimental) to share your server globally via SSH tunnel
  • Region Selection โ€” Choose between EU, US, and Asia for best latency
  • Local IP display โ€” Easy LAN connection for friends
  • Quick command input โ€” Send commands from dashboard

๐Ÿงฉ Mods

  • Mod search & install โ€” browse mods and install them in one click
  • Installed mods list โ€” see what is currently installed
  • Smart warning for non-modded servers โ€” Vanilla/Paper show a hint to install a mod loader (Setup Wizard)

๐ŸŒ Worlds & Backups

  • World list with last modified time
  • Fast loading โ€” world sizes are computed in the background and cached
  • One-click backups โ€” create ZIP backups and keep them inside your server folder

โš™๏ธ Configuration

  • Visual settings editor โ€” No file editing required
  • server.properties GUI โ€” All options organized by category
  • RAM allocation โ€” Customize min/max memory per server
  • Player management โ€” Op, ban, whitelist with one click

๐Ÿ‘ฅ Players

  • Accurate online players โ€” player counter is tracked from server logs and /list
  • Cleaner console โ€” internal /list output is hidden from the console UI
  • Faster refresh โ€” avoids full UI reloads during periodic updates

๐ŸŽจ Modern UI

Built with React and Tailwind CSS, featuring:

  • ๐ŸŒ™ Dark theme โ€” Easy on the eyes
  • โœจ Glassmorphism โ€” Blurred, translucent panels
  • ๐ŸŽฌ Smooth animations โ€” Powered by Framer Motion
  • ๐Ÿ“ฑ Responsive layout โ€” Scales to any window size

๐Ÿ”ง Tech Stack

Layer Technology
Frontend Electron + React + Vite
Styling Tailwind CSS + Framer Motion
Backend Python + FastAPI + Uvicorn
Packaging electron-builder (GitHub Actions CI/CD)
Automation GitHub Actions (Auto-Release on Tag)

๐Ÿ› ๏ธ Development Setup

Want to contribute or run from source?

# Clone the repository
git clone https://github.com/CalaKuad1/Minecraft-Local-Server-GUI.git
cd Minecraft-Local-Server-GUI

# Backend setup
cd backend
python -m venv venv
venv\Scripts\activate  # Windows
pip install -r requirements.txt

# Frontend setup
cd ../electron-app
npm install

# Run in development mode
npm run dev

Building the Installer (Production)

Local build (Windows/macOS detects platform automatically):

cd electron-app
npm run electron:build

Automated Multi-platform Release: This project is configured with GitHub Actions. To trigger a new release with Windows and Linux binaries:

  1. Bump version in package.json
  2. Push a tag: git tag v1.1.x && git push origin v1.1.x
  3. GitHub will build and publish everything automatically!

๐Ÿ“‹ Requirements

For Users (Installer)

  • Windows 10/11 (64-bit)
  • Linux (Any disto supporting AppImage or .deb)
  • Internet connection (for initial Java download)
  • ~500MB disk space

For Developers

  • Node.js 18+
  • Python 3.8+
  • npm or yarn

โ“ FAQ

Why is it downloading Java?

The app automatically downloads the correct Java version for your Minecraft server. This is sandboxed and won't affect your system Java installation.

Can my friends connect to my server?

For LAN: Share the Local IP shown in the dashboard.
For Internet: Use a tunneling service like playit.gg (recommended) or configure port forwarding on your router.

Is the UI available in English?

Yes โ€” the app UI and system messages are in English.

Where are my servers stored?

Server files are stored in the location you choose during setup. App configuration is saved in %APPDATA%/MinecraftServerGUI.

How do I import an existing server?

Click "Add Server" โ†’ "Use Existing" โ†’ Select your server folder. The app will auto-detect the server type and version.


๐Ÿ“„ License

This project is licensed under the MIT License โ€” see the LICENSE file for details.


โญ Support

If this project helped you, please star the repository โญ
It helps others discover the tool and motivates development!


Made with โค๏ธ by CalaKuad1