CS2 Workshop Manager
(v1.0.1)
(v1.4.0)
CS2 Workshop Manager is a standalone tool by Angel for Counter-Strike 2, offering a more powerful alternative to the default manager.
Packs a compiled addon the same way Valve's tool does and publishes it to the Steam Workshop, then lets you manage everything you have published.
Projects:
- GUI - Cross-platform desktop app.
- CLI - Command-line tool for scripts and build pipelines.
- CS2WorkshopManager - Library that the GUI and CLI projects are built on, published as a Nuget package.
Download
The download is available on github.com
Features
Valve's Worskhop manager has quite a lot of drawbacks and shortcomings, this tool aims to fix and or improve on all of them.
- Fixed loading descriptions, it will now show the entire description instead of just the first 255 bytes.
- Added "Unlisted" visiblity option.
- Added a new description editor, with Steam BBCode preview.
- Added a new gallery editor, screenshots and YouTube videos under the thumbnail can be added and removed without leaving the app.
- Added support for more thumbnail file types as well as resolutions.
- Added support for GIF thumbnails.
- Contributors can now re-upload the submissions.
- Added support for custom used defined tags.
- Added new tool "Pack Filter" allowing you to define custom file packing rules.
- Added "Exclude unused content", which reads a compiled map and keeps whatever it never references out of the upload.
- Improved user interface, thumbnails are now shown, more stats like subscribers, views, likes and favourites per item, a grid view as well as a search bar.
- Linux support.
Requirements
- Counter-Strike 2 installed through Steam, with the addon compiled under
game/csgo_addons/<addon>. - Steam running and logged into the account that owns the workshop items.
- Windows or Linux. Releases are self-contained and need no .NET install.
The command line tool
Exposes the full functionality that the base library and GUI expose, useful for automating map updates which was the initial motivator for this project.
Commands
| Command | What it does |
|---|---|
upload
|
Packs an addon and publishes it as a new item, or updates an existing item when --id is given.
|
edit
|
Changes a published item's title, description, thumbnail, visibility or game modes, and adds or removes gallery screenshots and videos. |
list
|
Lists your published items with their counts. |
view
|
Opens an item's workshop page in the browser. |
previews
|
Lists the gallery under an item's thumbnail, with the indices that edit --remove_previews takes.
|
delete
|
Deletes an item, after asking, or straight away with --yes.
|
addons
|
Lists the addon folders, marking the one open in the tools. |
contents
|
Shows what an addon would upload by asset type. |
files
|
Lists the files an addon would upload, or every file with --all.
|
rules
|
Lists, adds and removes an addon's packing rules. |
rules unused
|
Lists the files no compiled map of an addon references, or keeps them out of the upload with --apply.
|
Example
CS2WorkshopManager-CLI upload --addon prophunt --title "Prophunt Mirage" --visibility unlisted
CS2WorkshopManager-CLI upload --addon prophunt --title "Prophunt Mirage" --id 3611562098 --changenote "Added more props"
CS2WorkshopManager-CLI edit --id 3611562098 --description_file description.txt
CS2WorkshopManager-CLI listThe library
The CS2WorkshopManager package wraps all of this for your own tools. It talks to the running Steam client directly, so it needs no Steamworks SDK or steam_api library alongside it.
This library is also published as a C# Nuget package.
var manager = WorkshopManager.FromSteamInstall();
var result = await manager.PublishAsync(new AddonPublishOptions
{
AddonName = "prophunt",
Title = "Prophunt Mirage",
Visibility = WorkshopVisibility.Unlisted,
Tags = ["CS2", "Map", "Custom"],
});
Console.WriteLine(result.Url);
await foreach (var item in WorkshopManager.GetPublishedItemsAsync())
{
Console.WriteLine($"{item.Title}: {item.Subscribers} subscribers");
}
Packing rules
The upload takes the files that gameinfo.gi lists under VpkDirectories, minus the files the workshop manager always leaves out, exactly as Valve's tool does. On top of that you can keep files out or bring files in with rules of your own, saved as publish_rules.txt in the addon's content root folder, content/csgo_addons/<addon>:
"publish_rules"
{
"exclude" "materials/dev/"
"include" "maps/backup.txt"
}A rule matches everything whose path starts with its text, a folder ending in a slash. The first matching rule wins, and your rules are checked before gameinfo's. The Pack Filter window and the rules CLI command both write this file, and you can edit it by hand.
Ticking "Exclude unused content" in the Pack Filter window, or running rules unused --apply, saves the compiled map you pick as "exclude_unused" "maps/<map>.vpk" in the same file. Every file that map never reaches is then kept out of the upload. The list is worked out from the map each time the addon is packed rather than stored, so it follows the map as you rebuild it. It is checked after your own rules, so they win over it, and ticking a file in the tree brings it back. rules unused --clear takes the unused content back in. A script's paths are only found where they are written out in full, so look the list over before publishing.
Rules that should apply to every addon go in the app's settings file instead, settings.txt under %AppData%\CS2WorkshopManager on Windows or ~/.config/CS2WorkshopManager on Linux, in a publish_rules block of the same shape. They are checked before the addon's own rules, so they win over them. The Settings window and rules --global write this file.
Credits
The file type icons in the Pack Filter window are from Source 2 Viewer, see github.com
This project is not affiliated with Valve. Counter-Strike and Steam are trademarks of Valve Corporation.
License
MIT, see github.com
| ||||||||||||||||||||||||||||||||||||||||||||||||||
