workshop-upload

Upload an addon to the Garry's Mod Steam Workshop.

Features

• Upload an addon to the Garry's Mod Steam Workshop.
  • Includes changelog and icon.
• Login using password, TOTP, or VDF (recommended).
• Uses completely open source tools (SteamCMD, fastgmad)
  • Other actions use closed source binaries which might steal your credentials.
• Includes CLI for local use and testing.

Usage

You can use this action in your workflow by referencing it in your workflow file.

gmod-workshop/workshop-upload@v1

Advanced Example

name: Publish

on:
  release:
    types: [published]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: gmod-workshop/workshop-upload@v1
        with:
          username: ${{ secrets.STEAM_USERNAME }}
          vdf: ${{ secrets.STEAM_VDF }}
          id: ${{ secrets.ADDON_ID }}
          changelog: ${{ github.event.release.body }}
          dir: ./

Inputs

Name	Description	Required
username	Steam username	Yes
password	Steam password	No
totp	Steam TOTP code	No
vdf	Steam account VDF	No
id	Addon ID	No
changelog	Addon changelog	No
icon	Addon icon	No
dir	Addon directory	Yes
title	Addon title	No
description	Addon description	No

Authentication

There are three ways to authenticate with Steam:

• Password
• TOTP
• VDF (recommended)

Password

You can use your Steam password to login. This is the least secure method, as this requires Steam Guard to be disabled.

TOTP

You can use your Steam TOTP code to login. This requires Steam Guard to be enabled, and you must have a code ready when the workflow runs. This is not recommended, as it is unreliable.

VDF

You can use your Steam account VDF to login. This is the most secure method.

Generating a VDF

• To create a VDF, you must install SteamCMD locally and login to your account.
  • You can have SteamGuard enabled. You will be prompted to enter a code. This is only required once.
• The folder containing SteamCMD should not contain a config directory with a config.vdf file.
• Copy the contents of this file and base64 encode it. This is your VDF.
  • You can use base64 on Linux or certutil -encode on Windows.
  • You can use this online tool to encode the file.
• Create a secret in your repository containing the base64 encoded VDF and pass it to the action.