Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 69 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A plugin that integrate with Pipelab <br>
Author: Armaldio <br>
Website: https://github.com/CynToolkit/construct-plugin <br>
Addon Url: https://github.com/CynToolkit/construct-plugin <br>
Download Latest Version : [Version: 2.4.0](https://github.com/CynToolkit/construct-plugin/releases/latest) <br>
Download Latest Version : [Version: 2.4.1](https://github.com/CynToolkit/construct-plugin/releases/latest) <br>
<sub>Made using [c3ide2-framework](https://github.com/ConstructFund/c3ide2-framework) </sub><br>

## Table of Contents
Expand Down Expand Up @@ -149,6 +149,18 @@ When Download type is Around the user, the offsets are the amount of entries aro
| Activate Steam overlay to web page | Activates Steam Overlay web browser directly to the specified URL | URL *(string)* <br>Mode *(combo)* <br> |
| Activate Steam overlay to store (synchronous) | Activates the Steam Overlay to the Steam store page for the provided app (synchronous) | App ID *(number)* <br>Flag *(combo)* <br>Tag *(string)* <br> |
| Activate Steam overlay to store | Activates the Steam Overlay to the Steam store page for the provided app | App ID *(number)* <br>Flag *(combo)* <br> |
| Trigger screenshot (synchronous) | Captures the current screen and saves to Steam screenshot library (synchronous) | Tag *(string)* <br> |
| Trigger screenshot | Captures the current screen and saves to Steam screenshot library | |
| Check DLC is installed (synchronous) | Checks if the user owns and has installed a specific DLC (synchronous) | DLC App ID *(number)* <br>Tag *(string)* <br> |
| Check DLC is installed | Checks if the user owns and has installed a specific DLC | DLC App ID *(number)* <br> |
| Create workshop item (synchronous) | Creates a new workshop item for the specified Steam App ID and returns its ID (synchronous) | App ID *(number)* <br>Tag *(string)* <br> |
| Create workshop item | Creates a new workshop item for the specified Steam App ID and returns its ID | App ID *(number)* <br> |
| Upload workshop item (synchronous) | Uploads content to a workshop item (synchronous) | App ID *(number)* <br>Item ID *(string)* <br>Title *(string)* <br>Description *(string)* <br>Content Folder Path *(string)* <br>Preview Image Path *(string)* <br>Tags *(string)* <br>Visibility *(combo)* <br>Tag *(string)* <br> |
| Upload workshop item | Uploads content to a workshop item | App ID *(number)* <br>Item ID *(string)* <br>Title *(string)* <br>Description *(string)* <br>Content Folder Path *(string)* <br>Preview Image Path *(string)* <br>Tags *(string)* <br>Visibility *(combo)* <br> |
| Get subscribed items with metadata (synchronous) | Gets all subscribed workshop items with their metadata and install info (synchronous) | Tag *(string)* <br> |
| Get subscribed items with metadata | Gets all subscribed workshop items with their metadata and install info | |
| Download workshop item (synchronous) | Downloads or updates a workshop item (synchronous) | Item ID *(string)* <br>High Priority *(boolean)* <br>Tag *(string)* <br> |
| Download workshop item | Downloads or updates a workshop item | Item ID *(string)* <br>High Priority *(boolean)* <br> |


---
Expand Down Expand Up @@ -347,6 +359,30 @@ When Download type is Around the user, the offsets are the amount of entries aro
| On any "ActivateToStore" success | Trigger when any of the "ActivateToStore" are executed with success. | |
| On "ActivateToStore" error | Trigger when the "ActivateToStore" failed to execute. | Tag *(string)* <br> |
| On any "ActivateToStore" error | Trigger when any of the "ActivateToStore" failed to execute. | |
| On "TriggerScreenshot" success | Trigger when the "TriggerScreenshot" is executed with success. | Tag *(string)* <br> |
| On any "TriggerScreenshot" success | Trigger when any of the "TriggerScreenshot" are executed with success. | |
| On "TriggerScreenshot" error | Trigger when the "TriggerScreenshot" failed to execute. | Tag *(string)* <br> |
| On any "TriggerScreenshot" error | Trigger when any of the "TriggerScreenshot" failed to execute. | |
| On "CheckDLCIsInstalled" success | Trigger when the "CheckDLCIsInstalled" is executed with success. | Tag *(string)* <br> |
| On any "CheckDLCIsInstalled" success | Trigger when any of the "CheckDLCIsInstalled" are executed with success. | |
| On "CheckDLCIsInstalled" error | Trigger when the "CheckDLCIsInstalled" failed to execute. | Tag *(string)* <br> |
| On any "CheckDLCIsInstalled" error | Trigger when any of the "CheckDLCIsInstalled" failed to execute. | |
| On "CreateWorkshopItem" success | Trigger when the "CreateWorkshopItem" is executed with success. | Tag *(string)* <br> |
| On any "CreateWorkshopItem" success | Trigger when any of the "CreateWorkshopItem" are executed with success. | |
| On "CreateWorkshopItem" error | Trigger when the "CreateWorkshopItem" failed to execute. | Tag *(string)* <br> |
| On any "CreateWorkshopItem" error | Trigger when any of the "CreateWorkshopItem" failed to execute. | |
| On "UploadWorkshopItem" success | Trigger when the "UploadWorkshopItem" is executed with success. | Tag *(string)* <br> |
| On any "UploadWorkshopItem" success | Trigger when any of the "UploadWorkshopItem" are executed with success. | |
| On "UploadWorkshopItem" error | Trigger when the "UploadWorkshopItem" failed to execute. | Tag *(string)* <br> |
| On any "UploadWorkshopItem" error | Trigger when any of the "UploadWorkshopItem" failed to execute. | |
| On "GetSubscribedItemsWithMetadata" success | Trigger when the "GetSubscribedItemsWithMetadata" is executed with success. | Tag *(string)* <br> |
| On any "GetSubscribedItemsWithMetadata" success | Trigger when any of the "GetSubscribedItemsWithMetadata" are executed with success. | |
| On "GetSubscribedItemsWithMetadata" error | Trigger when the "GetSubscribedItemsWithMetadata" failed to execute. | Tag *(string)* <br> |
| On any "GetSubscribedItemsWithMetadata" error | Trigger when any of the "GetSubscribedItemsWithMetadata" failed to execute. | |
| On "DownloadWorkshopItem" success | Trigger when the "DownloadWorkshopItem" is executed with success. | Tag *(string)* <br> |
| On any "DownloadWorkshopItem" success | Trigger when any of the "DownloadWorkshopItem" are executed with success. | |
| On "DownloadWorkshopItem" error | Trigger when the "DownloadWorkshopItem" failed to execute. | Tag *(string)* <br> |
| On any "DownloadWorkshopItem" error | Trigger when any of the "DownloadWorkshopItem" failed to execute. | |
| Is engine | Return true if the engine running the app is the one selected | Engine *(combo)* <br> |
| Is initialized | Returns true if the Pipelab integration has been initialized | |
| Is full screen | Returns true if the window is in full screen mode. | State *(combo)* <br> |
Expand Down Expand Up @@ -453,6 +489,38 @@ When Download type is Around the user, the offsets are the amount of entries aro
| ActivateToWebPageResult | The result of the "ActivateToWebPage last call" | string | |
| ActivateToStoreError | The error of the "ActivateToStore last call" | string | |
| ActivateToStoreResult | The result of the "ActivateToStore last call" | string | |
| TriggerScreenshotError | The error of the "TriggerScreenshot last call" | string | |
| TriggerScreenshotResult | The result of the "TriggerScreenshot last call" | string | |
| CheckDLCIsInstalledError | The error of the "CheckDLCIsInstalled last call" | string | |
| CheckDLCIsInstalledResult | The result of the "CheckDLCIsInstalled last call" | string | |
| CreateWorkshopItemError | The error of the "CreateWorkshopItem last call" | string | |
| CreateWorkshopItemResult | The result of the "CreateWorkshopItem last call" | string | |
| UploadWorkshopItemError | The error of the "UploadWorkshopItem last call" | string | |
| UploadWorkshopItemResult | The result of the "UploadWorkshopItem last call" | string | |
| GetSubscribedItemsWithMetadataError | The error of the "GetSubscribedItemsWithMetadata last call" | string | |
| GetSubscribedItemsWithMetadataResult | The result of the "GetSubscribedItemsWithMetadata last call" | string | |
| DownloadWorkshopItemError | The error of the "DownloadWorkshopItem last call" | string | |
| DownloadWorkshopItemResult | The result of the "DownloadWorkshopItem last call" | string | |
| SubscribedItemsCount | Get the number of subscribed workshop items | number | |
| SubscribedItemIdAt | Get the workshop item ID at the given index | string | Index *(number)* <br> |
| WorkshopItemTitle | Get the title of a workshop item | string | Item ID *(string)* <br> |
| WorkshopItemDescription | Get the description of a workshop item | string | Item ID *(string)* <br> |
| WorkshopItemOwnerSteamId64 | Get the owner's Steam ID64 of a workshop item | string | Item ID *(string)* <br> |
| WorkshopItemOwnerAccountId | Get the owner's account ID of a workshop item | number | Item ID *(string)* <br> |
| WorkshopItemTags | Get the tags of a workshop item (comma-separated) | string | Item ID *(string)* <br> |
| WorkshopItemUpvotes | Get the number of upvotes for a workshop item | number | Item ID *(string)* <br> |
| WorkshopItemDownvotes | Get the number of downvotes for a workshop item | number | Item ID *(string)* <br> |
| WorkshopItemPreviewUrl | Get the preview image URL of a workshop item | string | Item ID *(string)* <br> |
| WorkshopItemUrl | Get the Steam Workshop URL of a workshop item | string | Item ID *(string)* <br> |
| WorkshopItemTimeCreated | Get the creation timestamp of a workshop item (Unix epoch) | number | Item ID *(string)* <br> |
| WorkshopItemTimeUpdated | Get the last update timestamp of a workshop item (Unix epoch) | number | Item ID *(string)* <br> |
| WorkshopItemState | Get the state bitfield of a workshop item | number | Item ID *(string)* <br> |
| WorkshopItemIsInstalled | Check if a workshop item is installed (returns 0 or 1) | number | Item ID *(string)* <br> |
| WorkshopItemIsDownloading | Check if a workshop item is downloading (returns 0 or 1) | number | Item ID *(string)* <br> |
| WorkshopItemNeedsUpdate | Check if a workshop item needs an update (returns 0 or 1) | number | Item ID *(string)* <br> |
| WorkshopItemInstallFolder | Get the installation folder path of a workshop item | string | Item ID *(string)* <br> |
| WorkshopItemSizeOnDisk | Get the size on disk of a workshop item in bytes | number | Item ID *(string)* <br> |
| WorkshopItemTimestamp | Get the install timestamp of a workshop item | number | Item ID *(string)* <br> |
| ArgumentAt | Get the argument at the given index. | string | Index *(number)* <br> |
| ArgumentCount | Get the number of arguments. | number | |
| AppFolderURL | Return the URL of the folder of the current app. | string | |
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"name": "@pipelab/construct-plugin",
"description": "Pipelab construct plugin",
"version": "2.4.0",
"version": "2.4.1",
"packageManager": "pnpm@9.10.0",
"type": "module",
"scripts": {
Expand Down
Loading