Releasing a Mod

From Squad Wiki
Jump to: navigation, search

Requirements[edit | edit source]

You will need the Squad SDK and a properly created Squad Mod as detailed in Creating a Mod.

Pre-Release Checklist[edit | edit source]

Note: The following items are numbered so you can keep track of where you are in this process, and do not necessarily need to be done in the published order.

Maps[edit | edit source]

  1. Ensure all assets required for your map are stored in your Squad\Squad\Plugins\Mods\<mod_name>\Content\ folder. Anything not in this folder will not be shipped!
  2. Make sure your map has a properly created Minimap.
  3. Your map must have the required actors for the gamemode you are targeting.
  4. Check all main base actors to ensure they are set to the correct Team ID.

Packaging[edit | edit source]

Once you have completed the necessary pre-release steps, left click on the "Share Mod" button at the top right of the Squad SDK, then left click on "Package Mod" button. You will be asked for a location to use for the packaging process. Choose a location far away from your mods files, such as Documents\Squad\PackagingMods\<mod_name>\ to avoid issues. EACH MOD MUST HAVE ITS OWN PACKAGING DIRECTORY! DO NOT REUSE DIRECTORIES!

You will receive a notification with the message "Mod being cooked for Window & Linux", which indicates the mod is being packaged. At the bottom right of the notification is a link titled "Show Output Log". Click on it to record any errors that may have occurred during the packaging process.

Successfully packaging a mod will result in the following message in the Output Log: ModdingModCooker:Display: Modding shuffle completed successfully!

Publishing to Steam Workshop[edit | edit source]

First, make sure you are logged into the Steam client on the same computer as your Squad SDK. The user you are logged in as will be the owner of the steam mod. Click on the "Share Mod" button at the top right of the Squad SDK, then left click on the "Upload to Steam Workshop" button.

Modding ChangeLog[edit | edit source]

This is the changelog for your mod. For your first upload, a simple Initial Commit message is appropriate. For future updates, please try to follow the guidelines as listed here.

Once you have clicked "Continue", a progress bar will appear. When you see "Upload Complete.", it is safe to close the "Create Squad Mod" window. The mod will appear under your Workshop Files in Steam.