DOCSEARCHbyAlgolia
Submit Docs

Game Server App Documentation

website·Indexed 32 days ago

https://docs.gameserverapp.com/

Documentation for managing game servers, including dashboard guides for automation, task creation, and machine setup via DediConnect. Includes comprehensive API references for System, Community, and Mod APIs to handle player details, server backups, configuration templates, and in-game reporting.

Tokens
54.9K
Snippets
134
Records
489
Agent score
59%

What's inside Game Server App

  1. Retrieve detailed information for a specific game server

    Use the 'Get game server details' endpoint to retrieve comprehensive data about a specific game server. This includes server identification, network connection details (IP and ports), health status, player counts, and backup configurations. The request requires a gameserver_id as a path parameter.

    Path Parameters:

    • gameserver_id (integer, REQUIRED): The unique identifier of the game server (e.g., 57294).

    Response Fields (200 OK):

    • id (integer): Server ID
    • name, display_name, short_name (string): Various naming identifiers
    • blueprint_version_id, config_template_id, machine_id (integer): Configuration and hardware associations
    • cluster_id (uuid), cluster_chat_name (string): Cluster association details
    • app_id (integer): Associated application ID
    • discord (object): Discord integration details
    • connection (object): Contains ip_address (ipv4), game_port (integer), query_port (integer), and rcon_port (integer)
    • activity (object): Contains status (boolean, indicates if server is healthy/online) and online_characters_count (integer, current player count)
    • backup (object): Contains backup_on_shutdown and backup_on_update (booleans)
    • last_healthy_at, last_error_at, created_at, updated_at (date-time): Server lifecycle and health timestamps

    Error Responses:

    • 404 Not Found: Returned if the game server is not found, containing an error string.

  2. Understand GameServerApp Blueprints

    Blueprints are configuration definitions that control how game servers and services operate. They determine file storage locations, backup inclusions, service operations, and which fields appear in Config templates. Blueprints are primarily used to host unsupported games/services, modify server behavior, or tailor setups to specific community needs.

  4. Manage community data using Admin tool overview pages

    The Admin tools section provides overview pages for Players, Characters, and Groups. These pages share common interface elements to help administrators manage their community:

    • Tabs: Used to switch between different views (e.g., filtering for banned players or those with notes). The active tab specifically shows entities active within the last 30 days.
    • Search & Filters: Located on the right-hand side; multiple filters can be combined to narrow down lists.
    • Table Controls: Admins can sort columns, change the number of rows displayed, show/hide specific columns, and reorder columns by dragging headers. These settings are persisted in the browser.
    • Bulk Actions: Available on dashboards with an active add-on. Admins can select up to 50 entities at once using the top-left checkbox to apply actions in bulk. The bulk actions button is enabled only after at least one entity is selected.

  6. Manage community groups and group details

    The Group detail page provides a centralized location to manage community groups. Key features include:

    • General Tab: Provides a quick overview of the group's name, ID, achievement score, associated characters, and notes.
    • Notes Block: Located in the sidebar, used for tracking group behavior, rule violations, or internal administrative notes.
    • Log Tab: If supported by the game, this tab displays in-game group logs with date filters to track group activity.
    • Public Profile Tab: Displays the group's public profile as seen on the Community website. Group owners and admins can customize this profile via the website.

  7. Choose a connection method for GameServerApp (GSA)

    GameServerApp (GSA) provides two primary ways to connect to your game server depending on your level of access and technical expertise:

    1. DediConnect: Best for dedicated root machines and game servers. It acts as an 'autopilot' and is designed for users with zero technical experience.
    2. RconConnect: Best for self-hosted or rented game servers. It provides control and visibility using RCON, granting access to most of GSA's toolset.

  8. Create and organize Access Groups

    To create a new group, navigate to the Access Control overview page and click + Add group. Provide a name for the group and click Create. To remove a group from the active view without deleting it, use the Archive button in the group's dropdown menu; archived groups are moved to the Archived tab.

  9. Create and configure a Supporter Tier

    Supporter Tiers allow you to offer exclusive perks via one-time or recurring payments. To create a tier:

    1. Navigate to the Supporter Tier overview page and click + Add Tier in the top-right corner.
    2. Enter a name for the tier and click Create.
    3. In the settings, provide a description (visible on the Community website), set the currency, price, and choose between a one-time or recurring payment.
    4. Click Save settings to apply changes.

  10. Generate AI summaries of player activity

    The Player activity summarizer allows you to see a high-level overview of community events without reading through all logs. These summaries can be sent to Discord via a trigger task using specific time-window variables.

    Available variables for activity summaries:

    • {variable.30_mins}: Summary of the last 30 minutes
    • {variable.4_hours}: Summary of the last 4 hours
    • {variable.12_hours}: Summary of the last 12 hours
    • {variable.24_hours}: Summary of the last 24 hours

  11. Handle error responses for Find Characters by Game ID API

    The Find Characters by Game ID endpoint may return the following error responses. Both error schemas optionally include an error string providing details about the failure:

    • 400 Bad Request: The request was invalid or cannot be served.
    • 404 Not Found: The requested resource or game ID could not be located.

  12. Use Delivery and Purchase variables

    Variables used to include details about a delivery. Some variables are specific to Shop packs or Supporter tiers.
    // General Delivery
{delivery.id}     - Delivery's unique ID
{delivery.status} - Delivery's current status

// Shop Pack Specific
{variable.purchase_quantity}      - Purchase quantity
{variable.purchase_date}           - Purchase date
{variable.purchase_amount}         - Purchase amount
{variable.purchase_currency}       - Purchase currency
{variable.transaction_description} - Transaction description
{variable.item_name}                - Item name

// Supporter Tier Specific
{variable.purchase_date}     - Purchase date
{variable.purchase_amount}    - Purchase amount
{variable.purchase_currency}   - Purchase currency
{variable.purchase_type}      - Purchase type
{variable.gateway}            - Gateway used
{variable.gateway_refid}      - Gateway reference ID