.. _doc_pages_deployments_steam:

Steam
=====

Steam is one of the most popular platforms for distributing and selling games.
W4 Build provides an integrated deployment tool to help you publish your games directly to Steam.


.. warning:: Steam Guard Codes provided by the Authenticator app do not work correctly on CI environments. W4 Build Does not support the steam guard app

Requirements
------------

Before you can deploy to Steam using W4 Build, you need to set up a few things:

#. **Steamworks Account** — `Create an account <https://partner.steamgames.com/>`_
#. **Steamworks App** — `Create a Steamworks App <https://partner.steamgames.com/doc/store/application>`_
#. **Steamworks Depots** — `Create Steamworks Depots <https://partner.steamgames.com/doc/store/application/depots>`_


Bests Practices
---------------

#. Create a SteamWorks Account for using on W4 Build, this account should only have the required parameters. DO NOT use the steam guard code app, instead receive the codes via email. — `Deployment Account <https://partner.steamgames.com/doc/sdk/uploading#Build_Account>`_
#. SteamWorks BRanch. Dont deploy to default branch, use a different branch.  `Steam Branches <https://partner.steamgames.com/doc/store/application/branches#1>`_


Adding Depots in W4 Build
-------------------------

Every build artifact generated by W4 Build must be linked to a Steam Depot ID.
This means that each job defined in your build matrix should have an associated Depot ID.

For example:

- **Windows Desktop** → Has its own Depot ID

Make sure each target platform you plan to deploy has a corresponding Depot set up in Steamworks.

#. Click "Matrix Blueprints" under the Build Menu

    .. image:: ../img/steam/home.png
       :alt: Project Home Home

#. Clik the matrix that defines the game you are deploying

    .. image:: ../img/steam/mtrx_home.png
       :alt: Project Home Home

#. Click Add Job Button

    a New pop up window will be displayed, Type the Steam Depot ID that corresponds to this build

    .. image:: ../img/steam/depot.png
       :alt: Project Home Home

    .. warning:: Dont forget to add the depot ID, this is a numeric value


Configuring Steam Deployment
----------------------------

After each build has been configured with is depot, its time to configure the Steam deployment.


#. Click "Targets" under the Deploy Menu

    .. image:: ../img/steam/config_home.png
       :alt: Project Home Home

#. CLick "+ New Deployment Target" Button

#. Select Steam and type a description, and click save

    .. image:: ../img/steam/steam_opt.png
       :alt: Steam option

#. Fill the form with the following values


    .. image:: ../img/steam/steam_from.png
       :alt: Steam option

Each field is:

App ID:
    The app id is the numeric value that identifies your app. This can be obtained after creating the app on steam.
    Visit the app list on steam on

    - .. raw:: html

       <a href="https://partner.steamgames.com/apps/ target="_blank">Steam App List</a>
Username:
    SteamWorks username, same as the one used to login to steamworks

Password:
    SteamWorks password, same as the one used to login to steamworks

Steam Guard code:
    When deploying to Steam for the first time, Steam requires an additional security step called Steam Guard.
    After you run your first deployment (and fail), Steam will send you an alphanumeric Steam Guard code by email.

    Once you receive the code, copy it from your email and paste it into this field.
    After you enter the Steam Guard code once, W4 Build will reuse it automatically for future deployments.

Branch:
    This is the steamworks branch, if you are running the deployment for the first time. Deploy it to default and then create a separate branch
    More information about steam branches cna be found om  `Steam Branches <https://partner.steamgames.com/doc/store/application/branches#1>`_


Preview:
    Preview Mode lets you test your Steam deployment without actually publishing it.
    It simulates a real Steam upload to ensure everything is working correctly.

    Use Preview Mode while developing and testing your build pipeline.
    When you’re ready to deploy for real, simply disable Preview Mode.