Workshop Uploader - Guide

This guide covers how to use WorkshopUploader.exe to publish your King's Bounty: The Legend mods to the Steam Workshop. It does not cover how to make the mod itself - that is up to you. The tool only handles packaging, uploading, and updating mods on Workshop.

What this tool does

WorkshopUploader is a small command-line program that talks to Steam on your behalf. It takes a folder with your mod, validates that the metadata is correct, and uploads everything to Steam Workshop as a new or updated mod.

It does not look at, modify, or understand the contents of your mod. You are responsible for the files inside the folder. The tool only requires one file - mod.cfg, to be present with the metadata Workshop needs.

What you need

  • Your mod folder somewhere on disk (anywhere works, doesn't have to be inside the game folder).
  • The Steam client running and logged in with the account you want to publish from.
  • WorkshopUploader.exe, steam_api.dll, and steam_appid.txt, all in the same folder.

Quick start

Copy the Template mod folder somewhere, rename it for your mod, edit mod.cfg, replace preview.png with your own image, add your mod files, and run:


WorkshopUploader.exe upload "C:\path\to\your\mod"

That's it. The mod is now on Workshop. The tool saves a file called .workshop_id in your mod folder so it knows which Workshop item to update later.

Mod folder layout

The folder must contain at minimum:


your_mod/
├─ mod.cfg          (required, describes your mod)
├─ preview.png      (required, shown on Workshop page)
└─ <your mod files in whatever structure the game expects>

After your first upload, the tool also creates:


├─ .workshop_id     (do not delete or edit - tool uses this to identify the mod)

If you delete .workshop_id, the tool can no longer find the Workshop item for this folder. Running upload again will create a brand new Workshop item instead of updating the existing one.

The mod.cfg file

This is where you describe your mod. Format is one directive per line:


setf ~key value

Lines that don't start with setf are ignored - use them for comments.

Required field in mod.cfg

  • ~title - name shown on Workshop, up to 128 characters.

This is the only directive inside mod.cfg that you must fill in. But a valid mod also needs a preview image file in the folder - see "Other requirements" below.

Optional fields

  • ~description - long description. Use {...} braces for multi-line text. Supports Steam BBCode ([b], [i], [list], [url], etc.).
  • ~tags - list of categories. Wrap each tag in quotes, separate by spaces: {"UI" "Texture Pack"}. See the tag list below.
  • ~preview_image - name of the preview image file. Defaults to preview.png.
  • ~version - your version string (free-form text, like 1.0 or 2025-06-14).
  • ~visibility - public, friends, or private. Defaults to public.

Tags

Pick zero or more from this list. Tags are case-sensitive - write them exactly as shown:

TagUse for
QuestNew quests or quest lines
New CampaignA full new campaign
New UnitsNew units or races
Texture PackReplaced or new textures
UIInterface modifications
BalanceTweaks to stats, costs, difficulty
LocalizationTranslations or text changes
AudioMusic or sound changes

You can leave tags empty if nothing fits, but if you do specify any, all of them must be from this list.

Other requirements

In addition to a valid mod.cfg, your mod folder must contain:

  • A preview image file (default name preview.png, override with ~preview_image). Required by Steam Workshop. Must be ≤ 1 MB.
  • At least one content file - anything other than mod.cfg and the preview. An empty mod isn't useful and won't pass validation.
  • No executable files anywhere in the folder or subfolders. The uploader refuses files with extensions like .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi.

Run check before upload and the tool will tell you exactly what's missing or wrong.

Example mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Preview image notes

Steam shows the preview on your mod's Workshop page and in search results. Recommended format:

  • PNG or JPG
  • 512×512 pixels (square works best in the Workshop grid)
  • Under 1 MB

If you don't have an image ready, the included Template Mod/preview.png is a placeholder - replace it with your own before publishing.

Testing your mod locally before publishing

You can test your mod with the game without uploading anything first.

To make the game see your mod:

1. Open workshop.cfg in your game's installation folder (next to KB.exe). 2. Add a line like:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

The first word (my_mod here) is the folder name that will appear under data\mods\. The path is where your mod really lives. Names with spaces use braces: {My Mod}. 3. Launch the game trough Steam. 4. The mod is now active. Iterate on your files, restart the game to test changes.

Remove the line from workshop.cfg when you're done testing, or after publishing to Workshop. Having both a local entry and a Workshop subscription for the same mod creates duplicate content under data\mods\ and may confuse the game.

Commands

The tool runs from the command line. Open cmd (or just double-click WorkshopUploader.exe for an interactive shell that walks you through it). All commands take the mod folder path as their main argument. Paths with spaces must be wrapped in quotes.

check <folder>

Validates your mod.cfg, preview, and folder contents. Reports any issues without uploading anything. Always run this before upload or update.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Sample output:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

If anything is wrong, you'll see [ERROR] lines explaining what to fix.

upload <folder>

Publishes a new mod to Workshop. Creates a new Workshop item, uploads the contents, and saves .workshop_id in the folder. Refuses to run if .workshop_id already exists - use update for that.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Uploads a new version of a mod that's already on Workshop. The Workshop item ID is read from .workshop_id in the mod folder. You can optionally describe the changes:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

Subscribers will see the note in their Workshop feed when the update goes live.

status <folder>

Shows what Steam knows about your mod - title, description, last updated time, visibility. Uses .workshop_id from the folder.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

Same as status but takes a numeric Workshop ID directly, so it works on any mod (yours or someone else's).


WorkshopUploader.exe info 3745315310

list

Shows all mods you've published.


WorkshopUploader.exe list

Sample output:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Interactive mode

If you double-click WorkshopUploader.exe (or run it without arguments), it opens an interactive shell:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

This is identical to running each command from a regular cmd prompt. Use whichever you prefer.

Workflow summary

For a new mod:

1. Copy Template Mod somewhere and rename the folder. 2. Edit mod.cfg - at minimum set ~title. 3. Replace preview.png with your mod's image. 4. Add your mod files in whatever layout the game expects. 5. Test locally via workshop.cfg (see above). 6. WorkshopUploader.exe check "<your folder>" - verify everything's OK. 7. WorkshopUploader.exe upload "<your folder>" - publish. 8. Visit your mod's Workshop page (the URL is printed after upload).

For updating an existing mod:

1. Make your changes in the same folder (don't delete .workshop_id). 2. Bump ~version in mod.cfg if you want a version label. 3. check, then update "<folder>" --note "What changed". 4. Subscribers see the new version in the background, automatically.

Workshop visibility

  • Private - only you see the mod. Use this for testing your first upload. The mod is real, has a real Workshop URL, and you can subscribe to it from your Steam, but nobody else can find it.
  • Friends - your Steam friends can see and subscribe. Useful for limited beta testing.
  • Public - anyone on Workshop can find and subscribe. This is what you want for final release.

You can change visibility by editing mod.cfg and running update.

Deleting a mod

The tool doesn't currently have a delete command. To remove a published mod:

1. Open the Workshop page (URL is in the output of upload or visible via status). 2. Click the gear icon → Delete.

The local .workshop_id file becomes orphaned (no longer points to anything real) - delete it manually if you want to re-publish the folder as a new mod.

Common errors

  • "mod.cfg not found" - you ran the command on the wrong folder, or mod.cfg is missing.
  • "~title is empty" - the title in mod.cfg is missing or blank.
  • "preview file not found" -file named by ~preview_image (default preview.png) doesn't exist in the mod folder.
  • "preview file too large" - your preview is over 1 MB. Resize or recompress it.
  • "no content files - mod folder is empty" - your folder only contains mod.cfg and the preview. Workshop expects actual mod content too.
  • "found executable: ..." - Workshop is for content only. Remove .exe/.dll/.bat/etc. from your mod folder.
  • "~tags is not in the approved list" - you used a tag that doesn't match the list above. Tags are case-sensitive.
  • "current Steam account does not own this Workshop item" - .workshop_id points to a mod published by a different Steam account. Either log in with the correct account or delete .workshop_id to start fresh.
  • Steam result code 8 (InvalidParam) - usually means Workshop isn't enabled for the game on Steamworks side.
  • "SteamAPI_Init failed" - Steam isn't running, or steam_appid.txt is missing/incorrect.

Logs

The tool writes WorkshopUploader_log.txt next to itself. Include this file when reporting issues - it shows exactly what the tool tried to do and what Steam responded.

Workshop Uploader - Руководство

Это руководство описывает, как использовать WorkshopUploader.exe для публикации модов King's Bounty: The Legend в Steam Workshop. Оно не описывает, как создавать сам мод - это ваше решение. Инструмент только упаковывает, загружает и обновляет моды в Workshop.

Что делает этот инструмент

Workshop Uploader - это небольшая консольная программа, которая помогает вам взаимодействовать со Steam. Она берёт папку с вашим модом, проверяет корректность метаданных и загружает всё в Steam Workshop как новый или обновлённый мод.

Инструмент не просматривает, не модифицирует и не разбирает содержимое вашего мода. За файлы внутри папки отвечаете вы. Инструменту требуется только один файл - mod.cfg с метаданными для Workshop.

Что нужно

  • Папка с вашим модом где-то на диске (где угодно, не обязательно внутри папки игры).
  • Запущенный клиент Steam с аккаунтом, от имени которого вы хотите публиковать.
  • WorkshopUploader.exe, steam_api.dll и steam_appid.txt - все в одной папке.

Быстрый старт

Скопируйте папку Template mod куда-нибудь, переименуйте под свой мод, отредактируйте mod.cfg, замените preview.png своей картинкой, добавьте файлы мода и выполните:


WorkshopUploader.exe upload "C:\path\to\your\mod"

Готово. Мод теперь в Workshop. Инструмент сохраняет файл .workshop_id в вашей папке мода, чтобы знать, какой Workshop-предмет обновлять в дальнейшем.

Структура папки мода

Папка должна содержать как минимум:


your_mod/
├─ mod.cfg          (обязательно, описывает мод)
├─ preview.png      (обязательно, показывается на странице Workshop)
└─ <файлы вашего мода в нужной игре структуре>

После первой загрузки инструмент также создаёт:


├─ .workshop_id     (не удаляйте и не редактируйте - используется инструментом)

Если удалить .workshop_id, инструмент больше не сможет найти Workshop-предмет для этой папки. Запуск upload снова создаст новый Workshop-предмет вместо обновления существующего.

Файл mod.cfg

Здесь вы описываете свой мод. Формат - одна директива на строку:


setf ~key value

Строки, не начинающиеся с setf, игнорируются - используйте их для комментариев.

Обязательное поле в mod.cfg

  • ~title - название, отображаемое в Workshop, до 128 символов.

Это единственная директива внутри mod.cfg, которую обязательно нужно заполнить. Но для валидного мода также нужно изображение предпросмотра в папке - см. раздел "Другие требования" ниже.

Необязательные поля

  • ~description - подробное описание. Используйте фигурные скобки {...} для многострочного текста. Поддерживает Steam BBCode ([b], [i], [list], [url] и т.п.).
  • ~tags - список категорий. Каждый тег в кавычках, разделены пробелами: {"UI" "Texture Pack"}. Список тегов ниже.
  • ~preview_image - имя файла изображения предпросмотра. По умолчанию preview.png.
  • ~version - строка с вашей версией (произвольный текст, например 1.0 или 2025-06-14).
  • ~visibility - public, friends или private. По умолчанию public.

Теги

Выберите произвольное количество из этого списка, либо ни одного. Теги чувствительны к регистру - пишите их точно так, как показано:

ТегДля чего
QuestНовые квесты или сюжетные линии
New CampaignПолностью новая кампания
New UnitsНовые юниты или расы
Texture PackЗаменённые или новые текстуры
UIИзменения интерфейса
BalanceПравки статов, стоимости, сложности
LocalizationПереводы или изменения текста
AudioМузыка или звуки

Теги можно не указывать вообще, но если указываете - все они должны быть из этого списка.

Другие требования

В дополнение к валидному mod.cfg папка мода должна содержать:

  • Превью-изображение (по умолчанию preview.png, переопределяется через ~preview_image). Требуется Steam Workshop. Размер ≤ 1 МБ.
  • Хотя бы один файл контента - что-то кроме mod.cfg и превью-изображение. Пустой мод бесполезен и не пройдёт проверку.
  • Никаких исполняемых файлов ни в папке, ни в подпапках. Загрузчик откажется работать с файлами с расширениями .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi.

Запустите check перед upload, и инструмент точно скажет, что не так или чего не хватает.

Пример mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Замечания о превью-изображении

Steam показывает превью на странице вашего мода в Workshop и в результатах поиска. Рекомендуемый формат:

  • PNG или JPG
  • 512×512 пикселей (квадрат лучше всего смотрится в сетке Workshop)
  • Размер до 1 МБ

Если изображения пока нет, в комплекте есть Template Mod/preview.png как заглушка. Замените её на своё перед публикацией.

Локальное тестирование мода перед публикацией

Вы можете протестировать мод в игре без предварительной загрузки.

Чтобы игра увидела ваш мод:

1. Откройте workshop.cfg в папке установки игры (рядом с KB.exe). 2. Добавьте строку вида:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

Первое слово (my_mod здесь) - имя папки, которое появится в data\mods\. Путь указывает, где мод реально находится. Имена с пробелами оборачивайте в скобки: {My Mod}. 3. Запустите игру через Steam. 4. Мод теперь активен. Правьте файлы, перезапускайте игру для проверки изменений.

Удалите строку из workshop.cfg, когда закончите тестирование, или после публикации в Workshop. Одновременная локальная запись и подписка Workshop на один и тот же мод создают дублирующее содержимое в data\mods\ и могут запутать игру.

Команды

Инструмент запускается из командной строки. Откройте cmd (или просто запустите WorkshopUploader.exe двойным кликом - откроется интерактивная оболочка). Все команды принимают путь к папке мода как основной аргумент. Пути с пробелами оборачивайте в кавычки.

check <folder>

Проверяет mod.cfg, превью и содержимое папки. Сообщает о проблемах без загрузки. Всегда запускайте перед upload или update.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Пример вывода:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

Если что-то не так, увидите строки [ERROR] с объяснением, что нужно исправить.

upload <folder>

Публикует новый мод в Workshop. Создаёт новый Workshop-предмет, загружает содержимое и сохраняет .workshop_id в папке. Отказывается работать, если .workshop_id уже существует - для этого используется update.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Загружает новую версию уже опубликованного мода. ID Workshop-предмета читается из .workshop_id в папке мода. Опционально можно описать изменения:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

Подписчики увидят комментарий в своей ленте Workshop, когда обновление станет доступно.

status <folder>

Показывает, что Steam знает о вашем моде - название, описание, время последнего обновления, видимость. Использует .workshop_id из папки.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

То же, что status, но принимает числовой Workshop ID напрямую, поэтому работает с любым модом (вашим или чужим).


WorkshopUploader.exe info 3745315310

list

Показывает все опубликованные вами моды.


WorkshopUploader.exe list

Пример вывода:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Интерактивный режим

Если запустить WorkshopUploader.exe двойным кликом (или без аргументов), откроется интерактивная оболочка:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

Это идентично запуску каждой команды из обычного cmd. Используйте то, что удобнее.

Сводка рабочего процесса

Для нового мода:

1. Скопируйте Template Mod куда-нибудь и переименуйте папку. 2. Отредактируйте mod.cfg - как минимум укажите ~title. 3. Замените preview.png своим изображением. 4. Добавьте файлы мода в нужной игре структуре. 5. Протестируйте локально через workshop.cfg (см. выше). 6. WorkshopUploader.exe check "<ваша папка>" - проверьте, всё ли в порядке. 7. WorkshopUploader.exe upload "<ваша папка>" - опубликуйте. 8. Откройте страницу мода в Workshop (URL выводится после загрузки).

Для обновления существующего мода:

1. Внесите изменения в той же папке (не удаляйте .workshop_id). 2. Обновите ~version в mod.cfg, если нужно изменить метку версии. 3. check, затем update "<folder>" --note "Что изменилось". 4. Подписчики увидят новую версию автоматически, в фоновом режиме.

Видимость в Workshop

  • Private - мод видите только вы. Используйте для тестирования первой загрузки. Мод реальный, у него есть Workshop URL, вы можете подписаться на него из Steam, но больше никто не сможет его найти.
  • Friends - ваши друзья в Steam видят и могут подписаться. Полезно для ограниченного бета-тестирования.
  • Public - любой пользователь Workshop может найти и подписаться. Это то, что нужно для финального релиза.

Видимость можно изменить, отредактировав mod.cfg и запустив update.

Удаление мода

У инструмента сейчас нет команды для удаления. Чтобы удалить опубликованный мод:

1. Откройте страницу в Workshop (URL в выводе upload или в status). 2. Нажмите значок шестерёнки → Delete.

Локальный файл .workshop_id становится "осиротевшим" (больше не указывает ни на что реальное) - удалите его вручную, если хотите перепубликовать папку как новый мод.

Типичные ошибки

  • "mod.cfg not found" - команда запущена не на той папке, или mod.cfg отсутствует.
  • "~title is empty" - название в mod.cfg отсутствует или пустое.
  • "preview file not found" - файла из ~preview_image (по умолчанию preview.png) нет в папке мода.
  • "preview file too large" - превью больше 1 МБ. Уменьшите или пересожмите.
  • "no content files - mod folder is empty" - в папке только mod.cfg и превью. Workshop ожидает реальное содержимое мода.
  • "found executable: ..." - Workshop только для контента. Уберите .exe/.dll/.bat и т.п. из папки мода.
  • "~tags is not in the approved list" - использован тег, которого нет в списке выше. Теги чувствительны к регистру.
  • "current Steam account does not own this Workshop item" - .workshop_id указывает на мод, опубликованный с другого Steam-аккаунта. Войдите под нужным аккаунтом или удалите .workshop_id, чтобы начать заново.
  • Steam result code 8 (InvalidParam) - обычно означает, что Workshop не включён для игры в Steamworks.
  • "SteamAPI_Init failed" - Steam не запущен, или steam_appid.txt отсутствует/некорректен.

Логи

Инструмент пишет WorkshopUploader_log.txt рядом с собой. Прикладывайте этот файл при сообщениях об ошибках - в нём видно, что именно инструмент пытался сделать и что ответил Steam.

Workshop Uploader - Guide

Ce guide explique comment utiliser WorkshopUploader.exe pour publier vos mods de King's Bounty: The Legend sur le Steam Workshop. Il ne couvre pas la création du mod lui-même - cela vous appartient. L'outil ne gère que l'empaquetage, le téléversement et la mise à jour des mods sur Workshop.

Ce que fait cet outil

WorkshopUploader est un petit programme en ligne de commande qui communique avec Steam pour vous. Il prend un dossier contenant votre mod, vérifie que les métadonnées sont correctes, et téléverse le tout sur Steam Workshop comme un mod nouveau ou mis à jour.

Il ne lit pas, ne modifie pas et ne comprend pas le contenu de votre mod. Vous êtes responsable des fichiers dans le dossier. L'outil ne requiert qu'un seul fichier - mod.cfg - avec les métadonnées dont Workshop a besoin.

Ce dont vous avez besoin

  • Votre dossier de mod quelque part sur le disque (n'importe où, pas forcément dans le dossier du jeu).
  • Le client Steam en marche, connecté avec le compte depuis lequel vous voulez publier.
  • WorkshopUploader.exe, steam_api.dll et steam_appid.txt, tous dans le même dossier.

Démarrage rapide

Copiez le dossier Template mod quelque part, renommez-le pour votre mod, modifiez mod.cfg, remplacez preview.png par votre propre image, ajoutez les fichiers de votre mod, puis exécutez:


WorkshopUploader.exe upload "C:\path\to\your\mod"

C'est tout. Le mod est maintenant sur Workshop. L'outil enregistre un fichier nommé .workshop_id dans votre dossier de mod pour savoir quel élément Workshop mettre à jour plus tard.

Structure du dossier de mod

Le dossier doit contenir au minimum:


your_mod/
├─ mod.cfg          (requis, décrit votre mod)
├─ preview.png      (requis, affiché sur la page Workshop)
└─ <vos fichiers de mod dans la structure attendue par le jeu>

Après votre premier téléversement, l'outil crée également:


├─ .workshop_id     (ne pas supprimer ni modifier - utilisé par l'outil)

Si vous supprimez .workshop_id, l'outil ne pourra plus retrouver l'élément Workshop pour ce dossier. Relancer upload créera un tout nouvel élément Workshop au lieu de mettre à jour l'existant.

Le fichier mod.cfg

C'est ici que vous décrivez votre mod. Format: une directive par ligne:


setf ~key value

Les lignes qui ne commencent pas par setf sont ignorées - utilisez-les pour des commentaires.

Champ requis dans mod.cfg

  • ~title - nom affiché sur Workshop, jusqu'à 128 caractères.

C'est la seule directive à l'intérieur de mod.cfg que vous devez remplir. Mais un mod valide nécessite aussi une image de prévisualisation dans le dossier - voir "Autres exigences" ci-dessous.

Champs optionnels

  • ~description - description longue. Utilisez les accolades {...} pour du texte multilignes. Supporte le BBCode Steam ([b], [i], [list], [url], etc.).
  • ~tags - liste de catégories. Chaque tag entre guillemets, séparés par des espaces: {"UI" "Texture Pack"}. Voir la liste ci-dessous.
  • ~preview_image - nom du fichier d'image de prévisualisation. Par défaut preview.png.
  • ~version - votre chaîne de version (texte libre, comme 1.0 ou 2025-06-14).
  • ~visibility - public, friends ou private. Par défaut public.

Tags

Choisissez zéro ou plusieurs dans cette liste. Les tags sont sensibles à la casse - écrivez-les exactement comme indiqué:

TagÀ utiliser pour
QuestNouvelles quêtes ou lignes de quêtes
New CampaignUne campagne entièrement nouvelle
New UnitsNouvelles unités ou races
Texture PackTextures remplacées ou nouvelles
UIModifications de l'interface
BalanceAjustements de stats, coûts, difficulté
LocalizationTraductions ou changements de texte
AudioMusique ou sons

Vous pouvez laisser les tags vides si rien ne convient, mais si vous en spécifiez, tous doivent appartenir à cette liste.

Autres exigences

En plus d'un mod.cfg valide, votre dossier de mod doit contenir:

  • Une image de prévisualisation (nom par défaut preview.png, modifiable via ~preview_image). Requise par Steam Workshop. Taille ≤ 1 Mo.
  • Au moins un fichier de contenu - autre chose que mod.cfg et la prévisualisation. Un mod vide n'a pas d'intérêt et ne passera pas la validation.
  • Aucun fichier exécutable dans le dossier ni sous-dossiers. L'outil refuse les fichiers avec extensions .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi.

Lancez check avant upload et l'outil vous dira exactement ce qui manque ou ne va pas.

Exemple de mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Notes sur l'image de prévisualisation

Steam affiche la prévisualisation sur la page Workshop du mod et dans les résultats de recherche. Format recommandé:

  • PNG ou JPG
  • 512×512 pixels (le carré fonctionne le mieux dans la grille Workshop)
  • Moins de 1 Mo

Si vous n'avez pas encore d'image, le Template Mod/preview.png inclus est un placeholder - remplacez-le par le vôtre avant publication.

Tester votre mod localement avant publication

Vous pouvez tester votre mod dans le jeu sans rien téléverser au préalable.

Pour que le jeu voie votre mod:

1. Ouvrez workshop.cfg dans le dossier d'installation du jeu (à côté de KB.exe). 2. Ajoutez une ligne comme:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

Le premier mot (my_mod ici) est le nom du dossier qui apparaîtra sous data\mods\. Le chemin indique où le mod se trouve réellement. Les noms avec espaces utilisent des accolades: {My Mod}. 3. Lancez le jeu via Steam. 4. Le mod est maintenant actif. Itérez sur vos fichiers, redémarrez le jeu pour tester les modifications.

Retirez la ligne de workshop.cfg une fois les tests terminés, ou après publication sur Workshop. Avoir à la fois une entrée locale et un abonnement Workshop pour le même mod crée du contenu dupliqué sous data\mods\ et peut perturber le jeu.

Commandes

L'outil s'exécute depuis la ligne de commande. Ouvrez cmd (ou double-cliquez simplement sur WorkshopUploader.exe pour un shell interactif). Toutes les commandes prennent le chemin du dossier de mod comme argument principal. Les chemins avec espaces doivent être entre guillemets.

check <folder>

Valide votre mod.cfg, la prévisualisation et le contenu du dossier. Signale les problèmes sans rien téléverser. Toujours exécuter avant upload ou update.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Exemple de sortie:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

En cas de problème, vous verrez des lignes [ERROR] expliquant quoi corriger.

upload <folder>

Publie un nouveau mod sur Workshop. Crée un nouvel élément Workshop, téléverse le contenu et enregistre .workshop_id dans le dossier. Refuse de s'exécuter si .workshop_id existe déjà - utilisez update pour cela.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Téléverse une nouvelle version d'un mod déjà sur Workshop. L'ID de l'élément Workshop est lu depuis .workshop_id dans le dossier de mod. Vous pouvez optionnellement décrire les changements:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

Les abonnés verront la note dans leur fil Workshop quand la mise à jour sera publiée.

status <folder>

Montre ce que Steam sait sur votre mod - titre, description, dernière date de mise à jour, visibilité. Utilise .workshop_id depuis le dossier.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

Identique à status mais prend un ID Workshop numérique directement, donc fonctionne avec n'importe quel mod (le vôtre ou celui d'un autre).


WorkshopUploader.exe info 3745315310

list

Affiche tous les mods que vous avez publiés.


WorkshopUploader.exe list

Exemple de sortie:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Mode interactif

Si vous double-cliquez sur WorkshopUploader.exe (ou le lancez sans arguments), un shell interactif s'ouvre:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

C'est identique à lancer chaque commande depuis un cmd normal. Utilisez ce que vous préférez.

Résumé du flux de travail

Pour un nouveau mod:

1. Copiez Template Mod quelque part et renommez le dossier. 2. Modifiez mod.cfg - au minimum définissez ~title. 3. Remplacez preview.png par votre image. 4. Ajoutez vos fichiers de mod dans la structure attendue par le jeu. 5. Testez localement via workshop.cfg (voir ci-dessus). 6. WorkshopUploader.exe check "<votre dossier>" - vérifiez que tout va bien. 7. WorkshopUploader.exe upload "<votre dossier>" - publiez. 8. Visitez la page Workshop de votre mod (l'URL est affichée après le téléversement).

Pour mettre à jour un mod existant:

1. Faites vos changements dans le même dossier (ne supprimez pas .workshop_id). 2. Modifiez ~version dans mod.cfg si vous voulez une étiquette de version. 3. check, puis update "<folder>" --note "Ce qui a changé". 4. Les abonnés voient la nouvelle version en arrière-plan, automatiquement.

Visibilité Workshop

  • Private - vous seul voyez le mod. Utilisez ceci pour tester votre premier téléversement. Le mod est réel, a une URL Workshop réelle, vous pouvez vous y abonner depuis votre Steam, mais personne d'autre ne peut le trouver.
  • Friends - vos amis Steam peuvent voir et s'abonner. Utile pour une bêta limitée.
  • Public - n'importe qui sur Workshop peut trouver et s'abonner. C'est ce qu'il faut pour la sortie finale.

Vous pouvez changer la visibilité en modifiant mod.cfg et en lançant update.

Suppression d'un mod

L'outil n'a pas actuellement de commande de suppression. Pour retirer un mod publié:

1. Ouvrez la page Workshop (l'URL est dans la sortie de upload ou visible via status). 2. Cliquez sur l'icône d'engrenage → Delete.

Le fichier local .workshop_id devient orphelin (ne pointe plus vers rien de réel) - supprimez-le manuellement si vous voulez republier le dossier comme un nouveau mod.

Erreurs courantes

  • "mod.cfg not found" - vous avez lancé la commande sur le mauvais dossier, ou mod.cfg est absent.
  • "~title is empty" - le titre dans mod.cfg est manquant ou vide.
  • "preview file not found" - le fichier nommé par ~preview_image (par défaut preview.png) n'existe pas dans le dossier de mod.
  • "preview file too large" - votre prévisualisation dépasse 1 Mo. Redimensionnez ou recompressez.
  • "no content files - mod folder is empty" - votre dossier ne contient que mod.cfg et la prévisualisation. Workshop attend du vrai contenu de mod aussi.
  • "found executable: ..." - Workshop est pour le contenu uniquement. Retirez les .exe/.dll/.bat/etc. de votre dossier de mod.
  • "~tags is not in the approved list" - vous avez utilisé un tag qui ne correspond pas à la liste ci-dessus. Les tags sont sensibles à la casse.
  • "current Steam account does not own this Workshop item" - .workshop_id pointe vers un mod publié par un autre compte Steam. Connectez-vous avec le bon compte ou supprimez .workshop_id pour repartir de zéro.
  • Steam result code 8 (InvalidParam) - signifie généralement que Workshop n'est pas activé pour le jeu côté Steamworks.
  • "SteamAPI_Init failed" - Steam n'est pas lancé, ou steam_appid.txt est manquant/incorrect.

Journaux

L'outil écrit WorkshopUploader_log.txt à côté de lui. Joignez ce fichier aux rapports de problèmes - il montre exactement ce que l'outil a tenté de faire et ce que Steam a répondu.

Workshop Uploader - Anleitung

Diese Anleitung beschreibt, wie Sie WorkshopUploader.exe verwenden, um Ihre Mods für King's Bounty: The Legend im Steam Workshop zu veröffentlichen. Sie erklärt nicht, wie Sie den Mod selbst erstellen - das liegt bei Ihnen. Das Werkzeug übernimmt nur das Verpacken, Hochladen und Aktualisieren von Mods im Workshop.

Was dieses Werkzeug tut

WorkshopUploader ist ein kleines Kommandozeilen-Programm, das in Ihrem Namen mit Steam kommuniziert. Es nimmt einen Ordner mit Ihrem Mod, prüft die Metadaten und lädt alles als neuen oder aktualisierten Mod in den Steam Workshop hoch.

Es liest, ändert oder versteht den Inhalt Ihres Mods nicht. Für die Dateien im Ordner sind Sie verantwortlich. Das Werkzeug benötigt nur eine Datei - mod.cfg - mit den Metadaten, die der Workshop braucht.

Was Sie brauchen

  • Ihren Mod-Ordner irgendwo auf der Festplatte (überall, nicht zwingend im Spielordner).
  • Den Steam-Client läuft und ist mit dem Konto angemeldet, von dem aus Sie veröffentlichen möchten.
  • WorkshopUploader.exe, steam_api.dll und steam_appid.txt, alle im selben Ordner.

Schnellstart

Kopieren Sie den Ordner Template mod irgendwohin, benennen Sie ihn für Ihren Mod um, bearbeiten Sie mod.cfg, ersetzen Sie preview.png durch ein eigenes Bild, fügen Sie Ihre Mod-Dateien hinzu und führen Sie aus:


WorkshopUploader.exe upload "C:\path\to\your\mod"

Das war's. Der Mod ist jetzt im Workshop. Das Werkzeug speichert eine Datei namens .workshop_id in Ihrem Mod-Ordner, damit es später weiß, welchen Workshop-Eintrag es aktualisieren soll.

Aufbau des Mod-Ordners

Der Ordner muss mindestens enthalten:


your_mod/
├─ mod.cfg          (erforderlich, beschreibt Ihren Mod)
├─ preview.png      (erforderlich, wird auf der Workshop-Seite angezeigt)
└─ <Ihre Mod-Dateien in der vom Spiel erwarteten Struktur>

Nach dem ersten Hochladen erstellt das Werkzeug zusätzlich:


├─ .workshop_id     (nicht löschen oder bearbeiten - wird vom Werkzeug benutzt)

Wenn Sie .workshop_id löschen, kann das Werkzeug den Workshop-Eintrag für diesen Ordner nicht mehr finden. Ein erneuter upload erstellt dann einen komplett neuen Workshop-Eintrag, statt den bestehenden zu aktualisieren.

Die mod.cfg-Datei

Hier beschreiben Sie Ihren Mod. Format: eine Direktive pro Zeile:


setf ~key value

Zeilen, die nicht mit setf beginnen, werden ignoriert - verwenden Sie sie für Kommentare.

Erforderliches Feld in mod.cfg

  • ~title - Name, der im Workshop angezeigt wird, bis zu 128 Zeichen.

Das ist die einzige Direktive innerhalb von mod.cfg, die Sie ausfüllen müssen. Ein gültiger Mod benötigt aber auch ein Vorschaubild im Ordner - siehe "Weitere Anforderungen" unten.

Optionale Felder

  • ~description - lange Beschreibung. Verwenden Sie geschweifte Klammern {...} für mehrzeiligen Text. Unterstützt Steam BBCode ([b], [i], [list], [url] usw.).
  • ~tags - Liste von Kategorien. Jedes Tag in Anführungszeichen, durch Leerzeichen getrennt: {"UI" "Texture Pack"}. Siehe Tag-Liste unten.
  • ~preview_image - Dateiname des Vorschaubildes. Standardwert: preview.png.
  • ~version - Ihre Versionsangabe (freier Text, z.B. 1.0 oder 2025-06-14).
  • ~visibility - public, friends oder private. Standardwert: public.

Tags

Wählen Sie null oder mehr aus dieser Liste. Tags beachten Gross-/Kleinschreibung - schreiben Sie sie genau wie angegeben:

TagWofür
QuestNeue Quests oder Questreihen
New CampaignEine komplett neue Kampagne
New UnitsNeue Einheiten oder Rassen
Texture PackErsetzte oder neue Texturen
UIÄnderungen an der Benutzeroberfläche
BalanceAnpassungen an Werten, Kosten, Schwierigkeit
LocalizationÜbersetzungen oder Textänderungen
AudioMusik oder Sounds

Tags können leer bleiben, wenn nichts passt. Wenn Sie aber welche angeben, müssen alle aus dieser Liste stammen.

Weitere Anforderungen

Zusätzlich zu einer gültigen mod.cfg muss Ihr Mod-Ordner enthalten:

  • Ein Vorschaubild (Standardname preview.png, anpassbar über ~preview_image). Vom Steam Workshop verlangt. Grösse ≤ 1 MB.
  • Mindestens eine Inhalts-Datei - alles ausser mod.cfg und dem Vorschaubild. Ein leerer Mod ist nutzlos und besteht die Validierung nicht.
  • Keine ausführbaren Dateien im Ordner oder Unterordnern. Der Uploader weist Dateien mit Erweiterungen wie .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi zurück.

Führen Sie check vor upload aus, und das Werkzeug sagt Ihnen genau, was fehlt oder nicht stimmt.

Beispiel mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Hinweise zum Vorschaubild

Steam zeigt das Vorschaubild auf der Workshop-Seite des Mods und in Suchergebnissen an. Empfohlenes Format:

  • PNG oder JPG
  • 512×512 Pixel (Quadrat passt am besten ins Workshop-Raster)
  • Unter 1 MB

Falls Sie noch kein Bild haben, ist das mitgelieferte Template Mod/preview.png ein Platzhalter - ersetzen Sie ihn vor der Veröffentlichung durch Ihr eigenes.

Mod lokal testen vor der Veröffentlichung

Sie können Ihren Mod im Spiel testen, ohne vorher etwas hochzuladen.

Damit das Spiel Ihren Mod sieht:

1. Öffnen Sie workshop.cfg im Installationsordner des Spiels (neben KB.exe). 2. Fügen Sie eine Zeile hinzu wie:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

Das erste Wort (my_mod hier) ist der Ordnername, der unter data\mods\ erscheint. Der Pfad zeigt, wo der Mod wirklich liegt. Namen mit Leerzeichen kommen in geschweifte Klammern: {My Mod}. 3. Starten Sie das Spiel über Steam. 4. Der Mod ist jetzt aktiv. Ändern Sie Ihre Dateien, starten Sie das Spiel neu, um Änderungen zu testen.

Entfernen Sie die Zeile aus workshop.cfg, wenn Sie mit dem Testen fertig sind oder nachdem Sie im Workshop veröffentlicht haben. Sowohl ein lokaler Eintrag als auch ein Workshop-Abonnement für denselben Mod erzeugen doppelte Inhalte unter data\mods\ und können das Spiel verwirren.

Befehle

Das Werkzeug läuft auf der Kommandozeile. Öffnen Sie cmd (oder doppelklicken Sie einfach auf WorkshopUploader.exe für eine interaktive Oberfläche, die Sie durchführt). Alle Befehle nehmen den Mod-Ordnerpfad als Hauptargument. Pfade mit Leerzeichen müssen in Anführungszeichen gesetzt werden.

check <folder>

Validiert Ihre mod.cfg, das Vorschaubild und den Ordnerinhalt. Meldet Probleme, ohne etwas hochzuladen. Führen Sie das immer vor upload oder update aus.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Beispielausgabe:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

Stimmt etwas nicht, sehen Sie [ERROR]-Zeilen, die erklären, was zu beheben ist.

upload <folder>

Veröffentlicht einen neuen Mod im Workshop. Erstellt einen neuen Workshop-Eintrag, lädt den Inhalt hoch und speichert .workshop_id im Ordner. Verweigert die Ausführung, wenn .workshop_id bereits existiert - benutzen Sie dann update.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Lädt eine neue Version eines bereits im Workshop vorhandenen Mods hoch. Die Workshop-Eintrag-ID wird aus .workshop_id im Mod-Ordner gelesen. Sie können die Änderungen optional beschreiben:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

Abonnenten sehen die Notiz in ihrem Workshop-Feed, wenn das Update verfügbar wird.

status <folder>

Zeigt, was Steam über Ihren Mod weiss - Titel, Beschreibung, letzte Aktualisierung, Sichtbarkeit. Benutzt .workshop_id aus dem Ordner.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

Wie status, nimmt aber eine numerische Workshop-ID direkt entgegen. Funktioniert daher mit jedem Mod (Ihrem oder dem von anderen).


WorkshopUploader.exe info 3745315310

list

Zeigt alle Mods, die Sie veröffentlicht haben.


WorkshopUploader.exe list

Beispielausgabe:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Interaktiver Modus

Wenn Sie WorkshopUploader.exe doppelklicken (oder ohne Argumente starten), öffnet sich eine interaktive Shell:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

Das ist identisch zum Aufruf jedes Befehls aus einer normalen cmd. Nutzen Sie, was Ihnen lieber ist.

Arbeitsablauf-Zusammenfassung

Für einen neuen Mod:

1. Kopieren Sie Template Mod irgendwohin und benennen Sie den Ordner um. 2. Bearbeiten Sie mod.cfg - setzen Sie mindestens ~title. 3. Ersetzen Sie preview.png durch Ihr Bild. 4. Fügen Sie Ihre Mod-Dateien in der vom Spiel erwarteten Struktur hinzu. 5. Testen Sie lokal über workshop.cfg (siehe oben). 6. WorkshopUploader.exe check "<Ihr Ordner>" - prüfen, ob alles in Ordnung ist. 7. WorkshopUploader.exe upload "<Ihr Ordner>" - veröffentlichen. 8. Besuchen Sie die Workshop-Seite Ihres Mods (die URL wird nach dem Hochladen ausgegeben).

Für die Aktualisierung eines bestehenden Mods:

1. Machen Sie Ihre Änderungen im selben Ordner (löschen Sie .workshop_id nicht). 2. Erhöhen Sie ~version in mod.cfg, wenn Sie eine Versionsmarkierung möchten. 3. check, dann update "<folder>" --note "Was geändert wurde". 4. Abonnenten sehen die neue Version automatisch im Hintergrund.

Workshop-Sichtbarkeit

  • Private - nur Sie sehen den Mod. Verwenden Sie das zum Testen Ihres ersten Hochladens. Der Mod ist echt, hat eine echte Workshop-URL, Sie können ihn von Ihrem Steam aus abonnieren, aber niemand sonst findet ihn.
  • Friends - Ihre Steam-Freunde können ihn sehen und abonnieren. Nützlich für eingeschränkte Beta-Tests.
  • Public - jeder im Workshop kann ihn finden und abonnieren. Das ist es, was Sie für die finale Veröffentlichung wollen.

Sie können die Sichtbarkeit ändern, indem Sie mod.cfg bearbeiten und update ausführen.

Mod löschen

Das Werkzeug hat momentan keinen Löschbefehl. Um einen veröffentlichten Mod zu entfernen:

1. Öffnen Sie die Workshop-Seite (URL in der Ausgabe von upload oder über status sichtbar). 2. Klicken Sie auf das Zahnrad-Symbol → Delete.

Die lokale .workshop_id-Datei wird zur Waise (zeigt auf nichts Reales mehr) - löschen Sie sie manuell, wenn Sie den Ordner als neuen Mod erneut veröffentlichen wollen.

Häufige Fehler

  • "mod.cfg not found" - Sie haben den Befehl im falschen Ordner ausgeführt, oder mod.cfg fehlt.
  • "~title is empty" - der Titel in mod.cfg fehlt oder ist leer.
  • "preview file not found" - die Datei aus ~preview_image (Standard preview.png) existiert nicht im Mod-Ordner.
  • "preview file too large" - Ihr Vorschaubild ist über 1 MB. Verkleinern oder neu komprimieren.
  • "no content files - mod folder is empty" - Ihr Ordner enthält nur mod.cfg und das Vorschaubild. Workshop erwartet auch echte Mod-Inhalte.
  • "found executable: ..." - Workshop ist nur für Inhalte. Entfernen Sie .exe/.dll/.bat/etc. aus Ihrem Mod-Ordner.
  • "~tags is not in the approved list" - Sie haben einen Tag verwendet, der nicht in obiger Liste steht. Tags beachten Gross-/Kleinschreibung.
  • "current Steam account does not own this Workshop item" - .workshop_id zeigt auf einen Mod, der von einem anderen Steam-Konto veröffentlicht wurde. Melden Sie sich mit dem richtigen Konto an oder löschen Sie .workshop_id, um neu zu starten.
  • Steam result code 8 (InvalidParam) - bedeutet meist, dass Workshop für das Spiel auf Steamworks-Seite nicht aktiviert ist.
  • "SteamAPI_Init failed" - Steam läuft nicht, oder steam_appid.txt fehlt/ist falsch.

Logs

Das Werkzeug schreibt WorkshopUploader_log.txt neben sich. Hängen Sie diese Datei an Fehlermeldungen an - sie zeigt genau, was das Werkzeug versucht hat und was Steam geantwortet hat.

Workshop Uploader - Guida

Questa guida spiega come usare WorkshopUploader.exe per pubblicare le tue mod di King's Bounty: The Legend sullo Steam Workshop. Non spiega come creare la mod stessa - quello dipende da te. Lo strumento gestisce solo l'impacchettamento, il caricamento e l'aggiornamento delle mod sul Workshop.

Cosa fa questo strumento

WorkshopUploader è un piccolo programma a riga di comando che comunica con Steam per tuo conto. Prende una cartella con la tua mod, verifica che i metadati siano corretti, e carica tutto sullo Steam Workshop come mod nuova o aggiornata.

Non guarda, modifica o interpreta il contenuto della tua mod. Sei tu il responsabile dei file dentro la cartella. Lo strumento richiede un solo file - mod.cfg - con i metadati che il Workshop necessita.

Cosa ti serve

  • La cartella della tua mod da qualche parte sul disco (ovunque, non deve essere dentro la cartella del gioco).
  • Il client Steam in esecuzione e collegato con l'account dal quale vuoi pubblicare.
  • WorkshopUploader.exe, steam_api.dll e steam_appid.txt, tutti nella stessa cartella.

Avvio rapido

Copia la cartella Template mod da qualche parte, rinominala per la tua mod, modifica mod.cfg, sostituisci preview.png con la tua immagine, aggiungi i file della mod ed esegui:


WorkshopUploader.exe upload "C:\path\to\your\mod"

Tutto qui. La mod è ora sul Workshop. Lo strumento salva un file chiamato .workshop_id nella cartella della mod, così sa quale elemento Workshop aggiornare in seguito.

Struttura della cartella della mod

La cartella deve contenere almeno:


your_mod/
├─ mod.cfg          (richiesto, descrive la tua mod)
├─ preview.png      (richiesto, mostrato sulla pagina Workshop)
└─ <i file della tua mod nella struttura che il gioco si aspetta>

Dopo il primo caricamento, lo strumento crea anche:


├─ .workshop_id     (non eliminare o modificare - usato dallo strumento)

Se elimini .workshop_id, lo strumento non può più trovare l'elemento Workshop per questa cartella. Eseguendo di nuovo upload verrà creato un nuovo elemento Workshop invece di aggiornare quello esistente.

Il file mod.cfg

Qui descrivi la tua mod. Formato: una direttiva per riga:


setf ~key value

Le righe che non iniziano con setf vengono ignorate - usale per i commenti.

Campo richiesto in mod.cfg

  • ~title - nome mostrato sul Workshop, fino a 128 caratteri.

Questa è l'unica direttiva dentro mod.cfg che devi compilare. Ma una mod valida ha bisogno anche di un'immagine di anteprima nella cartella - vedi "Altri requisiti" sotto.

Campi opzionali

  • ~description - descrizione lunga. Usa le parentesi graffe {...} per testo multi-riga. Supporta il BBCode di Steam ([b], [i], [list], [url], ecc.).
  • ~tags - lista di categorie. Ogni tag tra virgolette, separati da spazi: {"UI" "Texture Pack"}. Vedi la lista dei tag sotto.
  • ~preview_image - nome del file dell'immagine di anteprima. Predefinito preview.png.
  • ~version - la tua stringa di versione (testo libero, come 1.0 o 2025-06-14).
  • ~visibility - public, friends o private. Predefinito public.

Tag

Scegli zero o più da questa lista. I tag sono sensibili alle maiuscole - scrivili esattamente come mostrato:

TagPer cosa usarli
QuestNuove missioni o catene di missioni
New CampaignUna campagna completamente nuova
New UnitsNuove unità o razze
Texture PackTexture sostituite o nuove
UIModifiche dell'interfaccia
BalanceRitocchi a statistiche, costi, difficoltà
LocalizationTraduzioni o modifiche di testo
AudioMusica o suoni

Puoi lasciare i tag vuoti se nessuno è adatto, ma se ne specifichi qualcuno, devono essere tutti da questa lista.

Altri requisiti

In aggiunta a un mod.cfg valido, la cartella della mod deve contenere:

  • Un file immagine di anteprima (nome predefinito preview.png, modificabile con ~preview_image). Richiesto dallo Steam Workshop. Dimensione ≤ 1 MB.
  • Almeno un file di contenuto - qualsiasi cosa oltre mod.cfg e l'anteprima. Una mod vuota non è utile e non passerà la validazione.
  • Nessun file eseguibile in nessuna cartella o sottocartella. L'uploader rifiuta file con estensioni come .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi.

Esegui check prima di upload e lo strumento ti dirà esattamente cosa manca o cosa non va.

Esempio di mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Note sull'immagine di anteprima

Steam mostra l'anteprima sulla pagina Workshop della mod e nei risultati di ricerca. Formato consigliato:

  • PNG o JPG
  • 512×512 pixel (il quadrato si adatta meglio alla griglia del Workshop)
  • Sotto 1 MB

Se non hai ancora un'immagine, il Template Mod/preview.png incluso è un segnaposto - sostituiscilo con il tuo prima di pubblicare.

Testare la mod localmente prima di pubblicare

Puoi testare la tua mod nel gioco senza caricare nulla prima.

Per far vedere la tua mod al gioco:

1. Apri workshop.cfg nella cartella di installazione del gioco (accanto a KB.exe). 2. Aggiungi una riga come:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

La prima parola (my_mod qui) è il nome della cartella che apparirà sotto data\mods\. Il percorso indica dove la mod si trova davvero. I nomi con spazi usano le graffe: {My Mod}. 3. Avvia il gioco tramite Steam. 4. La mod è ora attiva. Itera sui tuoi file, riavvia il gioco per testare le modifiche.

Rimuovi la riga da workshop.cfg quando hai finito di testare, o dopo aver pubblicato sul Workshop. Avere sia una voce locale che una sottoscrizione Workshop per la stessa mod crea contenuti duplicati sotto data\mods\ e può confondere il gioco.

Comandi

Lo strumento si esegue dalla riga di comando. Apri cmd (o fai doppio clic su WorkshopUploader.exe per una shell interattiva che ti guida). Tutti i comandi prendono il percorso della cartella della mod come argomento principale. I percorsi con spazi devono essere tra virgolette.

check <folder>

Valida il tuo mod.cfg, l'anteprima e il contenuto della cartella. Segnala eventuali problemi senza caricare nulla. Esegui sempre prima di upload o update.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Esempio di output:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

Se qualcosa non va, vedrai righe [ERROR] che spiegano cosa correggere.

upload <folder>

Pubblica una nuova mod sul Workshop. Crea un nuovo elemento Workshop, carica i contenuti e salva .workshop_id nella cartella. Rifiuta di eseguirsi se .workshop_id esiste già - usa update in tal caso.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Carica una nuova versione di una mod già sul Workshop. L'ID dell'elemento Workshop viene letto da .workshop_id nella cartella della mod. Puoi opzionalmente descrivere le modifiche:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

I sottoscrittori vedranno la nota nel loro feed Workshop quando l'aggiornamento sarà disponibile.

status <folder>

Mostra cosa Steam sa della tua mod - titolo, descrizione, ultima data di aggiornamento, visibilità. Usa .workshop_id dalla cartella.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

Come status ma accetta un ID Workshop numerico direttamente, quindi funziona con qualsiasi mod (tua o di altri).


WorkshopUploader.exe info 3745315310

list

Mostra tutte le mod che hai pubblicato.


WorkshopUploader.exe list

Esempio di output:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Modalità interattiva

Se fai doppio clic su WorkshopUploader.exe (o lo esegui senza argomenti), si apre una shell interattiva:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

È identico a eseguire ogni comando da un normale cmd. Usa quello che preferisci.

Riepilogo del flusso di lavoro

Per una nuova mod:

1. Copia Template Mod da qualche parte e rinomina la cartella. 2. Modifica mod.cfg - imposta almeno ~title. 3. Sostituisci preview.png con la tua immagine. 4. Aggiungi i file della mod nella struttura che il gioco si aspetta. 5. Testa localmente tramite workshop.cfg (vedi sopra). 6. WorkshopUploader.exe check "<la tua cartella>" - verifica che tutto sia a posto. 7. WorkshopUploader.exe upload "<la tua cartella>" - pubblica. 8. Visita la pagina Workshop della tua mod (l'URL è stampato dopo il caricamento).

Per aggiornare una mod esistente:

1. Apporta le modifiche nella stessa cartella (non eliminare .workshop_id). 2. Aggiorna ~version in mod.cfg se vuoi un'etichetta di versione. 3. check, poi update "<folder>" --note "Cosa è cambiato". 4. I sottoscrittori vedono la nuova versione automaticamente, in background.

Visibilità Workshop

  • Private - solo tu vedi la mod. Usalo per testare il tuo primo caricamento. La mod è reale, ha un URL Workshop reale, puoi iscriverti dal tuo Steam, ma nessun altro può trovarla.
  • Friends - i tuoi amici Steam possono vederla e iscriversi. Utile per beta-test limitati.
  • Public - chiunque sul Workshop può trovarla e iscriversi. Questo è quello che vuoi per il rilascio finale.

Puoi cambiare la visibilità modificando mod.cfg ed eseguendo update.

Eliminare una mod

Lo strumento non ha attualmente un comando di eliminazione. Per rimuovere una mod pubblicata:

1. Apri la pagina Workshop (URL nell'output di upload o visibile tramite status). 2. Clicca sull'icona dell'ingranaggio → Delete.

Il file locale .workshop_id diventa orfano (non punta più a nulla di reale) - eliminalo manualmente se vuoi ripubblicare la cartella come nuova mod.

Errori comuni

  • "mod.cfg not found" - hai eseguito il comando sulla cartella sbagliata, o mod.cfg manca.
  • "~title is empty" - il titolo in mod.cfg manca o è vuoto.
  • "preview file not found" - il file indicato da ~preview_image (predefinito preview.png) non esiste nella cartella della mod.
  • "preview file too large" - la tua anteprima supera 1 MB. Ridimensiona o ricomprimi.
  • "no content files - mod folder is empty" - la cartella contiene solo mod.cfg e l'anteprima. Workshop si aspetta anche contenuto della mod reale.
  • "found executable: ..." - Workshop è solo per contenuti. Rimuovi .exe/.dll/.bat/etc. dalla cartella della mod.
  • "~tags is not in the approved list" - hai usato un tag non corrispondente alla lista sopra. I tag sono sensibili alle maiuscole.
  • "current Steam account does not own this Workshop item" - .workshop_id punta a una mod pubblicata da un altro account Steam. Accedi con l'account giusto o elimina .workshop_id per ricominciare.
  • Steam result code 8 (InvalidParam) - di solito significa che il Workshop non è abilitato per il gioco sul lato Steamworks.
  • "SteamAPI_Init failed" - Steam non è in esecuzione, o steam_appid.txt manca/è errato.

Log

Lo strumento scrive WorkshopUploader_log.txt accanto a sé. Allega questo file quando segnali problemi - mostra esattamente cosa ha provato a fare lo strumento e cosa ha risposto Steam.

Workshop Uploader - Guía

Esta guía explica cómo usar WorkshopUploader.exe para publicar tus mods de King's Bounty: The Legend en el Steam Workshop. No cubre cómo crear el mod en sí - eso depende de ti. La herramienta solo gestiona el empaquetado, la subida y la actualización de mods en el Workshop.

Qué hace esta herramienta

WorkshopUploader es un pequeño programa de línea de comandos que se comunica con Steam en tu nombre. Toma una carpeta con tu mod, comprueba que los metadatos sean correctos, y sube todo al Steam Workshop como un mod nuevo o actualizado.

No lee, modifica ni entiende el contenido de tu mod. Tú eres responsable de los archivos dentro de la carpeta. La herramienta solo requiere un archivo - mod.cfg - con los metadatos que Workshop necesita.

Qué necesitas

  • Tu carpeta del mod en algún sitio del disco (en cualquier lugar, no tiene que estar dentro de la carpeta del juego).
  • El cliente Steam en ejecución y con sesión iniciada con la cuenta desde la que quieres publicar.
  • WorkshopUploader.exe, steam_api.dll y steam_appid.txt, todos en la misma carpeta.

Inicio rápido

Copia la carpeta Template mod en algún sitio, renómbrala para tu mod, edita mod.cfg, sustituye preview.png por tu propia imagen, añade los archivos de tu mod y ejecuta:


WorkshopUploader.exe upload "C:\path\to\your\mod"

Ya está. El mod está ahora en Workshop. La herramienta guarda un archivo llamado .workshop_id en tu carpeta del mod para saber qué elemento de Workshop actualizar más tarde.

Estructura de la carpeta del mod

La carpeta debe contener como mínimo:


your_mod/
├─ mod.cfg          (requerido, describe tu mod)
├─ preview.png      (requerido, se muestra en la página de Workshop)
└─ <tus archivos de mod en la estructura que el juego espera>

Tras tu primera subida, la herramienta también crea:


├─ .workshop_id     (no eliminar ni editar - lo usa la herramienta)

Si eliminas .workshop_id, la herramienta ya no podrá encontrar el elemento Workshop para esta carpeta. Ejecutar upload de nuevo creará un elemento Workshop totalmente nuevo en lugar de actualizar el existente.

El archivo mod.cfg

Aquí describes tu mod. Formato: una directiva por línea:


setf ~key value

Las líneas que no empiezan con setf se ignoran - úsalas para comentarios.

Campo requerido en mod.cfg

  • ~title - nombre que se muestra en Workshop, hasta 128 caracteres.

Esta es la única directiva dentro de mod.cfg que debes rellenar. Pero un mod válido también necesita una imagen de previsualización en la carpeta - ver "Otros requisitos" abajo.

Campos opcionales

  • ~description - descripción larga. Usa llaves {...} para texto multilínea. Soporta BBCode de Steam ([b], [i], [list], [url], etc.).
  • ~tags - lista de categorías. Cada etiqueta entre comillas, separadas por espacios: {"UI" "Texture Pack"}. Ver la lista de etiquetas abajo.
  • ~preview_image - nombre del archivo de imagen de previsualización. Por defecto preview.png.
  • ~version - tu cadena de versión (texto libre, como 1.0 o 2025-06-14).
  • ~visibility - public, friends o private. Por defecto public.

Etiquetas

Elige cero o más de esta lista. Las etiquetas distinguen mayúsculas - escríbelas exactamente como se muestran:

EtiquetaPara qué
QuestMisiones nuevas o líneas de misiones
New CampaignUna campaña totalmente nueva
New UnitsUnidades o razas nuevas
Texture PackTexturas sustituidas o nuevas
UIModificaciones de la interfaz
BalanceAjustes de estadísticas, costes, dificultad
LocalizationTraducciones o cambios de texto
AudioMúsica o sonidos

Puedes dejar las etiquetas vacías si nada encaja, pero si especificas alguna, todas deben estar en esta lista.

Otros requisitos

Además de un mod.cfg válido, tu carpeta del mod debe contener:

  • Un archivo de imagen de previsualización (nombre por defecto preview.png, modificable con ~preview_image). Requerido por Steam Workshop. Tamaño ≤ 1 MB.
  • Al menos un archivo de contenido - cualquier cosa además de mod.cfg y la previsualización. Un mod vacío no es útil y no pasará la validación.
  • Ningún archivo ejecutable en ninguna carpeta ni subcarpeta. El uploader rechaza archivos con extensiones como .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi.

Ejecuta check antes de upload y la herramienta te dirá exactamente qué falta o qué no está bien.

Ejemplo de mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Notas sobre la imagen de previsualización

Steam muestra la previsualización en la página Workshop del mod y en los resultados de búsqueda. Formato recomendado:

  • PNG o JPG
  • 512×512 píxeles (el cuadrado encaja mejor en la cuadrícula de Workshop)
  • Menos de 1 MB

Si todavía no tienes una imagen, el Template Mod/preview.png incluido es un marcador de posición - sustitúyelo por la tuya antes de publicar.

Probar tu mod localmente antes de publicar

Puedes probar tu mod en el juego sin subir nada primero.

Para que el juego vea tu mod:

1. Abre workshop.cfg en la carpeta de instalación del juego (junto a KB.exe). 2. Añade una línea como:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

La primera palabra (my_mod aquí) es el nombre de la carpeta que aparecerá bajo data\mods\. La ruta indica dónde se encuentra realmente el mod. Los nombres con espacios usan llaves: {My Mod}. 3. Inicia el juego desde Steam. 4. El mod está ahora activo. Itera sobre tus archivos, reinicia el juego para probar cambios.

Elimina la línea de workshop.cfg cuando termines de probar, o después de publicar en Workshop. Tener tanto una entrada local como una suscripción de Workshop para el mismo mod crea contenido duplicado bajo data\mods\ y puede confundir al juego.

Comandos

La herramienta se ejecuta desde la línea de comandos. Abre cmd (o simplemente haz doble clic en WorkshopUploader.exe para un shell interactivo que te guía). Todos los comandos toman la ruta de la carpeta del mod como argumento principal. Las rutas con espacios deben ir entre comillas.

check <folder>

Valida tu mod.cfg, la previsualización y el contenido de la carpeta. Informa de problemas sin subir nada. Ejecútalo siempre antes de upload o update.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Salida de ejemplo:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

Si algo falla, verás líneas [ERROR] que explican qué corregir.

upload <folder>

Publica un mod nuevo en Workshop. Crea un elemento Workshop nuevo, sube el contenido y guarda .workshop_id en la carpeta. Se niega a ejecutarse si .workshop_id ya existe - usa update en ese caso.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Sube una nueva versión de un mod que ya está en Workshop. El ID del elemento Workshop se lee de .workshop_id en la carpeta del mod. Puedes describir opcionalmente los cambios:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

Los suscriptores verán la nota en su feed de Workshop cuando la actualización esté disponible.

status <folder>

Muestra lo que Steam sabe sobre tu mod - título, descripción, última fecha de actualización, visibilidad. Usa .workshop_id de la carpeta.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

Igual que status pero toma directamente un ID numérico de Workshop, por lo que funciona con cualquier mod (tuyo o de otros).


WorkshopUploader.exe info 3745315310

list

Muestra todos los mods que has publicado.


WorkshopUploader.exe list

Salida de ejemplo:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Modo interactivo

Si haces doble clic en WorkshopUploader.exe (o lo ejecutas sin argumentos), se abre un shell interactivo:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

Es idéntico a ejecutar cada comando desde un cmd normal. Usa lo que prefieras.

Resumen del flujo de trabajo

Para un mod nuevo:

1. Copia Template Mod en algún sitio y renombra la carpeta. 2. Edita mod.cfg - como mínimo define ~title. 3. Sustituye preview.png por tu imagen. 4. Añade los archivos del mod en la estructura que el juego espera. 5. Prueba localmente vía workshop.cfg (ver arriba). 6. WorkshopUploader.exe check "<tu carpeta>" - comprueba que todo esté bien. 7. WorkshopUploader.exe upload "<tu carpeta>" - publica. 8. Visita la página Workshop del mod (la URL se imprime tras la subida).

Para actualizar un mod existente:

1. Haz tus cambios en la misma carpeta (no elimines .workshop_id). 2. Sube ~version en mod.cfg si quieres una etiqueta de versión. 3. check, luego update "<folder>" --note "Qué cambió". 4. Los suscriptores ven la nueva versión automáticamente, en segundo plano.

Visibilidad de Workshop

  • Private - solo tú ves el mod. Úsalo para probar tu primera subida. El mod es real, tiene URL real de Workshop, puedes suscribirte desde tu Steam, pero nadie más puede encontrarlo.
  • Friends - tus amigos de Steam pueden verlo y suscribirse. Útil para beta limitada.
  • Public - cualquiera en Workshop puede encontrarlo y suscribirse. Esto es lo que quieres para el lanzamiento final.

Puedes cambiar la visibilidad editando mod.cfg y ejecutando update.

Eliminar un mod

La herramienta no tiene actualmente un comando de eliminación. Para retirar un mod publicado:

1. Abre la página Workshop (URL en la salida de upload o visible mediante status). 2. Haz clic en el icono del engranaje → Delete.

El archivo local .workshop_id queda huérfano (ya no apunta a nada real) - elimínalo manualmente si quieres volver a publicar la carpeta como mod nuevo.

Errores comunes

  • "mod.cfg not found" - ejecutaste el comando en la carpeta equivocada, o falta mod.cfg.
  • "~title is empty" - el título en mod.cfg falta o está vacío.
  • "preview file not found" - el archivo indicado por ~preview_image (por defecto preview.png) no existe en la carpeta del mod.
  • "preview file too large" - tu previsualización supera 1 MB. Redimensiona o recomprime.
  • "no content files - mod folder is empty" - tu carpeta solo contiene mod.cfg y la previsualización. Workshop espera también contenido real del mod.
  • "found executable: ..." - Workshop es solo para contenido. Elimina los .exe/.dll/.bat/etc. de la carpeta del mod.
  • "~tags is not in the approved list" - usaste una etiqueta que no coincide con la lista de arriba. Las etiquetas distinguen mayúsculas.
  • "current Steam account does not own this Workshop item" - .workshop_id apunta a un mod publicado por otra cuenta de Steam. Inicia sesión con la cuenta correcta o elimina .workshop_id para empezar de nuevo.
  • Steam result code 8 (InvalidParam) - normalmente significa que Workshop no está habilitado para el juego en Steamworks.
  • "SteamAPI_Init failed" - Steam no está en ejecución, o steam_appid.txt falta/está mal.

Registros

La herramienta escribe WorkshopUploader_log.txt a su lado. Adjunta este archivo cuando reportes problemas - muestra exactamente lo que la herramienta intentó hacer y lo que respondió Steam.

Workshop Uploader - Průvodce

Tento průvodce vysvětluje, jak používat WorkshopUploader.exe k publikování vašich modů pro King's Bounty: The Legend na Steam Workshop. Nepokrývá tvorbu samotného modu - to záleží na vás. Nástroj se stará pouze o balení, nahrávání a aktualizaci modů na Workshopu.

Co tento nástroj dělá

WorkshopUploader je malý program pro příkazovou řádku, který za vás komunikuje se Steamem. Vezme složku s vaším modem, ověří, že metadata jsou správná, a nahraje vše na Steam Workshop jako nový nebo aktualizovaný mod.

Nečte, nemění ani neinterpretuje obsah vašeho modu. Za soubory ve složce odpovídáte vy. Nástroj vyžaduje jen jeden soubor - mod.cfg - s metadaty, která Workshop potřebuje.

Co potřebujete

  • Složku s vaším modem někde na disku (kdekoliv, nemusí být uvnitř složky hry).
  • Spuštěného klienta Steam přihlášeného k účtu, ze kterého chcete publikovat.
  • WorkshopUploader.exe, steam_api.dll a steam_appid.txt - všechny ve stejné složce.

Rychlý start

Zkopírujte složku Template mod někam, přejmenujte ji pro svůj mod, upravte mod.cfg, nahraďte preview.png vlastním obrázkem, přidejte soubory modu a spusťte:


WorkshopUploader.exe upload "C:\path\to\your\mod"

To je vše. Mod je teď na Workshopu. Nástroj uloží soubor .workshop_id do složky s modem, aby věděl, kterou položku Workshop má později aktualizovat.

Struktura složky modu

Složka musí obsahovat alespoň:


your_mod/
├─ mod.cfg          (povinné, popisuje váš mod)
├─ preview.png      (povinné, zobrazuje se na stránce Workshop)
└─ <vaše soubory modu ve struktuře, jakou hra očekává>

Po prvním nahrání nástroj také vytvoří:


├─ .workshop_id     (nemazat ani neupravovat - používá ho nástroj)

Pokud .workshop_id smažete, nástroj už nedokáže najít položku Workshop pro tuto složku. Opětovné spuštění upload vytvoří úplně novou položku Workshop místo aktualizace existující.

Soubor mod.cfg

Tady popisujete svůj mod. Formát: jedna direktiva na řádek:


setf ~key value

Řádky, které nezačínají setf, jsou ignorovány - používejte je pro komentáře.

Povinné pole v mod.cfg

  • ~title - jméno zobrazené na Workshopu, až 128 znaků.

Tohle je jediná direktiva uvnitř mod.cfg, kterou musíte vyplnit. Platný mod ale potřebuje také obrázek náhledu ve složce - viz "Další požadavky" níže.

Volitelná pole

  • ~description - dlouhý popis. Pro víceřádkový text použijte složené závorky {...}. Podporuje Steam BBCode ([b], [i], [list], [url] atd.).
  • ~tags - seznam kategorií. Každý tag v uvozovkách, oddělené mezerami: {"UI" "Texture Pack"}. Seznam tagů viz níže.
  • ~preview_image - jméno souboru s obrázkem náhledu. Výchozí preview.png.
  • ~version - vaše verze (libovolný text, např. 1.0 nebo 2025-06-14).
  • ~visibility - public, friends nebo private. Výchozí public.

Tagy

Vyberte nula nebo více z tohoto seznamu. Tagy rozlišují velká a malá písmena - pište je přesně tak, jak jsou uvedeny:

TagPro co
QuestNové úkoly nebo questové linie
New CampaignÚplně nová kampaň
New UnitsNové jednotky nebo rasy
Texture PackNahrazené nebo nové textury
UIÚpravy uživatelského rozhraní
BalanceÚpravy statistik, cen, obtížnosti
LocalizationPřeklady nebo textové změny
AudioHudba nebo zvuky

Tagy můžete nechat prázdné, pokud nic nesedí, ale pokud nějaké uvedete, musí být všechny z tohoto seznamu.

Další požadavky

Kromě platného mod.cfg musí složka modu obsahovat:

  • Obrázek náhledu (výchozí název preview.png, lze změnit přes ~preview_image). Vyžadováno Steam Workshopem. Velikost ≤ 1 MB.
  • Alespoň jeden soubor obsahu - cokoli kromě mod.cfg a náhledu. Prázdný mod není užitečný a neprojde validací.
  • Žádné spustitelné soubory ve složce ani podsložkách. Uploader odmítá soubory s příponami jako .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi.

Spusťte check před upload a nástroj vám přesně řekne, co chybí nebo není v pořádku.

Příklad mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Poznámky k obrázku náhledu

Steam zobrazuje náhled na stránce Workshop modu a ve výsledcích vyhledávání. Doporučený formát:

  • PNG nebo JPG
  • 512x512 pixelů (čtverec se nejlépe vejde do mřížky Workshopu)
  • Pod 1 MB

Pokud zatím nemáte obrázek, přiložený Template Mod/preview.png je zástupce - před publikováním ho nahraďte vlastním.

Místní testování modu před publikací

Mod můžete otestovat ve hře, aniž byste cokoliv předem nahráli.

Aby hra váš mod viděla:

1. Otevřete workshop.cfg ve složce instalace hry (vedle KB.exe). 2. Přidejte řádek jako:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

První slovo (zde my_mod) je jméno složky, která se objeví pod data\mods\. Cesta určuje, kde se mod skutečně nachází. Jména s mezerami obalte složenými závorkami: {My Mod}. 3. Spusťte hru přes Steam. 4. Mod je aktivní. Iterujte na souborech, restartujte hru pro test změn.

Po skončení testování nebo po publikování na Workshopu řádek z workshop.cfg odstraňte. Mít zároveň lokální záznam i odběr Workshop pro stejný mod vytváří duplicitní obsah pod data\mods\ a může hru zmást.

Příkazy

Nástroj se spouští z příkazové řádky. Otevřete cmd (nebo prostě dvakrát klikněte na WorkshopUploader.exe pro interaktivní shell, který vás provede). Všechny příkazy berou cestu ke složce modu jako hlavní argument. Cesty s mezerami musí být v uvozovkách.

check <folder>

Validuje vaše mod.cfg, náhled a obsah složky. Hlásí problémy bez nahrávání. Vždy spouštějte před upload nebo update.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Vzorový výstup:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

Pokud něco není v pořádku, uvidíte řádky [ERROR] s vysvětlením, co opravit.

upload <folder>

Publikuje nový mod na Workshop. Vytvoří novou položku Workshop, nahraje obsah a uloží .workshop_id do složky. Odmítne se spustit, pokud .workshop_id už existuje - pro to použijte update.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Nahraje novou verzi modu, který už je na Workshopu. ID položky Workshop se čte z .workshop_id ve složce modu. Volitelně můžete popsat změny:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

Odběratelé uvidí poznámku ve své Workshop feedu, jakmile bude aktualizace dostupná.

status <folder>

Ukazuje, co Steam ví o vašem modu - název, popis, čas poslední aktualizace, viditelnost. Používá .workshop_id ze složky.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

Stejné jako status, ale bere přímo číselné Workshop ID, takže funguje s libovolným modem (vaším nebo někoho jiného).


WorkshopUploader.exe info 3745315310

list

Zobrazí všechny mody, které jste publikovali.


WorkshopUploader.exe list

Vzorový výstup:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Interaktivní režim

Pokud dvakrát kliknete na WorkshopUploader.exe (nebo ho spustíte bez argumentů), otevře se interaktivní shell:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

Je to identické se spouštěním každého příkazu z běžného cmd. Použijte, co je vám pohodlnější.

Shrnutí pracovního postupu

Pro nový mod:

1. Zkopírujte Template Mod někam a přejmenujte složku. 2. Upravte mod.cfg - minimálně nastavte ~title. 3. Nahraďte preview.png svým obrázkem. 4. Přidejte soubory modu ve struktuře, jakou hra očekává. 5. Otestujte lokálně přes workshop.cfg (viz výše). 6. WorkshopUploader.exe check "<vaše složka>" - ověřte, že je vše v pořádku. 7. WorkshopUploader.exe upload "<vaše složka>" - publikujte. 8. Navštivte stránku Workshop vašeho modu (URL se vypíše po nahrání).

Pro aktualizaci stávajícího modu:

1. Proveďte změny ve stejné složce (nemažte .workshop_id). 2. Změňte ~version v mod.cfg, pokud chcete označit verzi. 3. check, pak update "<folder>" --note "Co se změnilo". 4. Odběratelé vidí novou verzi automaticky, na pozadí.

Viditelnost ve Workshopu

  • Private - mod vidíte jen vy. Použijte pro testování prvního nahrání. Mod je skutečný, má skutečnou Workshop URL, můžete se na něj přihlásit ze svého Steamu, ale nikdo jiný ho nemůže najít.
  • Friends - vaši přátelé na Steamu ho mohou vidět a přihlásit se. Užitečné pro omezené beta-testování.
  • Public - kdokoli na Workshopu ho může najít a přihlásit se. To je to, co chcete pro finální vydání.

Viditelnost lze změnit úpravou mod.cfg a spuštěním update.

Smazání modu

Nástroj momentálně nemá příkaz pro smazání. Pro odstranění publikovaného modu:

1. Otevřete stránku Workshop (URL je ve výstupu upload nebo vidět přes status). 2. Klikněte na ikonu ozubeného kola → Delete.

Lokální soubor .workshop_id osiří (už neukazuje na nic skutečného) - smažte ho ručně, pokud chcete složku publikovat znovu jako nový mod.

Časté chyby

  • "mod.cfg not found" - spustili jste příkaz na špatné složce, nebo mod.cfg chybí.
  • "~title is empty" - název v mod.cfg chybí nebo je prázdný.
  • "preview file not found" - soubor uvedený v ~preview_image (výchozí preview.png) ve složce modu neexistuje.
  • "preview file too large" - váš náhled je větší než 1 MB. Zmenšete nebo znovu komprimujte.
  • "no content files - mod folder is empty" - vaše složka obsahuje jen mod.cfg a náhled. Workshop očekává také skutečný obsah modu.
  • "found executable: ..." - Workshop je jen pro obsah. Odstraňte .exe/.dll/.bat/atd. ze složky modu.
  • "~tags is not in the approved list" - použili jste tag, který neodpovídá seznamu výše. Tagy rozlišují velká a malá písmena.
  • "current Steam account does not own this Workshop item" - .workshop_id ukazuje na mod publikovaný z jiného účtu Steam. Přihlaste se správným účtem nebo smažte .workshop_id a začněte znovu.
  • Steam result code 8 (InvalidParam) - obvykle znamená, že Workshop není pro hru ve Steamworks povolen.
  • "SteamAPI_Init failed" - Steam neběží, nebo steam_appid.txt chybí/je nesprávný.

Logy

Nástroj píše WorkshopUploader_log.txt vedle sebe. Při hlášení problémů přiložte tento soubor - ukazuje přesně, co se nástroj pokusil udělat a co Steam odpověděl.

Workshop Uploader - ガイド

このガイドでは、WorkshopUploader.exeを使ってKing's Bounty: The LegendのMODをSteam Workshopに公開する方法を説明します。MOD自体の作り方は説明しません - それはあなた次第です。このツールはWorkshopでのMODのパッケージング、アップロード、更新のみを扱います。

このツールができること

WorkshopUploaderは、Steamと代わりに通信する小さなコマンドラインプログラムです。MODのフォルダを受け取り、メタデータが正しいか検証し、すべてを新規または更新されたMODとしてSteam Workshopにアップロードします。

ツールはMODの内容を見たり、変更したり、理解したりしません。フォルダ内のファイルに対する責任はあなたにあります。ツールが必要とするのは、Workshopが必要とするメタデータを含むmod.cfgという1つのファイルだけです。

必要なもの

  • ディスクのどこかにあるMODフォルダ (どこでも、ゲームフォルダ内である必要はありません)。
  • 公開したいアカウントでログインした状態で実行中のSteamクライアント。
  • WorkshopUploader.exe、steam_api.dll、steam_appid.txt、すべて同じフォルダに。

クイックスタート

Template modフォルダをどこかにコピーし、自分のMOD用に名前を変え、mod.cfgを編集し、preview.pngを自分の画像で置き換え、MODファイルを追加し、次を実行します:


WorkshopUploader.exe upload "C:\path\to\your\mod"

これで完了です。MODはWorkshopに公開されました。ツールはMODフォルダに.workshop_idというファイルを保存し、後でどのWorkshopアイテムを更新するか把握します。

MODフォルダの構成

フォルダには最低限以下が必要です:


your_mod/
├─ mod.cfg          (必須、MODを説明)
├─ preview.png      (必須、Workshopページで表示)
└─ <ゲームが期待する構造のMODファイル>

最初のアップロード後、ツールは以下も作成します:


├─ .workshop_id     (削除・編集しないでください - ツールが使用します)

.workshop_idを削除すると、ツールはこのフォルダに対応するWorkshopアイテムを見つけられなくなります。再度uploadを実行すると、既存のものを更新する代わりに、まったく新しいWorkshopアイテムが作成されます。

mod.cfgファイル

ここでMODを説明します。フォーマットは1行に1つのディレクティブ:


setf ~key value

setfで始まらない行は無視されます - コメントに使用してください。

mod.cfgで必須のフィールド

  • ~title - Workshopに表示される名前、128文字まで。

これがmod.cfg内で記入しなければならない唯一のディレクティブです。ただし、有効なMODにはフォルダ内のプレビュー画像ファイルも必要です - 以下の「その他の要件」を参照してください。

オプションのフィールド

  • ~description - 長い説明。複数行のテキストには{...}の中括弧を使用。Steam BBCode ([b]、[i]、[list]、[url]など) をサポート。
  • ~tags - カテゴリのリスト。各タグを引用符で囲み、スペースで区切る: {"UI" "Texture Pack"}。タグ一覧は以下を参照。
  • ~preview_image - プレビュー画像ファイル名。デフォルトはpreview.png。
  • ~version - バージョン文字列 (自由形式、1.0や2025-06-14など)。
  • ~visibility - public、friends、privateのいずれか。デフォルトはpublic。

タグ

以下のリストから0個以上選んでください。タグは大文字と小文字を区別します - 表示通りに正確に書いてください:

タグ用途
Quest新しいクエストやクエストライン
New Campaign完全に新しいキャンペーン
New Units新しいユニットや種族
Texture Pack置き換えまたは新しいテクスチャ
UIインターフェースの変更
Balanceステータス、コスト、難易度の調整
Localization翻訳またはテキストの変更
Audio音楽またはサウンド

何も合わない場合はタグを空にできますが、指定する場合はすべてこのリストからでなければなりません。

その他の要件

有効なmod.cfgに加えて、MODフォルダには以下が必要です:

  • プレビュー画像ファイル (デフォルト名はpreview.png、~preview_imageで上書き可能)。Steam Workshopで必須。サイズは1 MB以下。
  • 少なくとも1つのコンテンツファイル - mod.cfgとプレビュー以外のもの。空のMODは役に立たず、検証を通過しません。
  • フォルダまたはサブフォルダ内に実行可能ファイルがないこと。アップローダーは.exe、.dll、.bat、.cmd、.ps1、.sh、.scr、.com、.msiなどの拡張子のファイルを拒否します。

uploadの前にcheckを実行すると、ツールが何が不足しているか、何が問題かを正確に教えてくれます。

mod.cfgの例


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

プレビュー画像の注意点

SteamはプレビューをMODのWorkshopページと検索結果に表示します。推奨フォーマット:

  • PNGまたはJPG
  • 512x512ピクセル (正方形がWorkshopのグリッドに最も適合)
  • 1 MB未満

まだ画像がない場合、付属のTemplate Mod/preview.pngはプレースホルダーです - 公開前に自分のものに置き換えてください。

公開前にMODをローカルでテストする

事前に何もアップロードせずに、ゲーム内でMODをテストできます。

ゲームにMODを認識させるには:

1. ゲームのインストールフォルダ内 (KB.exeの隣) のworkshop.cfgを開きます。 2. 次のような行を追加します:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

最初の単語 (ここではmy_mod) はdata\mods\の下に表示されるフォルダ名です。パスはMODが実際にある場所です。スペースを含む名前は中括弧を使用: {My Mod}。 3. Steamからゲームを起動します。 4. MODが有効になりました。ファイルを修正し、ゲームを再起動して変更をテストしてください。

テストが終わったら、またはWorkshopに公開した後、workshop.cfgから行を削除してください。同じMODに対してローカルエントリとWorkshopのサブスクリプションの両方を持つと、data\mods\の下に重複コンテンツが作成され、ゲームを混乱させる可能性があります。

コマンド

ツールはコマンドラインから実行します。cmdを開く (またはWorkshopUploader.exeをダブルクリックするだけで、インタラクティブシェルが起動します)。すべてのコマンドはMODフォルダのパスを主引数とします。スペースを含むパスは引用符で囲む必要があります。

check <folder>

mod.cfg、プレビュー、フォルダ内容を検証します。何もアップロードせずに問題を報告します。uploadまたはupdateの前に必ず実行してください。


WorkshopUploader.exe check "C:\my mods\custom_ui"

サンプル出力:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

何か問題がある場合、修正方法を説明する[ERROR]行が表示されます。

upload <folder>

新しいMODをWorkshopに公開します。新しいWorkshopアイテムを作成し、内容をアップロードし、フォルダに.workshop_idを保存します。.workshop_idがすでに存在する場合は実行を拒否します - その場合はupdateを使用してください。


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

すでにWorkshopにあるMODの新バージョンをアップロードします。WorkshopアイテムIDはMODフォルダ内の.workshop_idから読み取られます。任意で変更内容を記述できます:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

サブスクライバーは更新が公開されると、自分のWorkshopフィードでメモを見ることができます。

status <folder>

Steamが知っているMODの情報を表示します - タイトル、説明、最終更新時刻、表示範囲。フォルダから.workshop_idを使用します。


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

statusと同じですが、数値のWorkshop IDを直接受け取るので、どのMODでも動作します (自分のものでも他人のものでも)。


WorkshopUploader.exe info 3745315310

list

公開したすべてのMODを表示します。


WorkshopUploader.exe list

サンプル出力:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

インタラクティブモード

WorkshopUploader.exeをダブルクリック (または引数なしで実行) すると、インタラクティブシェルが開きます:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

通常のcmdプロンプトから各コマンドを実行するのと同じです。お好みの方法を使ってください。

ワークフローのまとめ

新しいMODの場合:

1. Template Modをどこかにコピーしてフォルダ名を変更します。 2. mod.cfgを編集 - 少なくとも~titleを設定します。 3. preview.pngをMODの画像に置き換えます。 4. ゲームが期待する構造でMODファイルを追加します。 5. workshop.cfg経由でローカルテストします (上記参照)。 6. WorkshopUploader.exe check "<フォルダ>" - すべて問題ないか確認します。 7. WorkshopUploader.exe upload "<フォルダ>" - 公開します。 8. MODのWorkshopページを訪問します (URLはアップロード後に出力されます)。

既存のMODを更新する場合:

1. 同じフォルダ内で変更を行います (.workshop_idは削除しないでください)。 2. バージョンラベルが必要な場合、mod.cfgの~versionを更新します。 3. check、次にupdate "<folder>" --note "変更内容"。 4. サブスクライバーは自動的にバックグラウンドで新バージョンを受け取ります。

Workshop の表示範囲

  • Private - あなただけがMODを見ます。最初のアップロードのテストに使用してください。MODは本物で、本物のWorkshop URLを持ち、自分のSteamから登録できますが、他の誰も見つけることができません。
  • Friends - SteamのフレンドだけがMODを見て登録できます。限定的なベータテストに便利です。
  • Public - Workshop上の誰でも見つけて登録できます。最終リリースに必要な設定です。

mod.cfgを編集してupdateを実行することで表示範囲を変更できます。

MODの削除

ツールには現在削除コマンドがありません。公開されたMODを削除するには:

1. Workshopページを開きます (uploadの出力またはstatusで確認できるURL)。 2. 歯車アイコンをクリック → Delete。

ローカルの.workshop_idファイルは孤立します (もう実在のものを指していません) - フォルダを新しいMODとして再公開する場合は手動で削除してください。

よくあるエラー

  • "mod.cfg not found" - 間違ったフォルダでコマンドを実行したか、mod.cfgが欠けています。
  • "~title is empty" - mod.cfgのタイトルが欠けているか空です。
  • "preview file not found" - ~preview_image (デフォルトはpreview.png) が指すファイルがMODフォルダに存在しません。
  • "preview file too large" - プレビューが1 MBを超えています。サイズを変更するか再圧縮してください。
  • "no content files - mod folder is empty" - フォルダにmod.cfgとプレビューしかありません。Workshopは実際のMODコンテンツも期待しています。
  • "found executable: ..." - Workshopはコンテンツ専用です。.exe/.dll/.bat/などをMODフォルダから削除してください。
  • "~tags is not in the approved list" - 上記のリストに一致しないタグを使用しました。タグは大文字と小文字を区別します。
  • "current Steam account does not own this Workshop item" - .workshop_idが別のSteamアカウントで公開されたMODを指しています。正しいアカウントでログインするか、.workshop_idを削除して最初からやり直してください。
  • Steam result code 8 (InvalidParam) - 通常、SteamworksでゲームのWorkshopが有効になっていないことを意味します。
  • "SteamAPI_Init failed" - Steamが実行されていないか、steam_appid.txtが欠けている/正しくありません。

ログ

ツールは隣にWorkshopUploader_log.txtを書き込みます。問題を報告する際にはこのファイルを添付してください - ツールが何をしようとしてSteamが何を返したか正確に示しています。

Workshop Uploader - Útmutató

Ez az útmutató ismerteti, hogyan használhatod a WorkshopUploader.exe-t a King's Bounty: The Legend modjaid Steam Workshopra való közzétételéhez. Magát a mod készítését nem tárgyalja - az rajtad múlik. Az eszköz csak a modok csomagolását, feltöltését és frissítését kezeli a Workshopon.

Mit csinál ez az eszköz

A WorkshopUploader egy kis parancssori program, amely a nevedben kommunikál a Steamel. Fogad egy mappát a moddal, ellenőrzi, hogy a metaadatok helyesek-e, és mindent feltölt a Steam Workshopra új vagy frissített modként.

Nem nézi, módosítja vagy érti meg a mod tartalmát. A mappában lévő fájlokért te vagy felelős. Az eszköznek csak egy fájlra van szüksége - mod.cfg - a Workshop által igényelt metaadatokkal.

Mire van szükséged

  • A mod mappája valahol a lemezen (bárhol, nem kell a játék mappájában lennie).
  • Futó Steam kliens bejelentkezve azzal a fiókkal, amelyikről közzé akarod tenni.
  • WorkshopUploader.exe, steam_api.dll és steam_appid.txt, mind ugyanabban a mappában.

Gyors kezdés

Másold a Template mod mappát valahova, nevezd át a mododhoz, szerkeszd a mod.cfg-t, cseréld a preview.png-t saját képeddel, add hozzá a modfájlokat, majd futtasd:


WorkshopUploader.exe upload "C:\path\to\your\mod"

Ennyi. A mod most fent van a Workshopon. Az eszköz egy .workshop_id nevű fájlt ment a modmappádba, hogy tudja, később melyik Workshop elemet kell frissíteni.

A modmappa szerkezete

A mappának legalább a következőket kell tartalmaznia:


your_mod/
├─ mod.cfg          (kötelező, leírja a modot)
├─ preview.png      (kötelező, megjelenik a Workshop oldalon)
└─ <a mod fájljai a játék által várt struktúrában>

Az első feltöltés után az eszköz létrehozza még:


├─ .workshop_id     (ne töröld vagy szerkeszd - az eszköz használja)

Ha törlöd a .workshop_id-t, az eszköz többé nem találja meg a Workshop elemet ehhez a mappához. Az upload újrafuttatása teljesen új Workshop elemet hoz létre a meglévő frissítése helyett.

A mod.cfg fájl

Itt írod le a modot. Formátum: egy direktíva soronként:


setf ~key value

A setf-fel nem kezdődő sorokat figyelmen kívül hagyja - használhatod őket megjegyzésekhez.

Kötelező mező a mod.cfg-ben

  • ~title - a Workshopon megjelenő név, akár 128 karakterig.

Ez az egyetlen direktíva a mod.cfg-n belül, amit ki kell tölteni. De egy érvényes modhoz előnézeti képfájl is kell a mappában - lásd az "Egyéb követelmények" részt alább.

Opcionális mezők

  • ~description - hosszú leírás. Többsoros szöveghez használj {...} kapcsos zárójeleket. Támogatja a Steam BBCode-ot ([b], [i], [list], [url], stb.).
  • ~tags - kategóriák listája. Minden cimkét idézőjelek közé, szóközzel elválasztva: {"UI" "Texture Pack"}. A cimkék listáját lásd lent.
  • ~preview_image - az előnézeti képfájl neve. Alapértelmezett preview.png.
  • ~version - saját verziódfeliratod (szabad szöveg, pl. 1.0 vagy 2025-06-14).
  • ~visibility - public, friends vagy private. Alapértelmezett public.

Címkék

Válassz nullát vagy többet ebből a listából. A címkék megkülönböztetik a kis- és nagybetűket - pontosan úgy írd őket, ahogy itt szerepelnek:

CímkeMihez
QuestÚj küldetések vagy küldetéslánc
New CampaignTeljesen új kampány
New UnitsÚj egységek vagy fajok
Texture PackLecserélt vagy új textúrák
UIFelhasználói felület módosításai
BalanceStatisztikák, költségek, nehézség módosítása
LocalizationFordítások vagy szövegmódosítások
AudioZene vagy hangok

Címkéket üresen is hagyhatsz, ha semmi sem illik, de ha megadsz valamit, mindennek ebből a listából kell lennie.

Egyéb követelmények

Az érvényes mod.cfg-n felül a modmappádnak tartalmaznia kell:

  • Egy előnézeti képfájlt (alapértelmezett név preview.png, felülírható a ~preview_image-vel). A Steam Workshop megköveteli. Méret 1 MB alatt.
  • Legalább egy tartalmi fájlt - bármi a mod.cfg-n és az előnézeten kívül. Egy üres mod nem hasznos és nem felel meg a validáláson.
  • Nincsenek futtatható fájlok sem a mappában, sem almappákban. Az uploader visszautasítja az olyan kiterjesztésű fájlokat, mint .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi.

Futtasd a check-et az upload előtt, és az eszköz pontosan megmondja, mi hiányzik vagy mi nincs rendben.

Példa mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Megjegyzések az előnézeti képhez

A Steam az előnézetet a mod Workshop oldalán és a keresési eredmények között jeleníti meg. Ajánlott formátum:

  • PNG vagy JPG
  • 512x512 pixel (a négyzet illik leginkább a Workshop rácsába)
  • 1 MB alatt

Ha még nincs képed, a mellékelt Template Mod/preview.png egy helyfoglaló - közzététel előtt cseréld le sajátra.

A mod helyi tesztelése közzététel előtt

Tesztelheted a modot a játékban anélkül, hogy előzőleg bármit feltöltenél.

Hogy a játék lássa a modot:

1. Nyisd meg a workshop.cfg-t a játék telepítési mappájában (a KB.exe mellett). 2. Adj hozzá egy ilyen sort:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

Az első szó (itt my_mod) az a mappanév, amely a data\mods\ alatt megjelenik. Az útvonal megmondja, hol van a mod valójában. A szóközös neveket kapcsos zárójelekbe tedd: {My Mod}. 3. Indítsd el a játékot Steamen keresztül. 4. A mod most aktív. Iterálj a fájlokon, indítsd újra a játékot a változások teszteléséhez.

Távolítsd el a sort a workshop.cfg-ből, amikor befejezted a tesztelést, vagy a Workshopra való közzététel után. Ugyanazon modhoz egyszerre helyi bejegyzés és Workshop feliratkozás duplikált tartalmat hoz létre a data\mods\ alatt, és összezavarhatja a játékot.

Parancsok

Az eszköz a parancssorból fut. Nyisd meg a cmd-t (vagy egyszerűen kattints duplán a WorkshopUploader.exe-re egy interaktív héjhoz). Minden parancs a modmappa útvonalát várja fő argumentumként. A szóközös útvonalakat idézőjelek közé kell tenni.

check <folder>

Validálja a mod.cfg-t, az előnézetet és a mappa tartalmát. Jelenti a problémákat anélkül, hogy bármit feltöltene. Mindig futtasd az upload vagy update előtt.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Példa kimenet:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

Ha valami nem stimmel, [ERROR] sorokat fogsz látni, amelyek megmagyarázzák, mit kell javítani.

upload <folder>

Új modot tesz közzé a Workshopra. Új Workshop elemet hoz létre, feltölti a tartalmat, és menti a .workshop_id-t a mappába. Megtagadja a futást, ha a .workshop_id már létezik - használd inkább az update-et.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Új verziót tölt fel egy már Workshopon lévő modhoz. A Workshop elem ID-ja a modmappa .workshop_id fájljából olvasódik. Opcionálisan leírhatod a változásokat:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

A feliratkozók a Workshop hírfolyamukban látják a megjegyzést, amikor a frissítés elérhetővé válik.

status <folder>

Megmutatja, amit a Steam tud a modról - cím, leírás, utolsó frissítés ideje, láthatóság. A mappa .workshop_id-ját használja.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

Ugyanaz, mint a status, de közvetlenül egy numerikus Workshop ID-t fogad, így bármilyen moddal működik (a tieddel vagy másokéval).


WorkshopUploader.exe info 3745315310

list

Megjeleníti az összes általad közzétett modot.


WorkshopUploader.exe list

Példa kimenet:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Interaktív mód

Ha duplán kattintasz a WorkshopUploader.exe-re (vagy argumentumok nélkül futtatod), egy interaktív héj nyílik meg:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

Ez megegyezik azzal, mintha minden parancsot egy normál cmd-ből futtatnál. Használd, amelyiket szereted.

Munkafolyamat összefoglaló

Új modhoz:

1. Másold a Template Mod-ot valahova és nevezd át a mappát. 2. Szerkeszd a mod.cfg-t - legalább a ~title-t állítsd be. 3. Cseréld a preview.png-t a modod képével. 4. Add hozzá a modfájlokat a játék által várt struktúrában. 5. Tesztelj helyileg a workshop.cfg-n keresztül (lásd fent). 6. WorkshopUploader.exe check "<a mappád>" - ellenőrizd, hogy minden rendben. 7. WorkshopUploader.exe upload "<a mappád>" - tedd közzé. 8. Látogasd meg a mod Workshop oldalát (az URL a feltöltés után jelenik meg).

Meglévő mod frissítéséhez:

1. Végezd el a módosításokat ugyanabban a mappában (ne töröld a .workshop_id-t). 2. Frissítsd a ~version-t a mod.cfg-ben, ha verziójelölést akarsz. 3. check, majd update "<folder>" --note "Mi változott". 4. A feliratkozók automatikusan, a háttérben látják az új verziót.

Workshop láthatóság

  • Private - csak te látod a modot. Használd az első feltöltés tesztelésére. A mod valódi, valódi Workshop URL-je van, a saját Steamedről feliratkozhatsz rá, de senki más nem találja meg.
  • Friends - a Steam barátaid látják és feliratkozhatnak. Hasznos korlátozott béta teszteléshez.
  • Public - bárki a Workshopon megtalálhatja és feliratkozhat. Ezt szeretnéd a végleges kiadáshoz.

A láthatóságot a mod.cfg szerkesztésével és az update futtatásával változtathatod meg.

Mod törlése

Az eszköznek jelenleg nincs törlési parancsa. Egy közzétett mod eltávolításához:

1. Nyisd meg a Workshop oldalt (URL az upload kimenetében vagy a status segítségével látható). 2. Kattints a fogaskerék ikonra → Delete.

A helyi .workshop_id fájl árván marad (már nem mutat semmi valódira) - töröld kézzel, ha a mappát új modként akarod újra közzétenni.

Gyakori hibák

  • "mod.cfg not found" - rossz mappán futtattad a parancsot, vagy a mod.cfg hiányzik.
  • "~title is empty" - a cím a mod.cfg-ben hiányzik vagy üres.
  • "preview file not found" - a ~preview_image által megnevezett fájl (alapértelmezett preview.png) nem létezik a modmappában.
  • "preview file too large" - az előnézeted több mint 1 MB. Méretezd át vagy tömörítsd újra.
  • "no content files - mod folder is empty" - a mappád csak mod.cfg-t és előnézetet tartalmaz. A Workshop valódi modtartalmat is vár.
  • "found executable: ..." - A Workshop csak tartalomhoz való. Távolítsd el a .exe/.dll/.bat/stb. fájlokat a modmappádból.
  • "~tags is not in the approved list" - olyan címkét használtál, ami nem szerepel a fenti listában. A címkék megkülönböztetik a kis- és nagybetűket.
  • "current Steam account does not own this Workshop item" - a .workshop_id egy másik Steam fiók által közzétett modra mutat. Jelentkezz be a megfelelő fiókkal, vagy töröld a .workshop_id-t a tiszta indításhoz.
  • Steam result code 8 (InvalidParam) - általában azt jelenti, hogy a Workshop nincs engedélyezve a játékhoz a Steamworks oldalán.
  • "SteamAPI_Init failed" - a Steam nem fut, vagy a steam_appid.txt hiányzik/helytelen.

Naplók

Az eszköz WorkshopUploader_log.txt-t ír maga mellé. Csatold ezt a fájlt a problémák jelentésekor - pontosan megmutatja, mit próbált tenni az eszköz és mit válaszolt a Steam.

Workshop Uploader - 指南

本指南介绍如何使用WorkshopUploader.exe将您的King's Bounty: The Legend模组发布到Steam创意工坊。它不涵盖如何制作模组本身 - 那由您决定。该工具只处理创意工坊上模组的打包、上传和更新。

此工具的作用

WorkshopUploader是一个小型命令行程序,它代表您与Steam通信。它接收包含您模组的文件夹,验证元数据是否正确,并将所有内容作为新模组或更新模组上传到Steam创意工坊。

它不查看、修改或理解您模组的内容。您对文件夹中的文件负责。该工具只需要一个文件 - mod.cfg - 包含创意工坊所需的元数据。

您需要的东西

  • 磁盘上某处的模组文件夹 (任何位置都可以,不必在游戏文件夹内)。
  • Steam客户端正在运行,并已登录到您要发布的账户。
  • WorkshopUploader.exe、steam_api.dll和steam_appid.txt,全部在同一文件夹中。

快速开始

将Template mod文件夹复制到某处,重命名为您的模组,编辑mod.cfg,将preview.png替换为您自己的图像,添加模组文件,然后运行:


WorkshopUploader.exe upload "C:\path\to\your\mod"

就这样。模组现在在创意工坊上了。该工具在您的模组文件夹中保存一个名为.workshop_id的文件,以便它知道以后要更新哪个创意工坊条目。

模组文件夹布局

文件夹必须至少包含:


your_mod/
├─ mod.cfg          (必需,描述您的模组)
├─ preview.png      (必需,显示在创意工坊页面上)
└─ <您的模组文件,按游戏期望的结构>

首次上传后,该工具还会创建:


├─ .workshop_id     (请勿删除或编辑 - 工具使用此文件)

如果您删除.workshop_id,工具将无法再找到此文件夹对应的创意工坊条目。再次运行upload将创建一个全新的创意工坊条目,而不是更新现有条目。

mod.cfg文件

这是您描述模组的地方。格式: 每行一个指令:


setf ~key value

不以setf开头的行会被忽略 - 使用它们作为注释。

mod.cfg中的必填字段

  • ~title - 在创意工坊上显示的名称,最多128个字符。

这是mod.cfg内您必须填写的唯一指令。但是有效的模组在文件夹中还需要预览图像文件 - 请参阅下面的"其他要求"。

可选字段

  • ~description - 长描述。使用{...}大括号表示多行文本。支持Steam BBCode ([b]、[i]、[list]、[url]等)。
  • ~tags - 类别列表。每个标签用引号包裹,用空格分隔: {"UI" "Texture Pack"}。请参阅下面的标签列表。
  • ~preview_image - 预览图像文件的名称。默认为preview.png。
  • ~version - 您的版本字符串 (自由格式文本,如1.0或2025-06-14)。
  • ~visibility - public、friends或private。默认为public。

标签

从此列表中选择零个或多个。标签区分大小写 - 请准确按照显示的方式书写:

标签用途
Quest新任务或任务线
New Campaign全新的战役
New Units新单位或种族
Texture Pack替换或新的纹理
UI界面修改
Balance属性、成本、难度调整
Localization翻译或文本修改
Audio音乐或声音

如果没有合适的,您可以让标签为空,但如果指定了任何标签,它们都必须来自此列表。

其他要求

除了有效的mod.cfg,您的模组文件夹还必须包含:

  • 预览图像文件 (默认名称preview.png,通过~preview_image覆盖)。Steam创意工坊要求。大小1 MB以内。
  • 至少一个内容文件 - 除mod.cfg和预览之外的任何内容。空模组没有用,无法通过验证。
  • 文件夹或子文件夹中无可执行文件。上传器拒绝具有.exe、.dll、.bat、.cmd、.ps1、.sh、.scr、.com、.msi等扩展名的文件。

在upload之前运行check,该工具会准确告诉您缺少什么或哪里不对。

mod.cfg示例


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

预览图像注意事项

Steam在模组的创意工坊页面和搜索结果中显示预览。推荐格式:

  • PNG或JPG
  • 512x512像素 (方形最适合创意工坊网格)
  • 1 MB以下

如果您还没有图像,附带的Template Mod/preview.png是占位符 - 发布前请替换为您自己的。

发布前本地测试您的模组

您可以在游戏中测试模组而无需先上传任何内容。

让游戏看到您的模组:

1. 打开游戏安装文件夹中的workshop.cfg (在KB.exe旁边)。 2. 添加如下行:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

第一个词 (此处my_mod) 是将在data\mods\下出现的文件夹名称。路径指示模组实际所在位置。带空格的名称使用大括号: {My Mod}。 3. 通过Steam启动游戏。 4. 模组现在已激活。迭代您的文件,重启游戏以测试更改。

测试完成后或发布到创意工坊后,从workshop.cfg中删除该行。同一模组同时拥有本地条目和创意工坊订阅会在data\mods\下创建重复内容,可能会使游戏混乱。

命令

该工具从命令行运行。打开cmd (或者只需双击WorkshopUploader.exe即可获得交互式shell)。所有命令都将模组文件夹路径作为主要参数。带空格的路径必须用引号包裹。

check <folder>

验证您的mod.cfg、预览和文件夹内容。报告问题但不上传任何内容。始终在upload或update之前运行。


WorkshopUploader.exe check "C:\my mods\custom_ui"

示例输出:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

如果出现问题,您将看到[ERROR]行解释要修复什么。

upload <folder>

将新模组发布到创意工坊。创建新的创意工坊条目,上传内容,并在文件夹中保存.workshop_id。如果.workshop_id已存在,则拒绝运行 - 在这种情况下使用update。


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

上传创意工坊上已有模组的新版本。创意工坊条目ID从模组文件夹中的.workshop_id读取。您可以选择性地描述更改:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

订阅者在更新发布时会在他们的创意工坊订阅中看到该注释。

status <folder>

显示Steam所知道的关于您模组的信息 - 标题、描述、最后更新时间、可见性。使用文件夹中的.workshop_id。


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

与status相同,但直接接受数字创意工坊ID,因此可以处理任何模组 (您的或别人的)。


WorkshopUploader.exe info 3745315310

list

显示您发布的所有模组。


WorkshopUploader.exe list

示例输出:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

交互模式

如果您双击WorkshopUploader.exe (或不带参数运行),将打开一个交互式shell:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

这与从普通cmd提示符运行每个命令相同。使用您喜欢的方式。

工作流程总结

对于新模组:

1. 将Template Mod复制到某处并重命名文件夹。 2. 编辑mod.cfg - 至少设置~title。 3. 将preview.png替换为您模组的图像。 4. 按游戏期望的结构添加模组文件。 5. 通过workshop.cfg本地测试 (见上文)。 6. WorkshopUploader.exe check "<您的文件夹>" - 确认一切正常。 7. WorkshopUploader.exe upload "<您的文件夹>" - 发布。 8. 访问模组的创意工坊页面 (URL在上传后打印)。

对于更新现有模组:

1. 在同一文件夹中进行更改 (不要删除.workshop_id)。 2. 如果需要版本标签,在mod.cfg中更新~version。 3. check,然后update "<folder>" --note "更改的内容"。 4. 订阅者会在后台自动看到新版本。

创意工坊可见性

  • Private - 只有您看到该模组。用于测试您的首次上传。模组是真实的,有真实的创意工坊URL,您可以从自己的Steam订阅它,但其他人找不到它。
  • Friends - 您的Steam好友可以看到并订阅。对受限的测试版很有用。
  • Public - 创意工坊上的任何人都可以找到并订阅。这是您最终发布所需要的。

您可以通过编辑mod.cfg并运行update来更改可见性。

删除模组

该工具目前没有删除命令。要移除已发布的模组:

1. 打开创意工坊页面 (URL在upload输出中或通过status可见)。 2. 单击齿轮图标 → Delete。

本地.workshop_id文件变成孤立的 (不再指向任何真实的东西) - 如果您想将文件夹重新发布为新模组,请手动删除它。

常见错误

  • "mod.cfg not found" - 您在错误的文件夹上运行了命令,或mod.cfg缺失。
  • "~title is empty" - mod.cfg中的标题缺失或为空。
  • "preview file not found" - ~preview_image (默认preview.png) 指定的文件在模组文件夹中不存在。
  • "preview file too large" - 您的预览超过1 MB。调整大小或重新压缩。
  • "no content files - mod folder is empty" - 您的文件夹只包含mod.cfg和预览。创意工坊也期望实际的模组内容。
  • "found executable: ..." - 创意工坊仅用于内容。从您的模组文件夹中删除.exe/.dll/.bat/等。
  • "~tags is not in the approved list" - 您使用了与上面列表不匹配的标签。标签区分大小写。
  • "current Steam account does not own this Workshop item" - .workshop_id指向由其他Steam账户发布的模组。请使用正确的账户登录或删除.workshop_id重新开始。
  • Steam result code 8 (InvalidParam) - 通常意味着Steamworks方面尚未启用该游戏的创意工坊。
  • "SteamAPI_Init failed" - Steam未运行,或steam_appid.txt缺失/不正确。

日志

该工具在自己旁边写入WorkshopUploader_log.txt。报告问题时附上此文件 - 它准确显示该工具尝试做什么以及Steam的响应。

Workshop Uploader - Przewodnik

Ten przewodnik wyjaśnia, jak używać WorkshopUploader.exe do publikowania twoich modów King's Bounty: The Legend na Steam Workshop. Nie omawia samego tworzenia moda - to zależy od ciebie. Narzędzie obsługuje tylko pakowanie, przesyłanie i aktualizowanie modów na Workshopie.

Co robi to narzędzie

WorkshopUploader to mały program konsolowy, który komunikuje się ze Steamem w twoim imieniu. Pobiera folder z twoim modem, sprawdza poprawność metadanych i przesyła wszystko na Steam Workshop jako nowy lub zaktualizowany mod.

Nie czyta, nie modyfikuje ani nie rozumie zawartości twojego moda. Za pliki w folderze odpowiadasz ty. Narzędzie wymaga tylko jednego pliku - mod.cfg - z metadanymi, których potrzebuje Workshop.

Czego potrzebujesz

  • Folderu twojego moda gdzieś na dysku (gdziekolwiek, nie musi być wewnątrz folderu gry).
  • Uruchomionego klienta Steam zalogowanego na konto, z którego chcesz publikować.
  • WorkshopUploader.exe, steam_api.dll i steam_appid.txt, wszystkie w tym samym folderze.

Szybki start

Skopiuj folder Template mod gdzieś, zmień jego nazwę na nazwę twojego moda, edytuj mod.cfg, zastąp preview.png własnym obrazkiem, dodaj pliki moda i uruchom:


WorkshopUploader.exe upload "C:\path\to\your\mod"

To wszystko. Mod jest teraz na Workshopie. Narzędzie zapisuje plik o nazwie .workshop_id w folderze twojego moda, aby wiedzieć, którą pozycję Workshopu zaktualizować później.

Struktura folderu moda

Folder musi zawierać co najmniej:


your_mod/
├─ mod.cfg          (wymagane, opisuje twój mod)
├─ preview.png      (wymagane, wyświetlane na stronie Workshopu)
└─ <pliki twojego moda w strukturze oczekiwanej przez grę>

Po pierwszym przesłaniu narzędzie tworzy także:


├─ .workshop_id     (nie usuwaj ani nie edytuj - używane przez narzędzie)

Jeśli usuniesz .workshop_id, narzędzie nie będzie mogło znaleźć pozycji Workshopu dla tego folderu. Ponowne uruchomienie upload utworzy zupełnie nową pozycję Workshopu zamiast aktualizować istniejącą.

Plik mod.cfg

Tutaj opisujesz swój mod. Format: jedna dyrektywa na linię:


setf ~key value

Linie nie zaczynające się od setf są ignorowane - używaj ich na komentarze.

Wymagane pole w mod.cfg

  • ~title - nazwa wyświetlana na Workshopie, do 128 znaków.

To jedyna dyrektywa wewnątrz mod.cfg, którą musisz wypełnić. Ale poprawny mod potrzebuje też obrazka podglądu w folderze - zobacz "Inne wymagania" poniżej.

Pola opcjonalne

  • ~description - długi opis. Użyj nawiasów klamrowych {...} dla tekstu wielowierszowego. Obsługuje Steam BBCode ([b], [i], [list], [url] itp.).
  • ~tags - lista kategorii. Każdy tag w cudzysłowach, oddzielone spacjami: {"UI" "Texture Pack"}. Zobacz listę tagów poniżej.
  • ~preview_image - nazwa pliku obrazka podglądu. Domyślnie preview.png.
  • ~version - twój ciąg wersji (dowolny tekst, jak 1.0 lub 2025-06-14).
  • ~visibility - public, friends lub private. Domyślnie public.

Tagi

Wybierz zero lub więcej z tej listy. Tagi rozróżniają wielkość liter - pisz je dokładnie tak, jak pokazano:

TagDo czego
QuestNowe questy lub linie questów
New CampaignCałkowicie nowa kampania
New UnitsNowe jednostki lub rasy
Texture PackZamienione lub nowe tekstury
UIModyfikacje interfejsu
BalanceKorekty statystyk, kosztów, trudności
LocalizationTłumaczenia lub zmiany tekstu
AudioMuzyka lub dźwięki

Możesz zostawić tagi puste, jeśli nic nie pasuje, ale jeśli określisz jakiekolwiek, wszystkie muszą być z tej listy.

Inne wymagania

Oprócz poprawnego mod.cfg, folder twojego moda musi zawierać:

  • Plik obrazka podglądu (domyślna nazwa preview.png, można zmienić przez ~preview_image). Wymagane przez Steam Workshop. Rozmiar do 1 MB.
  • Co najmniej jeden plik zawartości - cokolwiek poza mod.cfg i podglądem. Pusty mod nie jest użyteczny i nie przejdzie walidacji.
  • Brak plików wykonywalnych w żadnym folderze ani podfolderze. Uploader odrzuca pliki z rozszerzeniami takimi jak .exe, .dll, .bat, .cmd, .ps1, .sh, .scr, .com, .msi.

Uruchom check przed upload, a narzędzie powie ci dokładnie, czego brakuje lub co jest nie tak.

Przykład mod.cfg


setf ~title Custom UI Pack

setf ~description {A reworked interface with larger fonts and clearer icons.

[b]Features:[/b]
[list]
[*] Resized inventory
[*] Recolored icons
[/list]}

setf ~tags {"UI" "Texture Pack"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

Uwagi o obrazku podglądu

Steam wyświetla podgląd na stronie Workshopu moda i w wynikach wyszukiwania. Zalecany format:

  • PNG lub JPG
  • 512x512 pikseli (kwadrat najlepiej pasuje do siatki Workshopu)
  • Poniżej 1 MB

Jeśli jeszcze nie masz obrazka, dołączony Template Mod/preview.png jest placeholderem - zastąp go swoim przed publikacją.

Lokalne testowanie moda przed publikacją

Możesz przetestować swój mod w grze bez wcześniejszego przesyłania czegokolwiek.

Aby gra zobaczyła twój mod:

1. Otwórz workshop.cfg w folderze instalacji gry (obok KB.exe). 2. Dodaj linię taką jak:


   setf ~local_mod_folder my_mod C:\path\to\your\mod

Pierwsze słowo (tu my_mod) to nazwa folderu, która pojawi się pod data\mods\. Ścieżka wskazuje, gdzie mod faktycznie się znajduje. Nazwy ze spacjami używają nawiasów klamrowych: {My Mod}. 3. Uruchom grę przez Steam. 4. Mod jest teraz aktywny. Iteruj nad swoimi plikami, restartuj grę, aby testować zmiany.

Usuń linię z workshop.cfg, gdy skończysz testowanie, lub po opublikowaniu na Workshopie. Posiadanie jednocześnie lokalnego wpisu i subskrypcji Workshopu dla tego samego moda tworzy zduplikowaną zawartość pod data\mods\ i może zdezorientować grę.

Polecenia

Narzędzie działa z linii poleceń. Otwórz cmd (lub po prostu kliknij dwukrotnie WorkshopUploader.exe, aby uzyskać interaktywną powłokę). Wszystkie polecenia przyjmują ścieżkę do folderu moda jako główny argument. Ścieżki ze spacjami muszą być w cudzysłowach.

check <folder>

Waliduje twój mod.cfg, podgląd i zawartość folderu. Zgłasza wszelkie problemy bez przesyłania czegokolwiek. Zawsze uruchamiaj przed upload lub update.


WorkshopUploader.exe check "C:\my mods\custom_ui"

Przykładowe wyjście:


Checking mod in C:\my mods\custom_ui...

mod.cfg parsed successfully                        [OK]
title: "Custom UI Pack"                            [OK]
tags: UI, Texture Pack                             [OK]
visibility: public                                 [OK]
description provided (245 chars)                   [OK]
version: 1.0                                       [OK]
preview: preview.png (45.2 KB)                     [OK]
8 content files (4.2 MB total)                     [OK]
no executable files                                [OK]

Result: 0 errors, 0 warnings.
Mod is ready for upload.

Jeśli coś jest nie tak, zobaczysz linie [ERROR] wyjaśniające, co naprawić.

upload <folder>

Publikuje nowy mod na Workshopie. Tworzy nową pozycję Workshopu, przesyła zawartość i zapisuje .workshop_id w folderze. Odmawia uruchomienia, jeśli .workshop_id już istnieje - w takim wypadku użyj update.


WorkshopUploader.exe upload "C:\my mods\custom_ui"

update <folder>

Przesyła nową wersję moda, który jest już na Workshopie. ID pozycji Workshopu jest odczytywane z .workshop_id w folderze moda. Możesz opcjonalnie opisać zmiany:


WorkshopUploader.exe update "C:\my mods\custom_ui" --note "Fixed inventory alignment"

Subskrybenci zobaczą notatkę w swoim feedzie Workshopu, gdy aktualizacja stanie się dostępna.

status <folder>

Pokazuje, co Steam wie o twoim modzie - tytuł, opis, czas ostatniej aktualizacji, widoczność. Używa .workshop_id z folderu.


WorkshopUploader.exe status "C:\my mods\custom_ui"

info <id>

Tak samo jak status, ale przyjmuje numeryczne ID Workshopu bezpośrednio, więc działa z dowolnym modem (twoim lub czyimś).


WorkshopUploader.exe info 3745315310

list

Pokazuje wszystkie mody, które opublikowałeś.


WorkshopUploader.exe list

Przykładowe wyjście:


ID            Title                                     Updated           Visibility
----          -----                                     -------           ----------
3745315310    Custom UI Pack                            2026-06-15 13:29  public

Tryb interaktywny

Jeśli klikniesz dwukrotnie WorkshopUploader.exe (lub uruchomisz go bez argumentów), otworzy się interaktywna powłoka:


WorkshopUploader - publish KBTL mods to Steam Workshop
...
Type 'help' to see commands, 'exit' to quit.

> check "C:\my mods\custom_ui"
[output]

> upload "C:\my mods\custom_ui"
[output]

> exit

Jest to identyczne z uruchamianiem każdego polecenia z normalnego cmd. Używaj tego, co wolisz.

Podsumowanie przepływu pracy

Dla nowego moda:

1. Skopiuj Template Mod gdzieś i zmień nazwę folderu. 2. Edytuj mod.cfg - co najmniej ustaw ~title. 3. Zastąp preview.png swoim obrazkiem. 4. Dodaj pliki moda w strukturze oczekiwanej przez grę. 5. Przetestuj lokalnie przez workshop.cfg (zobacz wyżej). 6. WorkshopUploader.exe check "<twój folder>" - sprawdź, czy wszystko jest w porządku. 7. WorkshopUploader.exe upload "<twój folder>" - opublikuj. 8. Odwiedź stronę Workshopu moda (URL jest drukowany po przesłaniu).

Dla aktualizacji istniejącego moda:

1. Wprowadź zmiany w tym samym folderze (nie usuwaj .workshop_id). 2. Zaktualizuj ~version w mod.cfg, jeśli chcesz etykietę wersji. 3. check, potem update "<folder>" --note "Co się zmieniło". 4. Subskrybenci widzą nową wersję automatycznie, w tle.

Widoczność na Workshopie

  • Private - tylko ty widzisz mod. Użyj tego do testowania pierwszego przesłania. Mod jest prawdziwy, ma prawdziwy URL Workshopu, możesz subskrybować z własnego Steama, ale nikt inny nie może go znaleźć.
  • Friends - twoi znajomi ze Steama mogą zobaczyć i subskrybować. Przydatne do ograniczonego testowania beta.
  • Public - każdy na Workshopie może znaleźć i subskrybować. To jest to, co chcesz do finalnego wydania.

Możesz zmienić widoczność edytując mod.cfg i uruchamiając update.

Usuwanie moda

Narzędzie obecnie nie ma polecenia usuwania. Aby usunąć opublikowanego moda:

1. Otwórz stronę Workshopu (URL w wyjściu upload lub widoczny przez status). 2. Kliknij ikonę koła zębatego → Delete.

Lokalny plik .workshop_id staje się osierocony (nie wskazuje już na nic prawdziwego) - usuń go ręcznie, jeśli chcesz ponownie opublikować folder jako nowy mod.

Typowe błędy

  • "mod.cfg not found" - uruchomiłeś polecenie na niewłaściwym folderze, lub mod.cfg brakuje.
  • "~title is empty" - tytuł w mod.cfg brakuje lub jest pusty.
  • "preview file not found" - plik wskazany przez ~preview_image (domyślnie preview.png) nie istnieje w folderze moda.
  • "preview file too large" - twój podgląd przekracza 1 MB. Zmień rozmiar lub rekompresuj.
  • "no content files - mod folder is empty" - twój folder zawiera tylko mod.cfg i podgląd. Workshop oczekuje również prawdziwej zawartości moda.
  • "found executable: ..." - Workshop jest tylko dla zawartości. Usuń .exe/.dll/.bat/itp. ze swojego folderu moda.
  • "~tags is not in the approved list" - użyłeś taga, który nie pasuje do listy powyżej. Tagi rozróżniają wielkość liter.
  • "current Steam account does not own this Workshop item" - .workshop_id wskazuje na moda opublikowanego z innego konta Steam. Zaloguj się właściwym kontem lub usuń .workshop_id, aby zacząć od nowa.
  • Steam result code 8 (InvalidParam) - zwykle oznacza, że Workshop nie jest włączony dla gry po stronie Steamworks.
  • "SteamAPI_Init failed" - Steam nie jest uruchomiony, lub steam_appid.txt brakuje/jest niepoprawny.

Logi

Narzędzie zapisuje WorkshopUploader_log.txt obok siebie. Załącz ten plik przy zgłaszaniu problemów - pokazuje dokładnie, co narzędzie próbowało zrobić i co odpowiedział Steam.