Steamworks Guide (Work in Progress)

rob1221

  • *
  • Posts: 9424
This is a work in progress guide for Steamworks that covers some important parts of the site.  More information will be added over time, but some of the easier and more obvious parts of the site will not be included.  For the SteamWrap extension, check this thread: http://community.stencyl.com/index.php/topic,47705.0.html

Build Configuration
Under Edit Steamworks Settings, go to SteamPipe > Depots.  Then configure whatever depots you need, although most devs will only need one depot per OS.  If you add any new depots, then you'll need to click on the link directly above the "Add New Depot" button to go to the packages page.  For each package (should be at least 3) you need to click on them and then add your new depots to those packages.  After that, go back to Edit Steamworks Settings and then to Installation > General.  Here is where you configure the launch options needed for your game.  Fill in the name of the main executable for each OS, which is your project name followed by .exe for Windows and .app for Mac.  Also select the appropriate OS for the executable.  After that is done, you're ready to upload builds. 

Uploading Builds
If you haven't already, download the latest SDK from Steamworks.  This includes the tools needed to upload a build.  Steam has included a GUI to make publishing easy, but it's only available on Windows (others must set up scripts and use the command line).  For Windows users, go to the tools folder within the SDK folder and you should see the SteamPipe GUI in there.  Open it and fill out the fields with your game details.  While this tool is Windows-only, it can upload Mac and Linux builds too.  The build paths for depots are the paths to your published game files.  After filling out all the required fields, click Upload to send the builds to Steam.  After that, go to Edit Steamworks Settings > SteamPipe > Builds and set the branch for the build which is the default branch if you haven't added more.

Cloud Saves
While the SteamWrap extension does not use the API for cloud saves, you can tell Steam where the save files are located and that will allow you to use cloud saves.  After setting your byte and file quotas in the Steam Cloud Settings and saving, you'll see options to configure your save file paths.  Attached is an example of how I set up the paths for my game Isotiles so that cloud saving works on both PC and Mac.  Linux should work as well if you know the path to the save files.

« Last Edit: May 23, 2018, 12:49:57 pm by rob1221 »

LIBERADO

  • *
  • Posts: 2652
Thank you very much for this useful guide.
I'm spanish, excuse me for my bad English.
I'm not a private teacher. Please, post your questions in the public forum.