GitHub Sync

Sync game configurations directly from a GitHub repository with version history, automated webhook deploys, and diff previews.

Overview

GitHub Sync allows you to maintain your ShadowConfig game variables directly inside a Git repository. Whenever you push changes to your repository, ShadowConfig automatically fetches the updated JSON manifest, validates the variables, and updates your live Roblox game config without requiring manual dashboard edits.

Key Benefits

• Version Control — Full git commit history for all game balance and config changes.
• Team Code Review — Use Pull Requests and branch protection rules before deploying configs to production games.
• Instant Deploys — Automated webhook triggers update your live game instantly when commits land on main.
• Diff & Rollback — Inspect visual diffs of previous commits in the dashboard and restore older states with one click.

Setting Up GitHub Sync

1. Create a file named config.json in your repository root (or custom path).
2. Structure your JSON as a key-value map of variable names to values:

   {
     "doubleXpEnabled": true,
     "goldMultiplier": 1.5,
     "eventName": "Summer Splash 2026",
     "starterLootTable": {
       "coins": 100,
       "potionCount": 3
     }
   }

3. Open the GitHub Sync tab in the ShadowConfig Dashboard.
4. Enter your repository (e.g. username/repo-name), file path (e.g. config.json), and a GitHub Personal Access Token (PAT) with read permissions.
5. Click Save & Sync GitHub Settings.

Webhook Automation

To enable automatic sync on push, add the ShadowConfig Webhook URL (found in your game's GitHub Sync tab) to your GitHub repository under Settings → Webhooks. Select content type application/json and trigger on push events.

Related Links

For running Roblox Lua scripts from GitHub, check out the Script Management Documentation.