ShadowConfigDocs

Scripts & GitHub

Deploy scripts to Roblox, import from GitHub, and keep game logic versioned.

Script Management

The Scripts tab is your file browser for files pushed into your game. This is separate from config variables. Each file has its own manifest entry so you can inspect metadata, track revisions, and manage versions from the dashboard.

  • View manifest and metadata — see file names, paths, and timestamps.
  • Trigger syncs — manually push updates from the dashboard without republishing.
  • Remove files — delete scripts you no longer need directly from the dashboard.
  • Scope — scripts are tied to the selected game. Switching games loads a different manifest.

GitHub Integration

Link a GitHub repository to import scripts or templates directly into the dashboard. This is useful for teams that want their commands, configs, and modules versioned alongside their game source.

  • customcommands.json — define command templates in GitHub and import them into the dashboard.
  • Shared modules — reuse Lua files between multiple games from one repo.
  • Version history — GitHub keeps a record of who changed what, so you can audit command logic.
  • CI-ready — once imported, the dashboard can dispatch commands without manual file uploads.

If GitHub import fails, check that the repository is public or that the connected GitHub account has access. Also verify the file paths in your repo match what the dashboard expects.

Setup Scripts

Every game needs a small setup script injected into Studio. The dashboard provides ready-to-paste Lua blocks for the core runtime channels. Paste each block into the correct container in Studio exactly once.

  • Config consumption — ShadowConfig reads dashboard variables and exposes GetAsync.
  • Remote command handling — InboundCommands listens for MessagingService events and routes them to handlers.
  • Scripts consumption — ShadowConfigScripts manages deployed files and sync state.
  • Logging — a postLog helper posts embeds straight to your Discord webhook URL.

Best Practices

  • Keep setup scripts in ServerScriptService unless client-side consumption is explicitly needed.
  • Use descriptive file names and folders so teammates can find logic quickly across games.
  • Commit customcommands.json to GitHub so your team can review command changes before they deploy.
  • Don’t edit dashboard-generated scripts from multiple places at once. Choose one source of truth: either the dashboard or GitHub.