🎮 MineConnect

Secure Minecraft tunnel client with auto-updates — Connect to your Minecraft server from anywhere without port forwarding.

---

✨ Features

• 🎨 Beautiful Modern UI — Dark-themed HTML/CSS interface
• 🔄 Auto-Updates — Automatic updates via GitHub Releases
• 🚀 One-Click Install — Self-updating installer
• 🔐 Secure Tunnels — WebSocket encryption via Cloudflare
• ⚡ Low Latency — Optimized for gaming
• 🎯 System Tray — Runs in background
• 🏃 Auto-Start — Launch on Windows boot (optional)
• ☕ Java Edition — Full support
• 🧊 Bedrock Edition — Full support

---

📥 Download

Download MineConnect Installer

Simply download and run MineConnectInstaller.exe — it handles everything!

---

🚀 Quick Start

For Players:

1. Download the installer from Releases
2. Run MineConnectInstaller.exe
3. Follow the setup wizard
4. Done! The app will auto-update from now on

Connecting to a Server:

Once installed, MineConnect provides local connection addresses:

• Java Edition: localhost:25565
• Bedrock Edition: localhost:19132

Add these as servers in your Minecraft client, and MineConnect handles the rest!

---

🛠️ For Developers

Building from Source

Requirements:

• Windows 10/11
• Python 3.10+
• Git

Build Steps:

# Clone the repository
git clone https://github.com/httperry/MineConnect.git
cd MineConnect

# Install dependencies
cd client
pip install -r requirements.txt

# Build executables
.\build.ps1

Output:

• dist/MineConnect/MineConnect.exe — Main application
• dist/MineConnectInstaller.exe — Installer

See client/BUILD.md for detailed build instructions.

---

📦 Project Structure

MineConnect/
├── client/              # Windows client application
│   ├── app.py          # Entry point
│   ├── service.py      # Background service
│   ├── gui.py          # HTML/CSS GUI
│   ├── installer.py    # Self-updating installer
│   ├── updater.py      # Auto-update logic
│   ├── updater_gui.py  # Update UI
│   └── build.ps1       # Build script
│
├── server/             # PyPI package (server-side)
│   └── mineconnect/    # Python package
│
└── tests/              # Integration tests

---

🔄 Auto-Update System

MineConnect includes a sophisticated auto-update system:

• ✅ Background Checks — Checks GitHub on startup
• ✅ GUI Notifications — Shows update banner when available
• ✅ One-Click Updates — Beautiful progress UI
• ✅ Installer Self-Update — Even the installer updates itself!
• ✅ Version Protection — Prevents downgrades
• ✅ Safe Updates — Backup/restore on failure

See client/UPDATE_SYSTEM.md for technical details.

---

🤝 Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📝 Release Process

1. Update VERSION in client/config.py
2. Build: cd client; .\build.ps1
3. Create GitHub Release:
   • Tag: v1.0.0 (match VERSION)
   • Upload: dist/MineConnectInstaller.exe
   • Add release notes
   • Publish!
4. Users automatically get notified! 🎉

---

🐛 Bug Reports

Found a bug? Please open an issue with:

• Description of the issue
• Steps to reproduce
• Expected vs actual behavior
• Screenshots (if applicable)
• Version number (shown in GUI)

---

💬 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions

---

📄 License

This project is licensed under the MIT License — see LICENSE file for details.

---

🙏 Acknowledgments

• Cloudflare Tunnels — Network infrastructure
• Microsoft Edge — WebView for GUI
• PyInstaller — Executable packaging

---

⭐ Star History

If you find this project useful, please consider giving it a star! ⭐

---

Made with ❤️ for the Minecraft community