Skip to main content

Getting Started

Blueprints allow you to customize how game servers and services operate behind the scenes. They also control the fields available in Config templates.

Blueprints can also be used to host games and services that aren't officially supported by GameServerApp.

Go to Blueprints >

Blueprint Marketplace

Not sure where to start?
Explore the Blueprint marketplace to find existing blueprints and launch a game server effortlessly.

What Are Blueprints?​

The term "blueprint" might be familiar from games or construction plans.

GameServerApp blueprints work similarly—they're like schematics that define how game servers and Config templates should behave, where files are stored, what to include in backups, and more.

Blueprints are useful for:

  • Hosting games and services not available on the GSA platform.
  • Modifying behavior on existing servers.
  • Tailoring game servers to better fit your community.

Using Blueprints​

Switching Blueprints​

When working with game servers or Config templates, you may encounter a dropdown menu where you can select a blueprint.

You can choose from three types of blueprints:

  • GameServerApp blueprints - Official/default GSA blueprints available by default.
  • Followed blueprints - Community-generated blueprints that you follow on the marketplace.
  • Your blueprints - Blueprints you've created, forked, or those created by admins on your dashboard.

Blueprint - Using Blueprints - Select Blueprint Dropdown

Versions​

Each time an author updates a blueprint, a new version is created.
Versions help you track changes and allow you to revert to earlier versions if needed.

When a new blueprint version is available, you can update your game servers and Config templates to the latest version.

Blueprint - Using Blueprints - Blueprint Versioning

Activate Blueprint Version​

To activate a blueprint version, select it from the version menu on the right side of the blueprint page, and click Activate selected version. Then, choose one or more game servers and/or Config templates in the popup.

The selected game servers and Config templates will switch to the new blueprint version.
Ensure that game servers are shut down before changing the blueprint.

Blueprint - Using Blueprints - Blueprint Activate Version

The marketplace is a great place to get inspired and share with the community, offering both official and community-generated blueprints.

Follow a Marketplace Blueprint​

The blueprint marketplace is an excellent resource for finding ready-to-use blueprints.
Use the search and filter options to narrow down your results and find the perfect blueprint.

You can filter results by OS (Linux or Windows), Type (official or community-generated blueprints), and Game.

Blueprint - Follow Blueprint - Search Marketplace

Follow Blueprint​

Once you find the right blueprint, click the Follow button in the top-right corner.

Following a blueprint downloads it to your dashboard, making it available for use on game servers and Config templates.

Blueprint - Follow Blueprint - Follow Blueprint

You can also activate the blueprint on game servers and Config templates immediately.
Remember to shut down game servers before changing the blueprint.

Blueprint - Follow Blueprint - Follow Blueprint Modal

Done!​

The blueprint is now visible on your dashboard and ready to use with game servers and Config templates.
If you made a mistake, you can delete the followed blueprint to remove it from your dashboard.

Blueprint Updates
When the blueprint author uploads a new version, it will appear on your dashboard. However, game servers and Config templates won't automatically update to the latest version.

Blueprint - Follow Blueprint - Show Followed Blueprint on Blueprint Overview

Manage​

Clone​

Cloning a blueprint creates an exact copy of the original.
Clones are automatically unpublished, and all blueprint versions switch to DEV mode.

Blueprint - Manage - Clone Blueprint

Fork​

Forking is similar to cloning; it creates an exact copy of the original.

The key difference between forking and cloning is that you can't clone a blueprint from the marketplace. If a marketplace blueprint allows forking, you can copy the original and make changes.

The blueprint author can disable forking; in that case, the fork button won't be visible.

Blueprint - Manage - Fork Blueprint

Delete​

If you no longer need a blueprint, you can remove it through the blueprint overview page.

Blueprint - Manage - Delete Blueprint

What Blueprints Can Do For...​

Learn how to create your first blueprint >

Game Servers​

Blueprints can modify nearly every aspect of a game server, including:

  • Executables, launch parameters, Steam server ID for installation & updates.
  • Methods for monitoring game server online status.
  • RCON/Telnet/WebSocket connection methods & commands (save, broadcast, etc.).
  • Files to include in backups & remove during wipes.
  • Available files & directories via FTP.
  • Docker container settings (image, mounts, ports, etc.).

Config Templates​

Every blueprint includes a Config template section where configuration files and parameters are registered. GameServerApp handles uploading the files and parameters to the game server.

After modifying the Config template section of a blueprint, you should activate the new blueprint version to apply the changes to game servers and Config templates.

Blueprint - What Blueprints Can Do For - Config Templates

In this article