gh-tree 🌴

• Minecraft Tree Biomes 🌸🌲⚪🌳🌴🪵🏜️🌿🔥🌌 — choose between 10 authentic biomes: Oak, Sakura / Cherry Blossom, Taiga Spruce, Golden Birch, Lush Jungle, Dark Oak, Savanna Acacia, Mangrove Swamp, Crimson Nether, or Warped Nether.
• Minecraft Biome Canopies — weekly commits drive the lushness and color intensity levels (Level 0 dormant to Level 4 rich emerald/pink/cyan/amber) across the 14 canopy blocks.
• Minecraft Pet Companions 🐾 (Wolf 🐺, Fox 🦊, Cat 🐱, Parrot 🦜) — tamed red-collared Wolf (tail-wagging with active streaks $\ge 14\text{d}$), sleeping/waking orange Fox (curled up during day, alert at night for streak $\ge 7\text{d}$), cute Tuxedo Cat, and dancing Red Macaw Parrot (with tri-color wings & head-bobbing dance).
• Roasting Campfire 🔥 — crackling campfire with rising smoke particles and flying ember sparks during high-velocity sprint periods.
• Milestone Treasure Chests 📦 (Wood, Iron, Gold, Diamond, Ender 🔮) — treasure chests sitting flush on the lawn leveling up as your total commit milestones grow, culminating in the Ender Chest with glowing Eye of Ender and floating portal particles!
• Seasonal Holiday Modes 🎃🎄🎆 — auto-detects or manual Halloween (glowing Jack-o'-Lantern & flying spooky ghosts), Holiday Christmas (twinkling canopy fairy lights & wrapped gifts), and New Year Fireworks (colorful sky starbursts).
• Wooden & Milestone Stat Signposts 🪧 (Wood, Gold 🪙, Diamond 💎) — a pixelated signpost displaying your live streak with smart auto-scaling (14d, 100d, 1.2k), leveling up with glowing ink & royal crowns for Century Club ($\ge 100\text{d}$) and 1-Year ($\ge 365\text{d}$) streaks!
• Minecraft Bee 🐝 & Streak Beehive 🍯 — an animated buzzing bee with fluttering wings and a wooden beehive on the trunk celebrating your active commit streak.
• Underground Ore Blocks 💎 (Netherite, Gold, Diamond, Emerald, Lapis Lazuli, Redstone) — embedded in the dirt layer featuring creator-exclusive Netherite (@nivinvysakh), Lapis Lazuli exclusively for verified nivinvysakh/gh-tree contributors, and productivity milestone ores.
• Minecraft Flowers 🌸 (Open PRs) — up to 4 colorful flowers (Poppies, Dandelions, Tulips, Sakura) planted on the lawn.
• Minecraft Red Apples 🍎 (Merged PRs) — up to 4 ripe red apples hanging beneath the canopy leaf blocks.
• Minecraft Golden Apples 🍏✨ (Assigned PRs / Reviews) — up to 4 enchanted golden apples placed on the lawn.
• Live Weather & Day/Night Cycle ☀️🌕🌧️❄️☁️ — real-time weather integration (via Open-Meteo) rendering animated Sun, Starry Night Moon & twinkling stars, Rain streaks & splashes, Snowfall & snow caps, or Drifting clouds.
• Transparent Background — pure alpha transparency that seamlessly blends into dark and light GitHub profiles and READMEs.

Classic Oak 🌳 (tree-type: oak)	Sakura Cherry Blossom 🌸 (tree-type: sakura)
Classic Oak, Wolf Pet, Campfire & Chest	Cherry blossom pinks, Cat Pet & falling petals

Taiga Spruce 🌲 (tree-type: spruce)	Birch Forest ⚪ (tree-type: birch)
Dark coniferous needles, Fox & spruce bark	White notched birch bark & Wolf pet

Lush Jungle 🌴 (tree-type: jungle)	Dark Oak Forest 🪵 (tree-type: dark_oak)
Tropical rainforest emeralds & Parrot pet	Deep shadow canopy & Wolf pet

Savanna Acacia 🏜️ (tree-type: acacia)	Mangrove Swamp 🌿 (tree-type: mangrove)
Warm sunset amber leaves & Fox pet	Bayou olive foliage, swamp roots & Campfire

Crimson Nether 🔥 (tree-type: crimson)	Warped Nether 🌌 (tree-type: warped)
Nether crimson hyphae & floating red spores	Bioluminescent cyan canopy & cyan spores

Minecraft Farmer Villager 👨‍🌾 (pet: farmer)	Ender Milestone Chest 🔮 (≥ 500 Commits)	Red Macaw Parrot 🦜 (pet: parrot)
Default companion with straw hat, robe & wheat	Obsidian body, glowing Eye of Ender & portal particles	Dancing head-bob & tri-color fluttering wings

Spooky Halloween 🎃 (event: halloween)	Winter Holiday Christmas 🎄 (event: holiday)	New Year Fireworks 🎆 (event: fireworks)
Carved Jack-o'-Lantern & Flying Ghosts	Twinkling fairy lights, gifts & snow	Sky starburst fireworks, Campfire & Fox

Starry Night 🌕✨ (weather: night)	Rainy 🌧️ (weather: rain)
Starry night sky, alert Fox & Moon	Slanted rain streaks & splashes

Snowy ❄️ (weather: snow)	Cloudy ☁️ (weather: cloudy)
Fluttering snow & snow-capped leaves	Multi-layered drifting overcast clouds & Fox

gh-tree turns your GitHub contributions into living Minecraft collectibles and milestones:

Embedded in the underground dirt layer beneath your tree, 6 distinct ore blocks unlock as you hit maintainer, contributor, and productivity milestones:

Ore Block	Appearance	Unlock Condition	What It Represents
Netherite / Ancient Debris 🪨	(Slot 0: Far-Left)	Action Creator Exclusive (@nivinvysakh or is-owner: true)	👑 gh-tree Creator & Maintainer — Minecraft's rarest material, awarded exclusively to the author of the action!
Gold Ore 🪙	(Slot 1: Mid-Left 1)	• Current streak ≥ 7 days, OR • ≥ 50 total commits	⚡ Streak Dedication — milestone for sustained rhythm and week-long consistency.
Diamond Ore 💎	(Slot 2: Mid-Left 2)	• ≥ 25 total commits in date range, OR • ≥ 1 merged PR	💎 Active Contributor — milestone for regular code contributions and PR merges.
Emerald Ore ❇️	(Slot 3: Mid-Right 1)	• ≥ 100 total commits in date range, OR • Any weekly branch reaching Level 4 (30+ commits/week)	🏆 Power Contributor — rare milestone awarded for high commit volume and intense development sprints.
Lapis Lazuli Ore 🔷	(Slot 4: Mid-Right 2)	Contributed to nivinvysakh/gh-tree (verified via GitHub API or is-contributor: true)	🤝 gh-tree Contributor Badge — special celestial blue ore awarded exclusively to developers who have contributed code/PRs to the nivinvysakh/gh-tree repository!
Redstone Ore 🔴	(Slot 5: Far-Right)	• Merged PRs ≥ 2, OR • Total PR activity ≥ 3, OR • Current streak ≥ 14 days	⚙️ Engineering & Automation — milestone honoring pull request lifecycle, code reviews, and multi-week streaks.

• 14 Weekly Canopy Blocks: 14 distinct branches representing your recent contribution weeks.
• Commit Intensity: Leaf colors dynamically transition across 5 levels from Level 0 (dormant/dry) up to Level 4 (lush emerald or vibrant sakura pink) based on weekly commit volume.

• Flowers 🌸 (Open PRs): Up to 4 colorful Minecraft flowers (Poppies, Dandelions, Tulips, Sakura) planted across the grass lawn.
• Red Apples 🍎 (Merged PRs): Up to 4 ripe red apples hanging beneath the canopy leaf blocks.
• Golden Apples 🍏✨ (Assigned PRs / Reviews): Up to 4 enchanted golden apples placed on the lawn.

• Wooden & Milestone Stat Signposts 🪧: Renders your active consecutive commit streak using a crisp pixel font and smart auto-scaling (14d, 100d, 365d, 1.2k). Features progressive milestone tiers:
  • 🪵 Classic Oak Signpost (< 100 days): Warm carved wooden board with high-contrast golden star.
  • 🪙 Golden Milestone Signpost ($\ge 100$ days): Golden inlay frame, glowing warm gold ink, and a royal gold crown 👑 for the Century Club!
  • 💎 Diamond Milestone Signpost ($\ge 365$ days): Prismatic diamond teal frame, glowing diamond-cyan ink, and an illuminated diamond crown 👑 for 1+ year streaks!
• Beehive 🍯 & Animated Bee 🐝: A wooden beehive appears on the trunk for active streaks (≥ 3 days) or ≥ 25 commits, while an animated Minecraft bee buzzes around the tree during fair weather.

Classic Oak Signpost 🪵 (< 100 days)	Century Club Gold Signpost 🪙👑 (≥ 100 days)	Diamond 1-Year Signpost 💎👑 (≥ 365 days)
Standard carved wood board & Star	Golden frame, glowing gold text & Crown	Prismatic teal frame, glowing cyan text & Crown

Choose the integration method that fits your workflow:

Paste this single line directly into your GitHub Profile README.md (no workflows, YAML files, or tokens needed!):

[![Minecraft Tree](https://gh-tree.vercel.app/api/tree?user=YOUR_USERNAME&theme=sakura)](https://github.com/nivinvysakh/gh-tree)

Customize with URL parameters:

• user: Your GitHub username (?user=nivinvysakh)
• theme: oak | sakura | spruce | birch | jungle | dark_oak | acacia | mangrove | crimson | warped (default: oak)
• weather: auto | sunny | rain | snow | night | cloudy
• farmer: true | false | auto (default: auto - stands under tree caring for it)
• farmer_mood: auto | sad | dancing | watering (default: auto - dynamic tree health reaction)
• pet: auto | wolf | fox | cat | parrot | none
• event: auto | halloween | holiday | fireworks | none
• campfire: true | false | auto

👉 Customize live in the gh-tree Studio.

If you prefer self-hosting the animated GIF in your repository, add this workflow at .github/workflows/tree.yml:

name: Generate Commit Tree

on:
  schedule:
    - cron: '0 0 * * *' # Runs daily at midnight
  workflow_dispatch:

permissions:
  contents: write

jobs:
  update-tree:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: nivinvysakh/gh-tree@main
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

Customize your tree with biomes, pet companions, campfire, milestone chests, seasonal events, and live weather:

name: Generate Commit Tree

on:
  schedule:
    - cron: '0 0 * * *' # Runs daily at midnight
  workflow_dispatch:

permissions:
  contents: write

jobs:
  update-tree:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: nivinvysakh/gh-tree@main
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          # Tree biome variety (10 Minecraft biomes): oak | sakura | spruce | birch | jungle | dark_oak | acacia | mangrove | crimson | warped
          tree-type: "sakura"
          # Human farmer under the tree (right side): auto | true | false
          show-farmer: "auto"
          # Farmer mood: auto | sad | dancing | watering
          farmer-mood: "auto"
          # Animal companion pet (left side): auto | wolf | fox | cat | parrot | none
          pet: "auto"
          # Roasting campfire & milestone treasure chest: auto | true | false
          show-campfire: "auto"
          show-chest: "auto"
          # Seasonal holiday event: auto | halloween | holiday | fireworks | none
          event: "auto"
          # Live weather from Open-Meteo for your city (auto-detects sun, night, rain, snow, clouds)
          city: "Tokyo"
          # Or manually force a weather condition: auto | sunny | night | rain | snow | cloudy
          weather: "auto"
          # Recency window in days for flowers (open PRs), red apples (merged PRs), and golden apples
          pr-days: "14"
          # Total days of history to fetch for commit canopy leaves (~14 weekly tiers)
          days: "140"
          # Whether to show the wooden streak signpost and animated bee
          show-signpost: "true"
          show-bee: "true"

Add this anywhere in your README.md:

<!-- commit-tree-start -->
![tree](tree.gif?v=1789842706342)
<!-- commit-tree-end -->

The action will automatically generate tree.gif, update your README.md, and commit the changes!

gh-tree/
├── .github/
│   └── workflows/
│       ├── ci.yml                 # Continuous Integration (tests & typecheck)
│       ├── deploy-pages.yml       # GitHub Pages automated deployment workflow
│       ├── generate-tree.yml      # Daily profile commit tree generator action
│       ├── dependabot-pr.yml      # Dependabot PR automation
│       ├── pr-auto-assign.yml     # PR reviewer and assignee automation
│       └── wiki-sync.yml          # Documentation auto-synchronizer with GitHub Wiki
├── assets/                        # Static demo GIFs, ore SVGs, and visual artifacts
│   ├── ore-*.svg                  # Underground ore block vectors (Netherite, Lapis, Diamond...)
│   └── tree-*.gif                 # Biome, weather, and streak showcase GIFs
├── dist/                          # Compiled GitHub Action bundle (ncc distribution)
├── site/                          # gh-tree Studio Web Application (Vite + Tailwind CSS v4)
│   ├── index.html                 # Main Studio single-page application
│   ├── 404.html                   # Minecraft Void 404 error page
│   ├── favicon.svg                # Emerald glowing palm tree favicon
│   ├── styles.css                 # Minecraft dark glassmorphism design system
│   ├── vite.config.ts             # Multi-page Vite configuration
│   └── src/
│       ├── app.ts                 # Studio app controller, UI bindings & modal handlers
│       ├── preview.ts             # Real-time frame looping engine with SVG animation
│       ├── gif-browser.ts         # Client-side canvas rasterizer and GIF encoder (gifenc)
│       ├── github-api.ts          # CORS contribution fetcher, streak calculator & PR stats
│       └── presets.ts             # Curated themes & preset configurations
├── src/                           # GitHub Action Core Source Code (TypeScript)
│   ├── main.ts                    # Action entrypoint, CLI input parser & auto-committer
│   ├── tree.ts                    # Minecraft tree geometry, canopy grid & prop layout builder
│   ├── svg.ts                     # Pixel art raster-to-SVG frame rendering engine
│   ├── gif.ts                     # Multi-frame GIF encoder (gifenc + Resvg WASM)
│   ├── github.ts                  # GraphQL/REST GitHub contribution calendar fetcher
│   ├── weather.ts                 # Live weather integration (Open-Meteo API)
│   └── markdown.ts                # Profile README.md tag replacer & updater
├── test/                          # Comprehensive Unit & Integration Test Suite (Vitest)
│   ├── tree.test.ts               # Tree layout, biome, and collectibles tests
│   ├── svg.test.ts                # SVG rendering, typography & milestone chest tests
│   ├── github.test.ts             # Contribution calendar and streak calculation tests
│   ├── weather.test.ts            # Weather parser & condition mapping tests
│   ├── markdown.test.ts           # Markdown file replacement tests
│   ├── gif.test.ts                # GIF binary encoding tests
│   └── e2e.test.ts                # Full end-to-end rendering pipeline test
├── scripts/                       # Developer utility scripts
│   └── generate-mock.ts           # Offline local mock GIF generator for all biomes
├── wiki/                          # Documentation knowledge base synced to GitHub Wiki
├── action.yml                     # GitHub Action definition & input/output schema
├── package.json                   # Project dependencies and npm scripts
├── tsconfig.json                  # TypeScript compiler configuration
└── README.md                      # Repository documentation & visual showcase

Generate local sample GIFs for all biomes and weather conditions without needing a token:

npm run generate:mock

Run test suite:

npm test

Build action bundle:

npm run build

Run web studio locally:

npm run site:dev

Big thanks to all of the amazing people who have helped by contributing to this project!

Interested in contributing? Check out our Contributing Guide and Code of Conduct to get started and unlock your Lapis Lazuli Ore! 🔷