LogoMC Roam Docs

Cloud-Synced Minecraft Server Manager

"Your server, your hardware, your rules."

Host, manage, and play Minecraft servers from anywhere, with seamless cloud sync and zero port forwarding. No hidden costs, no RAM limits.

Download View Source

**MC Roam** is a desktop application that revolutionizes Minecraft server hosting for friends and communities. It solves the biggest headache of self-hosting: keeping the server file consistent across different friends' computers.

# Key Features

Cloud Sync

Sync server data across devices via Google Drive or OneDrive.

Multi-Host

Anyone in the group can start the server; no dedicated PC needed.

No Port Forwarding

Public tunneling via Playit.gg included automatically.

Admin System

Assign roles, manage whitelists, bans, and OPs from a UI.

Real-Time Control

Change properties and world settings while the server runs.

Built-in Terminal

View logs and send console commands directly.

# Installation

Prerequisites

  • Windows 10/11 (64-bit)
  • Rclone-compatible Cloud Storage (Google Drive, OneDrive, etc.)

Quick Start

  1. Download the latest release from the Releases page.
  2. Run the Application (Double-click mc-roam.exe).
  3. Create an account (no config needed) and authorize your cloud storage.
  4. Create or join a server and start playing!

# Developer Guide

Want to build MC Roam from source or use your own custom backend?

Requirements

Go 1.21+Node.js 20+Wails v2

Build Steps

# 1. Clone repository
git clone https://github.com/Student9876/mc-roam.git
cd mc-roam

# 2. Install Wails & Frontend Deps
go install github.com/wailsapp/wails/v2/cmd/wails@latest
cd frontend && npm install && cd ..

# 3. Build (Injecting variables)
wails build -ldflags "-X 'mc-roam/backend.MongoDBURI=YOUR_URI' ..."

# Project Structure

mc-roam/
├── backend/           # Go backend logic
│   ├── app.go         # Main application logic
│   ├── runner.go      # Server execution
│   └── rclone.go      # Cloud sync
├── frontend/          # React frontend
│   ├── src/
│   │   ├── pages/     # Dashboard, Auth
│   │   └── components/# Modals, Cards
└── build/             # Build assets

# Community & Support

Technologies Used

  • Wails v2 (Go + React)
  • MongoDB (Database)
  • Rclone (Sync)
  • Playit.gg (Tunneling)

Contributing

Contributing
Contributions are welcome! Please feel free to submit a Pull Request.

Note:

We only accept Pull Requests (PRs) to the develop branch. Please do not open PRs directly to main. All new features, bug fixes, and improvements should be based on develop. The main branch is reserved for production-ready code and releases.

  1. Fork the repository
  2. Create your feature branch from develop (git checkout develop && git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to your feature branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request targeting the develop branch
License: MIT License