Class GOGDistro

Distro that uploads builds to GOG (Good Old Games).

Inheritance
System.Object
UnityEngine.Object
UnityEngine.ScriptableObject
DistroBase
GOGDistro
Inherited Members
Namespace: sttz.Trimmer.Editor
Assembly: Trimmer-Editor.dll
Syntax
[CreateAssetMenu(fileName = "GOG Distro.asset", menuName = "Trimmer/GOG", order = 100)]
public class GOGDistro : DistroBase
Remarks

Uses GOG Galaxy Pipeline Builder to upload the builds.

You need to get GOG's Build Creator app or the Pipeline Builder as a separate download. These are only available to developer accounts that have them activated.

Builds are configured using JSON files. You can use the Build Creator to set up the build and the export it to JSON.

Since Trimmer Distros are path-independent, the project JSON is first processed and variables substituted. Available variables are:

  • {{BuiltTarget}}: Path to the last build of the given target
  • {{project}}: Path to the Unity project root
  • {{projects}}: Path to the original projects folder

The {{BuildTarget}} variables come from the given Build Profiles. Adding a variable from a build target that doesn't exist in any Build Profile will result in an error. Extra build targets that are never inserted into a project JSON will result in a warning. If multiple Build Profiles share a target, the last one will be used.

Fields

| Improve this Doc View Source

branch

The branch to upload the build to.

Declaration
[Keychain("GOGDistroBranch", "Name")]
public Login branch
Field Value
Type Description
Login
| Improve this Doc View Source

gogLogin

The user used to log into GOG.

Declaration
[Keychain("GOGDistro", null)]
public Login gogLogin
Field Value
Type Description
Login
| Improve this Doc View Source

ignoreList

Path to file containing patterns of files to be ignored.

Declaration
public string ignoreList
Field Value
Type Description
System.String
| Improve this Doc View Source

overrideVersion

Version to use instead of project version.

Declaration
public string overrideVersion
Field Value
Type Description
System.String
| Improve this Doc View Source

pipelineBuilderPath

Path to the GOG Galaxy Pipeline Builder.

Declaration
public string pipelineBuilderPath
Field Value
Type Description
System.String
| Improve this Doc View Source

projectsFolder

The folder where the project JSON files are stored.

Declaration
public string projectsFolder
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

DistributeCoroutine(IEnumerable<DistroBase.BuildPath>, Boolean)

Declaration
protected override IEnumerator DistributeCoroutine(IEnumerable<DistroBase.BuildPath> buildPaths, bool forceBuild)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<DistroBase.BuildPath> buildPaths
System.Boolean forceBuild
Returns
Type Description
System.Collections.IEnumerator
Overrides