https://github.com/angelobdev/hytale-mod-manager
A modern, Electron-based mod manager for Hytale that integrates with CurseForge to provide seamless mod browsing, installation, and updates
https://github.com/angelobdev/hytale-mod-manager
electron hytale hytale-mod hytale-modding linux windows
Last synced: 4 months ago
JSON representation
A modern, Electron-based mod manager for Hytale that integrates with CurseForge to provide seamless mod browsing, installation, and updates
- Host: GitHub
- URL: https://github.com/angelobdev/hytale-mod-manager
- Owner: angelobdev
- License: mit
- Created: 2026-01-25T15:53:24.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-27T16:42:03.000Z (5 months ago)
- Last Synced: 2026-01-28T03:05:25.889Z (5 months ago)
- Topics: electron, hytale, hytale-mod, hytale-modding, linux, windows
- Language: TypeScript
- Homepage:
- Size: 30.4 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hytale Mod Manager
A modern, Electron-based mod manager for Hytale that integrates with CurseForge to provide seamless mod browsing, installation, and updates.
---
---
## ✨ Features
- **🔍 Browse Mods**: Search and filter through thousands of Hytale mods from CurseForge
- **⬇️ Easy Installation**: One-click mod installation with automatic file management
- **🔄 Auto Updates**: Detect and update installed mods to their latest versions
- **📦 Mod Management**: View, organize, and uninstall your installed mods
- **🎮 Quick Launch**: Launch Hytale directly from the mod manager
- **🗄️ Smart Database**: SQLite-based tracking of installed mods and their files
- **🔄 State Sync**: Automatic synchronization of mod directory state
---
## 📥 Installation
### Pre-built Binaries
1. Go to the [Releases](https://github.com/angelobdev/hytale-mod-manager/releases) page
2. Download the appropriate installer for your operating system:
- **Windows**: `Hytale-Mod-Manager-{version}.exe`
- **Linux**: `Hytale-Mod-Manager-{version}.AppImage`
3. Run the app
### First-Time Setup
1. **Get a CurseForge API Key**:
- Visit [CurseForge Console](https://console.curseforge.com/#/)
- Create a new API key
- Copy the key
2. **Configure the Application**:
- Open the app and navigate to Settings
- Paste your CurseForge API key
- Set your Hytale mods directory
- Set your Hytale launcher executable path (Windows-only, for now...)
---
## 🛠️ Building from Source
### Prerequisites
- Node.js (v24 LTS is recommended)
- npm
### Build Instructions
1. **Clone the repository**:
```bash
git clone https://github.com/angelobdev/hytale-mod-manager.git
cd hytale-mod-manager
```
2. **Install dependencies**:
```bash
npm install
npm run gen:api
```
3. **Build the application**:
For Linux:
```bash
npm run dist:linux
```
For Windows:
```bash
npm run dist:win
```
4. **Development mode**:
```bash
npm run dev
```
The built application will be available in the `release` directory.
---
## 🏗️ Tech Stack
- **Frontend**: React 19, TanStack Router, TanStack Query
- **UI**: Tailwind CSS, Radix UI, shadcn/ui components
- **Backend**: Electron, Node.js
- **Database**: better-sqlite3
- **API**: CurseForge REST API
- **Build Tools**: Vite, TypeScript
---
## 📁 Project Structure
```txt
hytale-mod-manager/
├── electron/ # Electron main & preload scripts
│ ├── main/ # Main process handlers
│ ├── preload/ # Preload scripts
│ └── lib/ # Shared utilities
├── src/ # React application
│ ├── components/ # UI components
│ ├── routes/ # Application routes
│ ├── hooks/ # Custom React hooks
│ ├── store/ # State management
│ ├── gen/ # Generated API client
│ └── lib/ # Utilities
└── resources/ # Static resources
```
---
## 🤝 Contributing
Contributions are welcome! Here's how you can help:
1. **Fork the repository**
2. **Create a feature (or fix) branch**: `git checkout -b feature/amazing-feature`
3. **Make your changes**
4. **Update the [CHANGELOG.md](CHANGELOG.md)** with your changes under the "Unreleased" tag
5. **Commit your changes**: `git commit -m 'Add amazing feature'`
6. **Push to the branch**: `git push origin feature/amazing-feature`
7. **Open a Pull Request**
### Development Guidelines
- Follow the existing code style
- Write meaningful commit messages
- Test your changes thoroughly
---
## 📝 API Generation
This project uses [Orval](https://orval.dev/) to generate TypeScript API clients from the CurseForge OpenAPI specification.
To regenerate the API client:
```bash
npm run gen:api
```
---
## ⚠️ Known Issues
- This is an early alpha version - bugs are expected
- Some features may be incomplete or unstable
- Report issues on the [GitHub Issues](https://github.com/angelobdev/hytale-mod-manager/issues) page
---
## 📄 License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
---
## 🙏 Acknowledgments
- **CurseForge** for providing the API
- **Hytale community** for inspiration and support
- All contributors who help improve this project
---
Made with ❤️ by [angelobdev](https://github.com/angelobdev)