diff --git a/README.md b/README.md index 8e968a1..cd6c81d 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,184 @@ -# Hytale F2P Launcher +# ๐ŸŽฎ Hytale F2P Launcher | Multiplayer Support -A simple offline launcher for Hytale that allows you to play the game for free. +
-## Features +![Version](https://img.shields.io/badge/Version-1.0.2-green?style=for-the-badge) +![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey?style=for-the-badge) +![License](https://img.shields.io/badge/License-Educational-blue?style=for-the-badge) -- Offline gameplay support -- Automatic game file download and installation -- Java runtime management -- Clean and modern interface +**A modern, cross-platform offline launcher for Hytale with automatic updates and multiplayer support (windows users & non-premium only)** -## Installation +[![GitHub stars](https://img.shields.io/github/stars/amiayweb/Hytale-F2P?style=social)](https://github.com/amiayweb/Hytale-F2P/stargazers) +[![GitHub forks](https://img.shields.io/github/forks/amiayweb/Hytale-F2P?style=social)](https://github.com/amiayweb/Hytale-F2P/network/members) -### Windows +โญ **If you find this project useful, please give it a star!** โญ +๐Ÿ›‘ **Found a problem? Open an issue! Iโ€™m on Windows, so I canโ€™t test on macOS or Linux.** ๐Ÿ›‘ +
-1. Download the latest release from the [Releases](https://github.com/amiayweb/Hytale-F2P/releases) page -2. Run `Hytale F2P Launcher.exe` to install -3. Launch the application from your desktop or start menu +--- -### Linux +## โœจ 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) + +๐Ÿ›ก๏ธ **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**](https://github.com/amiayweb/Hytale-F2P/releases) +2. Run the installer +3. Launch from desktop or start menu + +#### Linux See [BUILD.md](BUILD.md) for detailed build instructions. -### macOS - +#### macOS See [BUILD.md](BUILD.md) for detailed build instructions. -## Usage +#### ๐Ÿ–ฅ๏ธ How to create server (Windows Only)? +1. Download the server files directly from: `http://3.10.208.30:3002/server` +2. Replace the existing files in your `HytaleF2P` installation folder +3. Run the server launcher (.bat) to start hosting your own Hytale server + +### ๐ŸŽฎ Usage -1. Enter your player name -2. Click "PLAY" -3. The launcher will automatically download and install required files -4. The game will launch automatically +1. **Enter your player name** +2. **Click "PLAY"** +3. **Automatic setup** - The launcher handles everything automatically +4. **Game launches** - Enjoy playing Hytale! -## Building from Source +--- -See [BUILD.md](BUILD.md) for detailed build instructions. +## ๐Ÿ› ๏ธ Building from Source + +See [BUILD.md](BUILD.md) for comprehensive build instructions. + +--- ## ๐Ÿ“‹ Changelog -### v1.0.1 -- Added custom installation feature with collapsible options -- Installation folder selection with file browser dialog -- Launcher now stays always on top -- Smart game detection - hides custom installation if already installed -- Uninstall button for easy game removal -- Dynamic button text: "INSTALL" when not installed, "PLAY" when ready -- Fixed installation paths to properly use custom directory -- Improved UI layout to prevent overflow issues +### ๐Ÿ†• v2.0.0 *(Latest)* +- โœ… **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.0 -- First version -- Simple installation -- Offline gameplay support -- Automatic Java runtime management -- Clean and modern interface +### ๐Ÿ”ง 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 -- [@chasem-dev](https://github.com/chasem-dev) -- [@crimera](https://github.com/crimera) -- [@sanasol](https://github.com/sanasol) +
+ +**Made with โค๏ธ by the community** + +[![Contributors](https://contrib.rocks/image?repo=amiayweb/Hytale-F2P)](https://github.com/amiayweb/Hytale-F2P/graphs/contributors) + +
+ +### ๐Ÿ† Project Creator +- [**@amiayweb**](https://github.com/amiayweb) - *Lead Developer & Project Creator* + +### ๐ŸŒŸ Contributors +- [**@chasem-dev**](https://github.com/chasem-dev) - *Issues fixer* +- [**@crimera**](https://github.com/crimera) - *Issues fixer* +- [**@sanasol**](https://github.com/sanasol) - *Issues fixer* +- [**@Terromur**](https://github.com/Terromur) - *Issues fixer* +- [**@Citeli-py**](https://github.com/Citeli-py) - *Issues fixer* +- [**@ericiskoolbeans**](https://github.com/ericiskoolbeans) - *Beta Tester* + +--- + +## ๐Ÿ“Š GitHub Stats + +
+ +![GitHub stars](https://img.shields.io/github/stars/amiayweb/Hytale-F2P?style=for-the-badge&logo=github) +![GitHub forks](https://img.shields.io/github/forks/amiayweb/Hytale-F2P?style=for-the-badge&logo=github) +![GitHub issues](https://img.shields.io/github/issues/amiayweb/Hytale-F2P?style=for-the-badge&logo=github) +![GitHub downloads](https://img.shields.io/github/downloads/amiayweb/Hytale-F2P/total?style=for-the-badge&logo=github) + +
+## ๐Ÿ“ž Support -## Disclaimer +
-This launcher is for educational purposes only. +[![GitHub Issues](https://img.shields.io/badge/GitHub-Issues-red?style=for-the-badge&logo=github)](https://github.com/amiayweb/Hytale-F2P/issues) +[![Discussions](https://img.shields.io/badge/GitHub-Discussions-blue?style=for-the-badge&logo=github)](https://github.com/amiayweb/Hytale-F2P/discussions) -This is an independent fan-made project and is **not affiliated with, endorsed by, or associated with** Hypixel Studios or Hytale in any way. +**Need help?** Open an [issue](https://github.com/amiayweb/Hytale-F2P/issues) or start a [discussion](https://github.com/amiayweb/Hytale-F2P/discussions)! -โš ๏ธ This software is provided **โ€œas isโ€**, without any warranty of any kind. -The author takes no responsibility for how this software is used. +
-๐Ÿ›‘ If Hypixel Studios or Hytale requests its removal, this project will be taken down immediately. +--- + +## โš–๏ธ Legal Disclaimer + +
+ +โš ๏ธ **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](https://github.com/amiayweb) and the amazing community* +[![Star History Chart](https://api.star-history.com/svg?repos=amiayweb/Hytale-F2P&type=date&legend=top-left)](https://www.star-history.com/#amiayweb/Hytale-F2P&type=date&legend=top-left) +
-โค๏ธ Please support the official game by purchasing it when it becomes available.