Comprehensive guides, API documentation, and interactive tools for Hytale — built by the community, for the community.
🌐 Visit Website · 💬 Join Discord · 🐛 Report Bug · ✨ Request Feature
| Feature | Description |
|---|---|
| 🌍 Multilingual | Full support for English, French, and Spanish |
| 📖 Comprehensive Docs | Gameplay guides, modding tutorials, server setup, and API reference |
| 🛠️ Interactive Tools | Server calculator, project generator, JSON validator |
| 🌙 Dark/Light Mode | Beautiful themes with system preference detection |
| 🔍 SEO Optimized | Sitemap, structured data, and meta tags for discoverability |
| 📱 Fully Responsive | Seamless experience on desktop, tablet, and mobile |
| ⚡ Lightning Fast | Built on Next.js 16 with optimized performance |
| 🎨 Modern UI | Clean design powered by Tailwind CSS and shadcn/ui |
# Clone the repository
git clone https://github.com/timiliris/Hytale-Docs.git
cd Hytale-Docs
# Install dependencies
npm install
# Start development server
npm run devOpen http://localhost:3000 and start exploring!
| Technology | Purpose |
|---|---|
| Next.js 16 | React framework with App Router |
| TypeScript | Type-safe development |
| Tailwind CSS v4 | Utility-first styling |
| shadcn/ui | Beautiful UI components |
| next-intl | Internationalization |
| MDX | Markdown with React components |
src/
├── app/ # Next.js App Router
│ └── [locale]/ # Localized routes (en, fr, es)
│ ├── docs/ # Documentation pages
│ └── tools/ # Interactive tools
├── components/ # React components
│ ├── homepage/ # Landing page sections
│ ├── layout/ # Navigation, footer, sidebar
│ ├── mdx/ # Custom MDX components
│ └── ui/ # shadcn/ui components
├── content/docs/ # MDX documentation files
│ ├── en/ # English content
│ ├── fr/ # French content
│ └── es/ # Spanish content
├── lib/ # Utilities and helpers
└── messages/ # Translation JSON files
We welcome contributions from the community! Whether it's fixing a typo, adding documentation, or building new features — every contribution matters.
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Commit your changes:
git commit -m 'Add amazing feature' - Push to your branch:
git push origin feature/amazing-feature - Open a Pull Request
Documentation is written in MDX format. Simply add new files to content/docs/[locale]/ and they'll automatically appear in the sidebar.
💡 Tip: Check our Contributing Guide for detailed instructions.
This project uses a dual-license model:
| Component | License | What it means |
|---|---|---|
| 💻 Source Code | Elastic License 2.0 | View, fork, and contribute freely. Cannot host a competing service. |
| 📝 Documentation | CC BY-NC-SA 4.0 | Share and adapt with attribution. Non-commercial use only. |
| ™️ Trademarks | All Rights Reserved | "HytaleDocs" name and logo are protected. |
Quick License Summary
You CAN:
- ✅ View and study the source code
- ✅ Fork and contribute improvements
- ✅ Use documentation for personal/educational purposes
- ✅ Share documentation with attribution
You CANNOT:
- ❌ Host a competing service using this codebase
- ❌ Use code or content commercially
- ❌ Use HytaleDocs branding without permission
HytaleDocs is a community-driven project and is NOT affiliated with, endorsed by, or officially connected to Hypixel Studios or Riot Games.
Hytale and all related trademarks are the property of Hypixel Studios. This project is created by fans, for fans.
Made with ❤️ by the Hytale community
⭐ Star this repo if you find it useful! ⭐