User Guide / GitHub Integration

GitHub Integration

Push and pull map files directly to GitHub repositories.

TileForge can save and load TMJ files directly from GitHub repositories, making it easy to keep your maps in version control alongside your game code.

Setting Up GitHub Access

Creating a Personal Access Token

  1. Go to GitHub Settings > Developer settings > Personal access tokens.
  2. Click Generate new token (classic).
  3. Give it a name like "TileForge Studio".
  4. Select the repo scope (full control of private repositories). For public repos only, public_repo is sufficient.
  5. Click Generate token and copy the token.

Connecting in TileForge

  1. Go to File > Save to GitHub or File > Load from GitHub.
  2. The first time, you will see the Connect to GitHub dialog.
  3. Paste your Personal Access Token and click Connect.
  4. Select a repository and branch from the dropdowns.

Your token is stored in localStorage (key: github_pat) so you only need to enter it once per browser.

Security Note Your GitHub token is stored in the browser's localStorage. It is not sent to any server other than GitHub's API. If you use a shared or public computer, disconnect after your session.

Saving to GitHub

  1. Go to File > Save to GitHub.
  2. Enter a file name (e.g., maps/dungeon-01.tmj).
  3. Review the path preview.
  4. Click Push to save.

TileForge uses the GitHub Contents API to create or update the file. If the file already exists, it is overwritten with the new version.

Loading from GitHub

  1. Go to File > Load from GitHub.
  2. The file browser shows TMJ files in the selected repository and branch.
  3. Click a file to load it into the editor.
Known Limitation The GitHub file browser shows a flat listing of files. It does not yet support navigating into subdirectories. Files in subdirectories are listed with their full path.

Recommended Workflow

Related Topics