Skip to content

Commit 3b64f77

Browse files
ItsNeil17ItsNeil17
authored
chore: cleanup readme boilerplate (#18)
chore: cleanup readme boilerplate
2 parents 146036b + a1b8e11 commit 3b64f77

1 file changed

Lines changed: 124 additions & 29 deletions

File tree

‎README.md‎

Lines changed: 124 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,140 @@
1-
# .
1+
# Hytale Modding Documentation
22

3-
This is a Next.js application generated with
4-
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
3+
**An unofficial community-maintained documentation site for Hytale modding.**
54

6-
Run development server:
5+
This project provides comprehensive guides, documentation, and resources for modding [Hytale](https://hytale.com/) - a voxel-based sandbox RPG game built from the ground up with modding and user-generated content at its core.
6+
7+
## About Hytale Modding
8+
9+
Hytale is designed with a server-first modding approach, allowing anyone to create and share mods without requiring players to download external client modifications. Whether you're interested in:
10+
11+
- **Server Plugins** - Java-based programming for deep gameplay modifications
12+
- **Data Assets** - JSON-driven content like blocks, items, NPCs, and world generation
13+
- **Art Assets** - Custom models, textures, and sounds using Blockbench
14+
- **Visual Scripting** - Node-based logic for designers and non-programmers
15+
16+
This documentation aims to help you get started and master Hytale modding.
17+
18+
> Learn more about Hytale's modding strategy in the [official blog post](https://hytale.com/news/2025/11/hytale-modding-strategy-and-status).
19+
20+
## Getting Started
21+
22+
### Prerequisites
23+
24+
- Node.js 18.x or higher
25+
- [Bun](https://bun.sh/) package manager
26+
27+
### Installing Bun
28+
29+
If you don't have Bun installed, you can install it globally using npm:
730

831
```bash
9-
npm run dev
10-
# or
11-
pnpm dev
12-
# or
13-
yarn dev
32+
npm install -g bun
1433
```
1534

16-
Open http://localhost:3000 with your browser to see the result.
35+
Alternatively, visit [bun.sh](https://bun.sh/) for other installation methods.
36+
37+
### Installation
38+
39+
1. Clone the repository:
40+
41+
```bash
42+
git clone https://github.com/HytaleModding/site.git
43+
cd site
44+
```
45+
46+
2. Install dependencies:
47+
48+
```bash
49+
bun install
50+
```
51+
52+
3. Run the development server:
53+
54+
```bash
55+
bun run dev
56+
```
57+
58+
4. Open [http://localhost:3000](http://localhost:3000) in your browser to view the site.
59+
60+
### Available Scripts
61+
62+
- `bun run dev` - Start the development server
63+
- `bun run build` - Build the production application
64+
- `bun start` - Run the production server
65+
- `bun run types:check` - Validate TypeScript types and MDX files
66+
- `bun run lint` - Run ESLint for code quality
67+
68+
## Documentation Structure
69+
70+
### Routes
71+
72+
| Route | Description |
73+
| --- | --- |
74+
| `/` | Landing page with community links and introduction |
75+
| `/docs` | Main documentation hub |
76+
| `/docs/quick-start` | Getting started guide for Hytale modding |
77+
| `/docs/what-we-know-so-far` | Current knowledge base about Hytale modding |
78+
| `/docs/what-we-know-so-far/faq` | Frequently asked questions |
79+
| `/docs/what-we-know-so-far/inputs` | Input handling documentation |
80+
| `/docs/what-we-know-so-far/server-first-dev` | Server-first development approach |
81+
| `/docs/what-we-know-so-far/ui-customization` | UI customization guides |
82+
| `/docs/what-we-know-so-far/ways-to-develop/data-assets` | Working with data assets (JSON) |
83+
| `/docs/what-we-know-so-far/ways-to-develop/modelling` | 3D modelling and Blockbench |
84+
| `/docs/what-we-know-so-far/ways-to-develop/plugin` | Java plugin development |
85+
| `/docs/what-we-know-so-far/ways-to-develop/visual-scripting` | Visual scripting workflows |
86+
| `/api/search` | Documentation search API endpoint |
87+
88+
### Project Structure
89+
90+
```
91+
src/
92+
├── app/ # Next.js app directory
93+
│ ├── (home)/ # Landing page route group
94+
│ ├── docs/ # Documentation pages
95+
│ └── api/search/ # Search API
96+
├── components/ # React components
97+
│ ├── layout/ # Layout components for docs
98+
│ └── ui/ # Reusable UI components
99+
├── lib/ # Utility libraries
100+
│ ├── source.ts # Content source adapter
101+
│ └── layout.shared.tsx # Shared layout configuration
102+
content/
103+
└── docs/ # MDX documentation files
104+
├── index.mdx
105+
├── quick-start.mdx
106+
└── what-we-know-so-far/
107+
```
108+
109+
## Contributing
110+
111+
This is a community-driven project. Contributions are welcome! Whether you want to:
17112

18-
## Explore
113+
- Add new documentation
114+
- Fix errors or improve existing content
115+
- Suggest new features or improvements
116+
- Report issues
19117

20-
In the project, you can see:
118+
Please feel free to open issues or submit pull requests on [GitHub](https://github.com/HytaleModding/site).
21119

22-
- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
23-
- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to keep.
120+
## Community Links
24121

25-
| Route | Description |
26-
| ------------------------- | ------------------------------------------------------ |
27-
| `app/(home)` | The route group for your landing page and other pages. |
28-
| `app/docs` | The documentation layout and pages. |
29-
| `app/api/search/route.ts` | The Route Handler for search. |
122+
- **Discord**: [Join our Discord server](https://discord.gg/54WX832HBM)
123+
- **Official Hytale**: [hytale.com](https://hytale.com/)
124+
- **Hytale Modding Strategy**: [Official Blog Post](https://hytale.com/news/2025/11/hytale-modding-strategy-and-status)
30125

31-
### Fumadocs MDX
126+
## Technology Stack
32127

33-
A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
128+
- **Framework**: [Next.js 16](https://nextjs.org/)
129+
- **Documentation**: [Fumadocs](https://fumadocs.dev/)
130+
- **Styling**: Tailwind CSS
131+
- **Content**: MDX (Markdown + JSX)
132+
- **Icons**: Lucide React
34133

35-
Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.
134+
## Disclaimer
36135

37-
## Learn More
136+
This is an **unofficial** community project and is not affiliated with or endorsed by Hypixel Studios or Hytale. All trademarks and game content are property of their respective owners.
38137

39-
To learn more about Next.js and Fumadocs, take a look at the following
40-
resources:
138+
## License
41139

42-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
43-
features and API.
44-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
45-
- [Fumadocs](https://fumadocs.dev) - learn about Fumadocs
140+
This documentation site is maintained by the community for the community. For specific licensing information, please check the repository.

0 commit comments

Comments
 (0)