Files
hytale-f2p/README.md
Fazri Gading b46ce93af7 Release Stable Build v2.0.11 (#119)
* Add electron-updater auto-update support

- Install electron-updater package
- Configure GitHub releases publish settings
- Create AppUpdater class with full update lifecycle
- Integrate auto-update into main.js
- Add comprehensive documentation (AUTO-UPDATES.md, TESTING-UPDATES.md)
- Set up dev-app-update.yml for testing

* Add cache clearing documentation for electron-updater

- Introduced CLEAR-UPDATE-CACHE.md to guide users on clearing the electron-updater cache across macOS, Windows, and Linux.
- Added programmatic method for cache clearing in JavaScript.
- Enhanced update handling in main.js and preload.js to support new update events.
- Updated GUI styles for download buttons and progress indicators in update.js and style.css.

* Update auto-update UI and configuration

- Fix version display (newVersion field)
- Add download progress bar with real-time updates
- Reorder buttons: Install & Restart (primary), Manually Download (secondary)
- Update dev-app-update.yml to point to fork
- Update package.json version to 2.0.2

* Add installation effects and draggable progress bar

Introduces animated installation effects overlay and makes the progress bar draggable. Adds maximize window support, improves window controls styling, and enforces a single app instance. Removes the unused Skins page and related translations. Refines  various UI details for a more polished user experience.

* Adjust news card aspect ratio and add Play tab style

Set a default aspect ratio for .news-card and add a specific style for the LATEST NEWS section in the Play tab to override the aspect ratio and use full height.

* Add splash screen to launcher startup

Introduced a new splash screen (splash.html) and updated main.js to display it on startup before loading the main window. The splash screen is shown for 2.5 seconds as a placeholder for future loading logic, improving user experience during application launch.

* Display launcher version in UI

Adds a version display element to the bottom right of the UI, fetching the version from package.json via a new IPC handler. Updates main.js, preload.js, and ui.js to support retrieving and displaying the version, and adds relevant styles in style.css.

* Custom Mod loading fix (#92)

* feat: Add Repair Game functionality including UserData backup and cache clearing

* feat: Add In-App Logs Viewer and Logs Folder shortcut

* feat: Add Open Logs feature

* disable dev tools

* Fix Settings UI

* Implement custom mod loading, autoimport, auto repair

* Fixed Custom Mod loading issues and merge issues

* feat: Externalize sensitive API keys and Discord client ID into environment variables using dotenv.

* feat(mods): add profile-based mod management and auto-repair

* feat: add 'Close launcher on game start' option and improve app termination behavior (#93)

* update main branch to release/v2.0.2b (#86)

* add more linux pkgs, create auto-release and pre-release feature for Github Actions

* removed package-lock from gitignore

* update .gitignore for local build

* add package-lock.json to maintain stability development

* update version to 2.0.2b also add deps for rpm and arch

* update 2.0.2b: add arm64 support, product and executable name, maintainers; remove snap;

* update 2.0.2b: add latest.yml for win & linux, arm64 support; remove snap

* fix release build naming

* Prepare release v2.0.2b

* feat: add 'Close launcher on game start' option and improve app termination behavior

- Added 'Close launcher on game start' setting in GUI and backend.
- Implemented automatic app quit after game launch if setting is enabled.
- Added Cmd+Q (Mac) and Ctrl+Q/Alt+F4 (Win/Linux) shortcuts to quit the app.
- Updated 'window-close' handler to fully quit the app instead of just closing the window.
- Added i18n support for the new setting in English, Spanish, and Portuguese.

---------

Co-authored-by: Fazri Gading <fazrigading@gmail.com>
Co-authored-by: Arnav Singh <hi.arnavsingh3@gmail.com>

* Update publish config to point to chasem-dev fork

* Fix Linux metadata files in workflow and improve error handling

* Bump version to 2.0.5

* Bump version to 2.0.6

* Fix update popup showing for same version - add version comparison checks

* Bump version to 2.0.7

* Fix SHA512 checksum mismatch handling - clear cache and retry automatically

* Bump version to 2.0.8

* Bump version to 2.0.9

* Fix: Use explicit latest-linux.yml to prevent yml file collision

The glob pattern latest*.yml was matching both latest-linux.yml AND
latest.yml from the Linux build, causing the Windows latest.yml to be
overwritten with incorrect checksums.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Bump version to 2.0.10

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Fix: Remove portable target to fix SHA512 checksum mismatch

The portable and nsis targets both produced x64.exe files with the same
name, causing one to overwrite the other. The latest.yml contained the
checksum from one build while the actual file was from the other build.

Removed portable target - nsis installer is sufficient.
Bump version to 2.0.11

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Remove outdated documentation files related to auto-updates, build instructions, and testing updates. Update `dev-app-update.yml` and `package.json` to reflect the correct GitHub owner. This cleanup streamlines the project and ensures accurate configuration for future updates.

* Add semantic versioning policy documentation - numerical versions only

* Update package-lock.json to include new dependencies and versions, enhancing project stability and compatibility.

* fixed imgur restriction for UK

* fix: adds EGL env var to detect installed NVIDIA GPU

* Update release.yml

* patch v2.0.11-beta: fix env issue in GA release, warn Intel Mac users, add com templates. (#115)

* fix: throw error for Intel Mac user
* docs: first draft of issue and PR template
* fix: env of curseforge API key and discord client ID

* implemented late patch should be in #115

* Final patch for release.yml v2.0.11

---------

Co-authored-by: chasem-dev <myers.a.chase@gmail.com>
Co-authored-by: AMIAY <letudiantenrap.collab@gmail.com>
Co-authored-by: Rahul Sahani <110347707+Rahul-Sahani04@users.noreply.github.com>
Co-authored-by: Arnav Singh <72737311+ArnavSingh77@users.noreply.github.com>
Co-authored-by: Arnav Singh <hi.arnavsingh3@gmail.com>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-24 00:07:59 +08:00

11 KiB

🎮 Hytale F2P Launcher | Multiplayer Support [Windows, MacOS, Linux]

Version Platform License

A modern, cross-platform launcher for Hytale with automatic updates and multiplayer support (all OS supported)

GitHub stars GitHub forks

If you find this project useful, please give it a star!

🛑 Found a problem? Join the Discord: https://discord.gg/gME8rUy3MB 🛑


📸 Screenshots

Hytale F2P Launcher Hytale F2P Mods Hytale F2P News Hytale F2P Chat


Features

🎯 Core Features

  • 🔄 Automatic Updates - Smart version checking and seamless game updates
  • 💾 Data Preservation - Intelligent UserData backup and restoration during updates
  • 🌐 Cross-Platform - Full support for Windows, Linux (X11/Wayland), and macOS
  • Java Management - Automatic Java runtime detection and installation
  • 🎮 Multiplayer Support - Automatic multiplayer client installation (Windows, macOS & Linux !)

🛡️ Advanced Features

  • 📁 Custom Installation - Choose your own installation directory
  • 🔍 Smart Detection - Automatic game and dependency detection
  • 🗂️ Mod Support - Built-in mod management system
  • 💬 Player Chat - Integrated chat system for community interaction
  • 📰 News Feed - Stay updated with the latest Hytale news
  • 🎨 Modern UI - Clean, responsive interface with dark theme

🚀 Quick Start

📥 Installation

Windows

  1. Download the latest Hytale-F2P.exe from Releases
  2. Run the installer
  3. Launch from desktop or start menu

Linux

See BUILD.md for detailed build instructions or Releases section.

macOS

See BUILD.md for detailed build instructions or Releases section.

🖥️ How to play online on F2P?

See SERVER.md


🛠️ Building from Source

See BUILD.md for comprehensive build instructions.


📌 Versioning Policy

⚠️ Important: Semantic Versioning Required

This project follows strict semantic versioning with numerical versions only:

  • Valid: 2.0.1, 2.0.11, 2.1.0, 3.0.0
  • Invalid: 2.0.2b, 2.0.2a, 2.0.1-beta, v2.0.2b

Format: MAJOR.MINOR.PATCH (e.g., 2.0.11)

  • MAJOR: Breaking changes
  • MINOR: New features (backward compatible)
  • PATCH: Bug fixes (backward compatible)

Why? The auto-update system requires semantic versioning for proper version comparison. Letter suffixes (like 2.0.2b) are not supported and will cause update detection issues.


📋 Changelog

🆕 v2.0.2b (Minor Update: Performance & Utilities)

  • 🌎 Language Translation — A big welcome for Spanish 🇪🇸 and Portuguese (Brazil) 🇧🇷 players! Language setting can be found in the bottom part of Settings pane.
  • 💻 Laptop/Hybrid GPU Performance Issue Fix — Added automatic GPU detection system and options to choose which GPU will be used for the game, specifically for Linux users.
  • 👨‍💻 In-App Logging — Reporting bugs and issues to Github Issues tab or Open A Ticket channel in our Discord Server has been made easier for players, no more finding logs file manually.
  • 🛠️ Repair Button — Your game's broken? One button will fix them, go to Settings pane to Repair your game in one-click, without losing any data. If doing so did not fix your issue, please report it to us immediately!
  • 🐛 Fixed Bugs — Fixed issue #84 where mods disappearing when game starts in previous launcher (v2.0.2a).

🆕 v2.0.2a (Minor Update)

  • 🧑‍🚀 Profiles System — Added proper profile management: create, switch, and delete profiles. Each profile now has its own isolated mod list.
  • 🔒 Mod Isolation — Fixed ModManager so mods are strictly scoped to the active profile. Browsing and installing now only affects the selected profile.
  • 🚨 Critical Path Fix — Resolved a macOS bug where mods were being saved to a Windows path (~/AppData/Local) instead of ~/Library/Application Support. Mods now save to the correct location and load properly in-game.
  • 🛡️ Stability Improvements — Added an auto-sync step before every launch to ensure the physical mods folder always matches the active profile.
  • 🎨 UI Enhancements — Added a profile selector dropdown and a profile management modal.

🆕 v2.0.2

  • 🎮 Discord RPC Integration - Added Discord Rich Presence with toggle in settings (enabled by default)
  • 🌐 Cross-Platform Multiplayer - Added multiplayer patch support for Windows, Linux, and macOS
  • 🎨 Chat Improvements - Simplified chat color system
  • 🏆 Badge System Expansion - Added new FOUNDER UUID to the badge system
  • 🔧 Progress Bar Fix - Resolved issue where download progress bar stayed active after game launch
  • 🐛 Bug Fixes: General fixes

🔄 v2.0.1

  • 📊 Advanced Logging System - Complete logging with timestamps, file rotation, and session tracking
  • 🔧 Play Button Fix - Resolved issue where play button could get stuck in "CHECKING..." state
  • 💬 Discord Integration - Added closable Discord notification for community engagement
  • 📁 Game Location Access - New "Open Game Location" button in settings for easy file access
  • 🎯 UI Polish - Removed bounce animation from player counter for smoother experience
  • 🛡️ Stability Improvements - Enhanced error handling and process lifecycle management
  • Performance Optimizations - Faster startup times and better resource management
  • 🔄 Timeout Protection - Added safety timeouts to prevent launcher freezing

🔄 v2.0.0

  • Automatic Game Update System - Smart version checking and seamless updates
  • Partial Automatic Launcher Update System - This will inform you when I release a new update.
  • 🛡️ UserData Preservation - Intelligent backup/restore of game saves during updates
  • 🐧 Enhanced Linux Support - Full Wayland and X11 compatibility
  • 🔄 Multiplayer Auto-Install - Automatic multiplayer client setup on updates (Windows)
  • 📡 API Integration - Real-time version checking and client management
  • 🎨 UI Improvements - Added contributor credits footer
  • 🔄 Complete Launcher Overhaul - Total redesign of the launcher architecture and interface
  • 🗂️ Integrated Mod Manager - Built-in mod installation, management
  • 💬 Community Chat System - Real-time chat for launcher users to connect and communicate

🔧 v1.0.1

  • 📁 Custom Installation - Choose installation directory with file browser
  • 🏠 Always on Top - Launcher stays visible during installation
  • 🧠 Smart Detection - Automatic game detection and UI adaptation
  • 🗑️ Uninstall Feature - Easy game removal with one click
  • 🔄 Dynamic UI - "INSTALL" vs "PLAY" button based on game state
  • 🛠️ Path Management - Proper custom directory handling
  • 💫 UI Polish - Improved layout and overflow prevention

🎉 v1.0.0 (Initial Release)

  • 🎮 Offline Gameplay - Play Hytale without internet connection
  • Auto Installation - One-click game setup
  • Java Management - Automatic Java runtime handling
  • 🎨 Modern Interface - Clean, intuitive design
  • 🌟 First Release - Core launcher functionality

👥 Contributors

Made with ❤️ by the community

Contributors

🏆 Project Creator

  • @amiayweb - Lead Developer & Project Creator
  • @Relyz1993 - Server Helper & Second Developer & Project Creator

🌟 Contributors


📊 GitHub Stats

GitHub stars GitHub forks GitHub issues GitHub downloads

📞 Support

Need help? Join us: https://discord.gg/gME8rUy3MB


⚠️ Important Notice ⚠️

This launcher is created for educational purposes only.

🏛️ Not Official - This is an independent fan project not affiliated with, endorsed by, or associated with Hypixel Studios or Hytale.

🛡️ No Warranty - This software is provided "as is" without any warranty of any kind.

📝 Responsibility - The authors take no responsibility for how this software is used.

🛑 Takedown Policy - If Hypixel Studios or Hytale requests removal, this project will be taken down immediately.

❤️ Support Official - Please support the official game by purchasing it when available.


Star this project if you found it helpful!

Made with ❤️ by @amiayweb and the amazing community Star History Chart