Hymn

A modern mod manager for Hytale built with Electron, React, and TypeScript.

Features

• Mod Library Management - Scan and manage Packs, Plugins, and Early Plugins
• Profile System - Create profiles with custom mod sets and load order
• Safe Operations - Automatic backups with one-click rollback
• Mod Creation Tools - Visual editors and integrated IDE for building mods
• Cross-Platform - Windows, macOS, and Linux support

Installation

Download the latest release for your platform from the Releases page.

Platform	Download
Windows	.exe installer
macOS	.dmg image
Linux	.AppImage / .deb

macOS Users

The macOS app is not notarized. On first launch, you may see "Hymn is damaged and can't be opened."

To fix this, open Terminal and run:

xattr -cr /Applications/Hymn.app

Or: Right-click the app → Open → Click "Open" in the security dialog.

Requirements: Hytale Early Access installed

Key Paths

Hymn works with these Hytale directories:

Type	Windows Path
Hytale Root	%AppData%\Hytale
Packs	%AppData%\Hytale\UserData\Packs
Plugins	%AppData%\Hytale\UserData\Mods
Early Plugins	%AppData%\Hytale\earlyplugins
Hymn Data	%AppData%\Hymn

Development

Prerequisites

• Node.js 20+
• Bun

Quick Start

# Install dependencies
bun install

# Start development server
bun run dev

# Build for production
bun run build

Scripts

Script	Description
bun run dev	Development server with hot reload
bun run build	Production build with packaging
bun run build:compile	Build without packaging
bun run lint	Run ESLint
bun run typecheck	TypeScript type checking
bun run test	Run tests

Architecture

Hymn uses a secure Electron architecture:

Main Process          Preload           Renderer
─────────────────    ──────────────    ──────────────
File system ops      contextBridge     React UI
Mod scanning         IPC bridge        State (Zustand)
Profile management   Type-safe API     Routing
Backup engine                          Components

Project Structure

hymn/
├── electron/          # Main process (file ops, IPC)
├── src/
│   ├── components/    # React components
│   │   └── ui/        # shadcn/ui components
│   ├── lib/           # Utilities
│   ├── routes/        # Pages (TanStack Router)
│   └── stores/        # Zustand stores
└── tests/

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

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

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

Acknowledgments

• Hytale - The game this tool supports
• shadcn/ui - UI components