# Gameshipper

> Gameshipper turns a web game folder into Windows, Mac and Linux builds you can upload to Steam, plus Xcode and Android Studio projects for the App Store and Google Play. Free and open source. Each link below is a docs page as Markdown.

## Docs

- [Getting started](https://gameshipper.com/docs/index.md): Turn a web game folder into Windows, Mac and Linux builds for Steam, plus Xcode and Android Studio projects: the commands, what you need, and where to go next.
- [Commands](https://gameshipper.com/docs/commands.md): Every Gameshipper command and flag: init, play, build, check, publish, status, ci init, mcp and help.
- [gameshipper.json](https://gameshipper.com/docs/configuration.md): The gameshipper.json config file, what gets packaged, the files Gameshipper writes, environment variables and TypeScript types.
- [For AI agents](https://gameshipper.com/docs/ai-agents.md): How an AI agent drives Gameshipper: one JSON object per command, stable error codes with fixes, exit codes, and the loop to run.
- [MCP server and Claude Code plugin](https://gameshipper.com/docs/mcp.md): Run Gameshipper as an MCP server for Claude Code, Cursor and other clients, and install the Claude Code plugin.
- [GitHub Actions](https://gameshipper.com/docs/github-actions.md): Generate a GitHub Actions workflow that builds and smoke-tests your game on Windows, macOS and Linux.
- [Steam](https://gameshipper.com/docs/steam.md): Use window.steam for achievements, stats, leaderboards, rich presence and the overlay, with your own Steamworks SDK.
- [Store images and screenshots](https://gameshipper.com/docs/store-images.md): Generate all eight Steam store images from one key art and one logo, and capture 1920x1080 screenshots.
- [Saves](https://gameshipper.com/docs/saves.md): Save games with window.gameshipper.saves: one JSON file per slot on desktop, and the same API on iOS and Android.
- [Publishing](https://gameshipper.com/docs/publishing.md): Upload builds to Steam, itch.io and GitHub Releases with gameshipper publish, and what each error code means.
- [Building from each OS](https://gameshipper.com/docs/platforms.md): Which targets you can build from macOS, Linux and Windows.
- [Mac signing and notarization](https://gameshipper.com/docs/mac-signing.md): Sign and notarize Mac builds with your Apple Developer ID so Steam accepts them.
- [iOS and Android](https://gameshipper.com/docs/mobile.md): Generate Xcode and Android Studio projects for the App Store and Google Play from the same game files.
- [Plugins](https://gameshipper.com/docs/plugins.md): Extend a build with plugins: functions your game can call in Electron's main process, and build hooks.
- [Status of 0.1.0](https://gameshipper.com/docs/status.md): What has been verified in this version of Gameshipper and what has not been verified yet.

## Source

- [GitHub repository](https://github.com/gameshipper/gameshipper)