Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
f6fe9cc
feat: :memo: Text Based Scripting documentation
okunamayanad Nov 22, 2025
01ff2b1
feat: 📝 Text Based Scripting documentation (#14)
ItsNeil17 Nov 22, 2025
de7b857
chore: add git-info.json to gitignore
ItsNeil17 Nov 22, 2025
0e6fb61
chore: move text-based to 'WWKSF' category
ItsNeil17 Nov 22, 2025
600254c
feat: add ways to develop category
ItsNeil17 Nov 22, 2025
24702d9
feat: add icons
ItsNeil17 Nov 22, 2025
d901cfe
feat: replace unicode icons with text
ItsNeil17 Nov 22, 2025
1b4c353
feat: add CODEOWNERS file
ItsNeil17 Nov 22, 2025
08f45bd
chore: move CODEOWNERS to .github
ItsNeil17 Nov 22, 2025
d37f8da
feat: add inputs page
ItsNeil17 Nov 22, 2025
c95e605
feat: add ui customization page
ItsNeil17 Nov 22, 2025
a9200de
refactor: rename text-based.mdx to plugin.mdx
ItsNeil17 Nov 22, 2025
0291026
feat: add visual scripting page
ItsNeil17 Nov 22, 2025
e085df5
feat: add data assets page
ItsNeil17 Nov 22, 2025
49f1303
feat: add modelling / texture art page
ItsNeil17 Nov 22, 2025
2de03df
feat: add 'Documentation in Progress' banner at the top of the website
ItsNeil17 Nov 22, 2025
146036b
feat: add base fumadocs components
ItsNeil17 Nov 22, 2025
759644a
chore: cleanup readme boilerplate
Laophy Nov 22, 2025
a1b8e11
chore : convert npm to bun in readme docs
Laophy Nov 22, 2025
3b64f77
chore: cleanup readme boilerplate (#18)
ItsNeil17 Nov 22, 2025
fe1a078
chore: implement github community standards for open source
Laophy Nov 22, 2025
6750ffc
chore: ensure bun audit is ran before merging (pr template)
Laophy Nov 22, 2025
279f0b3
chore: add contact email
Laophy Nov 22, 2025
46f227a
chore: remove discord comment
Laophy Nov 22, 2025
40dc447
Implement github Community Standards files (#19)
ItsNeil17 Nov 22, 2025
b2f8687
chore: fix README to include forks instead of cloning main repo
ItsNeil17 Nov 22, 2025
b780bfa
feat: remove fumadocs components in favor of feat/ui
ItsNeil17 Nov 22, 2025
3c0e9a0
docs: add new Q&A documentation gathered from discord
Laophy Nov 22, 2025
59ed705
Merge branch 'HytaleModding:documentation' into documentation
Laophy Nov 22, 2025
f653443
chore: add Laophy as CODEOWNER
ItsNeil17 Nov 22, 2025
ab3ad05
docs: Add Developer Q&A Technical Insights summary page from Zero and…
ItsNeil17 Nov 22, 2025
f4962ea
chore: remove ai garbage
ItsNeil17 Nov 22, 2025
7243058
chore: change mana to hunger
ItsNeil17 Nov 22, 2025
4a94f0e
feat: updated structure
OmeWillem Nov 22, 2025
f9d7b1a
fix: removed icon from seperator
OmeWillem Nov 22, 2025
434b60a
Reorder pages and other minor changes (#29)
ItsNeil17 Nov 22, 2025
fae54a6
fix: change up style of Q&A Summary
ItsNeil17 Nov 23, 2025
06a305d
fix: move developer qa insights to root
ItsNeil17 Nov 23, 2025
f6d8d9b
feat!: implement new UI (#32)
ItsNeil17 Nov 24, 2025
d0814f6
fix: props for DocsPage
ItsNeil17 Nov 24, 2025
177ad51
fix: remove duplicate title
ItsNeil17 Nov 24, 2025
46877e9
fix: change WIP alert
ItsNeil17 Nov 24, 2025
5fd0f47
Merge remote-tracking branch 'upstream/main' into documentation
okunamayanad Nov 24, 2025
b96d976
revert: revert custom documentation UI changes
okunamayanad Nov 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
* @ItsNeil17

/content/docs/what-we-know-so-far/ways-to-develop/text-based.mdx @okunamayanad
‎/content/docs/what-we-know-so-far/developer-qa-insights.mdx @Laophy
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Bug Report
about: Report a bug or issue with the documentation site
title: '[BUG] '
labels: bug
assignees: ''
---

## Bug Description

A clear and concise description of what the bug is.

## Steps to Reproduce

1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

## Expected Behavior

A clear and concise description of what you expected to happen.

## Actual Behavior

A clear and concise description of what actually happened.

## Screenshots

If applicable, add screenshots to help explain your problem.

## Environment

- **Browser**: [e.g., Chrome 120, Firefox 121]
- **OS**: [e.g., Windows 11, macOS 14, Linux Ubuntu 22.04]
- **Device**: [e.g., Desktop, Mobile, Tablet]
- **Screen Resolution**: [e.g., 1920x1080]

## Additional Context

Add any other context about the problem here. This might include:
- When did you first notice this issue?
- Does it happen consistently or intermittently?
- Have you tried any workarounds?

## Possible Solution

If you have suggestions on how to fix the bug, please share them here.

12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
blank_issues_enabled: true
contact_links:
- name: Discord Community
url: https://discord.gg/54WX832HBM
about: Join our Discord for real-time help and discussions
- name: Official Hytale Website
url: https://hytale.com/
about: Visit the official Hytale website for game information
- name: Hytale Modding Strategy
url: https://hytale.com/news/2025/11/hytale-modding-strategy-and-status
about: Read about Hytale's official modding strategy and roadmap

54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Documentation Issue
about: Report errors, unclear content, or missing information in the documentation
title: '[DOCS] '
labels: documentation
assignees: ''
---

## Documentation Issue Type

- [ ] Typo or grammatical error
- [ ] Incorrect or outdated information
- [ ] Unclear explanation or confusing content
- [ ] Missing documentation for a topic
- [ ] Broken links or images
- [ ] Code example not working
- [ ] Other (please describe)

## Location

**Page/File**: [e.g., `/docs/quick-start` or `content/docs/what-we-know-so-far/plugin.mdx`]

**Section**: [e.g., "Installation" heading, line 45-50]

## Issue Description

A clear and concise description of the documentation issue.

## Current Content

If applicable, paste or quote the current content that needs to be fixed:

```
Current content here...
```

## Suggested Improvement

If you have suggestions for how to improve or fix the content:

```
Suggested content here...
```

## Additional Context

- Why is this confusing or incorrect?
- What were you trying to accomplish when you found this issue?
- Are there any official Hytale sources that clarify this topic?

## Related Issues

Link any related issues or pull requests here.

72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
name: Feature Request
about: Suggest a new feature or enhancement for the documentation site
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

## Feature Type

- [ ] New documentation topic
- [ ] Site functionality improvement
- [ ] UI/UX enhancement
- [ ] Search improvement
- [ ] Navigation enhancement
- [ ] Developer experience
- [ ] Other (please describe)

## Problem Statement

**Is your feature request related to a problem? Please describe.**

A clear and concise description of what the problem is. For example: "I'm always frustrated when [...]" or "It's difficult to find information about [...]"

## Proposed Solution

**Describe the solution you'd like**

A clear and concise description of what you want to happen. Include:
- What should be added or changed?
- How would this help users?
- What would the user experience look like?

## Alternative Solutions

**Describe alternatives you've considered**

A clear and concise description of any alternative solutions or features you've considered.

## Benefits to the Community

Who would benefit from this feature and how?
- [ ] Beginners learning Hytale modding
- [ ] Experienced plugin developers
- [ ] Content creators and modelers
- [ ] Documentation contributors
- [ ] Site visitors in general

## Implementation Ideas

If you have ideas about how this could be implemented:
- Technical approach
- Required resources
- Potential challenges

## Examples

Provide examples of similar features in other documentation sites or projects:
- [Link to example 1]
- [Link to example 2]

## Additional Context

Add any other context, screenshots, or mockups about the feature request here.

## Hytale Relevance

How does this relate to Hytale modding specifically?
- Does it address a specific Hytale modding concept?
- Is it based on official Hytale information?
- Would it help with server-first development, plugins, data assets, etc.?

52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: Question
about: Ask a question about the documentation or Hytale modding
title: '[QUESTION] '
labels: question
assignees: ''
---

## Question

What would you like to know?

## Context

Please provide context for your question:
- What are you trying to accomplish?
- What have you already tried?
- Where did you look for answers?

## Related Documentation

Have you checked the following resources?
- [ ] This documentation site
- [ ] [Official Hytale Blog](https://hytale.com/news)
- [ ] [Hytale Modding Strategy Post](https://hytale.com/news/2025/11/hytale-modding-strategy-and-status)
- [ ] Community Discord
- [ ] Searched existing issues

## Your Skill Level

This helps us provide an appropriate answer:
- [ ] New to Hytale modding
- [ ] Some experience with modding
- [ ] Experienced modder
- [ ] Professional developer

## Modding Category

What aspect of Hytale modding does your question relate to?
- [ ] Server plugins (Java)
- [ ] Data assets (JSON)
- [ ] Art assets (Blockbench, textures, models)
- [ ] Visual scripting
- [ ] World generation
- [ ] General concepts
- [ ] Documentation site itself
- [ ] Other

## Additional Information

Add any other relevant information, code snippets, or screenshots here.

40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Pull Request

## Description

Brief description of what this PR does.

## Type of Change

- [ ] Documentation fix (typo, grammar, clarification)
- [ ] New documentation (guide, tutorial, page)
- [ ] Bug fix
- [ ] New feature
- [ ] Other

## Related Issues

Fixes #(issue)

## Changes

-
-
-

## Screenshots

If applicable, add before/after screenshots:

## Checklist

- [ ] Tested locally with `bun run dev`
- [ ] Ran `bun audit` (no critical vulnerabilities)
- [ ] Checked spelling and grammar
- [ ] Verified all links work
- [ ] Followed [Contributing Guidelines](../CONTRIBUTING.md)

---

Thank you for contributing!

91 changes: 91 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our Hytale modding documentation community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community focused on helping everyone learn and succeed in Hytale modding.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
- Helping newcomers get started with Hytale modding
- Sharing knowledge and resources generously
- Providing clear, accurate documentation

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Spreading misinformation or deliberately misleading documentation
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, including but not limited to:

- GitHub repositories and discussions
- Discord servers
- Community forums and social media
- Virtual or in-person events representing the community

It also applies when an individual is officially representing the community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement via GitHub issues or Discord moderators.

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

Loading