Sharing Your Creations: Uploading and Testing Mods

Now it's time for the exciting part: sharing your creation with the community and ensuring it works correctly in the game. This guide covers uploading your mod to Steam Workshop and mod.io, and the recommended method for testing.

Uploading to Steam Workshop

Before uploading: Ensure you are logged into your Steam account on your computer and that S.T.A.L.K.E.R. 2: Heart of Chornobyl is in your Steam library.

• Uploading a New Mod to Steam Workshop:
  1. In the Zone Kit toolbar, select your active mod.
  2. Select the Steam Workshop Upload button.
  3. In the pop-up window, select the New Mod option.
  4. Fill in the required details: mod name and description. Specify the mod's language using the Steam API Language Code (Languages Supported on Steam).
  5. Leave Package mod before upload selected if you haven’t packaged the mod manually after the latest changes.
  6. Select the Upload button. The process will start, and a confirmation message will appear once the upload to Steam Workshop is complete.

Important Note: After clicking "Upload to Steam Workshop" and until you close the SDK, S.T.A.L.K.E.R. 2: Heart of Chornobyl may appear as "running" in your Steam library. This is normal and expected behavior.

Updating an Existing Mod to Steam Workshop:

7. In the Zone Kit toolbar, select your active mod (the one you want to upload an update for).
8. Select the Steam Workshop Upload button.
9. In the pop-up window, select the Update Mod option.
10. In the Select mod to update dropdown list, select the already uploaded mod that you want to update. The mod's title and description are pulled in. You can optionally update them.
11. Fill in the Change Note field. This text will appear on your mod's Steam Workshop page, informing users about what specifically changed in this update.
    • NOTE: If you upload an update without making any actual file changes, the text in the Change Note field will not be added to the mod's page.
12. Specify the mod language using the API Language Code and optionally choose its visibility settings.
13. Leave Package mod before upload selected if you haven't manually packaged the mod since your last changes.
14. Select the Upload button. The process will start, and a confirmation message will appear once the upload to Steam Workshop is complete.

Uploading to mod.io

Before Uploading: You need to create a mod.io account.

• Initial Authentication: Before your first upload via the editor, authenticate your mod.io account:
  1. Select the mod.io button in the editor toolbar.
  2. Select Create & upload.
  3. In the Content Creation & Upload Tool window, enter the email address associated with your mod.io account.
  4. Enter the received by your email Authentication Code into the field in the editor window.
  5. Select the Authenticate button. You should now be successfully authenticated.

Once authenticated, you can create and upload:

• Uploading a New Mod to mod.io:
  1. Select the Create Mod button in the Content Creation & Upload Tool window.
  2. Choose the path to your mod's Logo File. Ensure the image meets the requirements - PNG format; 512x288px or larger (16:9 aspect ratio recommended); 8MB maximum.
  3. Enter the title and a brief summary for your mod in the respective fields.
  4. Select the Submit button. A message confirming that the mod has been created appears. A new item appears in the My Mods section on mod.io.
  5. Having done that, follow these steps to upload files to the created item:
     • A new window, Mod Created, will appear. Select Yes to proceed with uploading the mod files.
     • Select the Create mod for PC button, regardless of the platform it was created for.
     • Specify the path to the folder containing your packaged mod files (the folder inside s2gamebuild\SavedMods\Staged\ named after your mod).
     • Fill in the Version String (e.g., "v1.0", "Beta 2") and the Changelog field (describing the contents of this version).
     • Select the Submit button. The files will be uploaded to mod.io. You can check the Output Log for a success message.
     • Open the mod for editing on the website and select the checkbox next to the platform(s) it was created for (PC or Xbox) to correctly tag it.
     • Set the file as live, and your mod is now uploaded!
        
• Updating an Existing Mod on mod.io:
  1. In the editor, select the active mod you want to upload an update for.
  2. Select the mod.io button > Create & upload.
  3. In the Content Creation & Upload Tool window, select the Edit Mod button.
  4. Expand the Browse Mod list and select the mod you want to update. Optionally, change the mod's name and description here.
  5. Select the Edit Files button. In the next window, you'll see a list of files previously uploaded for this mod.
  6. Select New Modfile to start the process of uploading a new version's files.
  7. Specify the path to the folder with your newly packaged mod, which is typically located at: s2gamebuild\SavedMods\Staged\mod_name.
  8. Indicate the Version String for this update and add changes to the Changelog.
  9. Select Set as Active Release if you want this new version to be released immediately after upload.
  10. Select the Submit button. After the upload finishes, you will see a confirmation message.

Recommended approach for testing Mods in-game

Before making your hard work available for everyone to download, it is crucial to test your mod thoroughly in the real S.T.A.L.K.E.R. 2 game environment.

1. When uploading your mod (either a new mod or an update) to mod.io or the Steam Workshop, utilize the private visibility option. Set the visibility parameter to Private during the upload process. This makes the mod visible and accessible only to you.
2. Subscribe to your own mod via the platform's subscription mechanism.
3. Once subscribed, the mod will be automatically mounted in-game, enabling testing of its features.
4. Play the game and carefully test all the changes and features introduced by your mod. Check for any bugs, conflicts, or performance issues.
5. If, after thorough testing, you are satisfied that your mod is stable and works as intended, you can then return to the mod's page on Steam Workshop or mod.io and change its visibility setting from Private to Public. This makes your mod available for the rest of the S.T.A.L.K.E.R. community to find, subscribe to, and enjoy.

From the initial setup and creation of your project, through the process of modifying the Zone's existing assets and packaging your work into a usable format, to finally sharing and testing your creation – you now possess the foundational knowledge to begin crafting your own unique experiences within the world of S.T.A.L.K.E.R. 2: Heart of Chornobyl. The journey of a modder, much like navigating the anomaly-ridden landscapes, requires patience, careful planning, and attention to detail. Step forth, future creator of the Zone!