Itch.io

Initialization

init

Set up some information needed to push a build.

Parameters

butlerExecutable: The path to the itch.io butler executable.

apiKeyID: The ID of the credentials where your itch.io API key is stored.

username: Your itch.io username.

Example

itch.init('C:/Program Files/Itch Butler/butler.exe', 'API_KEY', 'CoolUsername');

Pushing Builds

push

Push a new build to your itch.io page.

Parameters

gameDirectory: The directory in which your game is located.

gameName: The name of your game on itch.io (the last part of your project url).

channel: The channel to push your build to.

dryRun (optional): Fake an upload of your build. When this is true, your build isn't actually uploaded, but you can see what files would be changed if it was.

ignoredFiles (optional): A list of files to ignore.

Example

itch.push("${env.WORKSPACE}/Builds/Game", 'BestGameEver', 'beta-build', false, ['*.pdb', 'BuildLog.txt']);