Git Workflow for Mod Teams

Version control and collaboration for Hytale mod development.

Quick Start

Initialize New Mod Repository

cd MyMod
git init
git add .
git commit -m "Initial commit: project structure"

Clone Existing Repository

git clone https://github.com/username/mymod.git
cd mymod

Recommended .gitignore

Create .gitignore in your project root:

# Build outputs
build/
out/
*.jar

# IDE files
.idea/
*.iml
.vscode/

# Gradle
.gradle/
gradle/wrapper/gradle-wrapper.jar

# OS files
.DS_Store
Thumbs.db

# Local config
local.properties
*.local

# Dependencies
node_modules/

# Antigravity brain (personal)
.gemini/

Branching Strategy

Simple Model (Small Teams)

main ────●────●────●────●────●────  (stable releases)
          \         \
           \         └─ feature/new-mob
            \
             └─ feature/custom-items

GitFlow (Larger Teams)

main ─────────────●─────────────●────  (releases only)
                  ↑             ↑
develop ──●───●───●───●───●───●─●────  (integration)
           \     /     \     /
            \   /       \   /
             ●─●         ●─●
          feature/a    feature/b

Branch Naming

Commit Message Convention

Format

<type>: <short description>

[optional body]

[optional footer]

Types

Examples

git commit -m "feat: add dragon mob with fire breath attack"
git commit -m "fix: prevent crash when spawning in water"
git commit -m "docs: update README with installation steps"
git commit -m "refactor: simplify combat system using ECS"

Daily Workflow

1. Start Your Day

# Get latest changes
git checkout main
git pull origin main

# Create feature branch
git checkout -b feature/my-feature

2. Work on Feature

# Make changes...

# Stage and commit frequently
git add .
git commit -m "feat: implement basic feature"

# Continue working...
git add .
git commit -m "feat: add configuration options"

3. Stay Updated

# Get latest main changes
git fetch origin
git rebase origin/main

# Or merge if preferred
git merge origin/main

4. Push and Create PR

# Push your branch
git push origin feature/my-feature

# Create Pull Request on GitHub

Pull Request Checklist

Before submitting a PR:

• Code compiles without errors (gradle build)
• Tested in-game
• Follows project conventions
• Documentation updated if needed
• Commit messages are clear
• No sensitive data committed

Resolving Conflicts

When Conflicts Occur

# After merge/rebase shows conflicts
git status  # See conflicting files

# Edit files to resolve
# Look for <<<<<<< ======= >>>>>>>

# Mark as resolved
git add <resolved-file>

# Continue
git rebase --continue
# or
git commit  # if merging

Useful Commands

Version Tagging

For mod releases:

# Create annotated tag
git tag -a v1.0.0 -m "Release version 1.0.0"

# Push tag to remote
git push origin v1.0.0

# List all tags
git tag -l

Versioning Convention

major.minor.patch
  │     │     │
  │     │     └─ Bug fixes
  │     └─────── New features (backwards compatible)
  └───────────── Breaking changes

Team Setup

Add Collaborators

1. Go to GitHub repository settings
2. Click “Collaborators”
3. Add team members by username

Protect Main Branch

1. Settings → Branches → Add rule
2. Branch name pattern: main
3. Enable:
   • Require pull request reviews
   • Require status checks to pass
   • Require branches to be up to date

Quick Reference

Resources

• GitHub Docs: docs.github.com
• Git Cheatsheet: education.github.com/git-cheat-sheet

3