Volcanoids Mods Making Guide

Welcome to the Volcanoids Modding Guide! These steps will teach you how to make your own basic mod using the official Volcanoids Modding SDK, and how to publish it to the Volcanoids Steam Workshop. Let’s get started!

1. Setting up Unity

First of all you have to download the correct version of Unity. Go to: https://unity3d.com/get-unity/download/archive and download Unity version: Unity 2021.1.20. We strongly recommend installing it with Unity Hub. The Unity version the SDK uses can change without notice from any update and the Hub makes dealing with this easy

1.1. Unity Hub Guide:

  1. Click on the green Unity Hub button and open in Unity Hub.
  2. If you have Visual Studio installed, leave it unchecked, otherwise install it.
    • If you already have VS installed, be sure to go into the Visual Studio Installer and make sure the “Visual Studio Tools for Unity” component is installed. (Under “Individual Components”.)
  3. Check Windows Build Support(mono) (On your windows it might not be present, because it is already contained in Unity install.)
  4. Check Linux Build Support(mono)
  5. Click Install and Wait for the installation to complete.

Note: Sometimes Unity can struggle with downloading. If there’s a problem with downloading, try restarting unity or your computer.

1.2. Unity Installer Guide

  1. Run UnityDownloadAssistant
  2. Click next and accept the license
  3. Mark Unity as checked
  4. Mark Windows Build Support(mono) as checked (On your windows it might not be present, because it is already contained in Unity install.)
  5. Mark Linux Build Support(mono) as checked
  6. Click next and specify install folders
  7. Click next and let Unity install

Note: Unity may ask you to install some dependencies during the download like Visual Studio. If you have them installed, you can skip that, otherwise install them. (See 2a just above.)

Everything should be done now.

2. Getting the SDK

In this step we will set up the SDK. You have to have the correct version of Unity installed to make it work properly.

Installing:

  1. Log in to your Steam account that you own Volcanoids on.
  2. Go to your Library and click on GAMES tab and check TOOLS
  3. Find Volcanoids SDK and click Install. Don’t forget to remember the Install Location.
    The default is:
    Steam/steamapps/common/VolcanoidsModSDK

Running:

  1. Open Unity Hub, click the Add button
  2. Navigate to the Volcanoids Mod SDK folder location and select the folder.
  3. Select your Unity version and run the project
  4. Wait for Unity to reimport and you should be running the Volcanoids Mod SDK

You can find more info in the Welcome Screen that will pop up.

3. SDK Structure

Before beginning with mod creation, we will take a look at how the project is organized.

3.1. Project Structure

The Mod SDK Structure project is organized into two important folders:

  1. Asset folder – the folder where all your mods and sample mods will be contained.
  2. Packages – here lays all the references from Volcanoids itself, that you can explore, copy and use as you wish within your mods. You will also reference them when replacing character skin, weapons sounds, etc…

3.2. Mod Folders Structure

In the mod there’s a structure that you have to maintain. You can try to organize things differently, but it may not work. For the best, and tested, results follow this guide’s structure.

Mod structure:

Volcanoids Mods Making Guide
  1. All your mods have to be within the Assets folder. Within, there will be one folder for each mod. (Sample mods do not count)
  2. All your Texts, Materials, Icons, Meshes and .asset files have to be within the Data folder.
  3. All scripts have to be in the Mod folder, doesn’t matter where, but it’s better to avoid the Data folder.

Your Root folder must contain the following files:

  1. Data folder
  2. Mod.asset file – file that connects all your data and scripts together.
  3. When you are using scripts, you have to add an Assembly Definition file.

4a. Creating your first mod

In this section we will create your first mod.

4.1. Mods window

In the mods window you will manage all your mods. If you open the SDK for the first time, the Mods window will already be opened. If the window is not present, navigate to top menu and select:

Window -> Mods.

Volcanoids Mods Making Guide
  1. Mods – You have currently created no mods, they will appear here as you create them.
  2. Create new mod – Button to create a new mod.
  3. Build mods – Button that will build all mods that you have created, and are currently in the project.
  4. Open workshop – This will open the Volcanoids Workshop.
  5. Import – Will import the sample mod of your selection. You can re-use them, or recreate them as you wish.

To create your first mod:

  1. Click: Create new mod . It will bring you to the inspector and create a new mod for you.
  2. Name the folder as you wish and it will highlight the inspector.

Yay! Your first mod is created!

4.2. Creating Ammo for a Revolver Mod

For demonstrational purposes, we will create a new ammo type for the revolver. Follow these steps:

Let’s create a new Ammo Type:

  1. Go to: Packages/VolcanoidsAssets/Game/Items/Ammo
  2. Drag and drop the RevolverAmmo.asset file to your mod Data folder.
  3. Change the name of the file to RevolverSuperAmmo.
  4. Click on the file and set the Name to Revolver Super Ammo, expand it and click the A button next to it.
  5. Expand the description, and write: Super Ultra Exciting Revolver Ammo and click the A button next to it.
  6. The Item Category should be: CategoryAmmo
  7. Drag and drop your ammo Icon file into the Mod/Data folder
  8. Change the item icon in the Icon field by either selecting the circle, or drag and drop icon from the Data folder.

  9. Note : Your icon has to be TextureType: Sprite (Set it on icon and Apply)
  10. Expand Ammo Stats and set it up as you wish
  11. The Projectile Prefab should not be null and should be ProjectileRevolver!
  12. When you are done it should look like this:

Volcanoids Mods Making Guide

Now let’s create a recipe for your ammo:

  1. Go to your mods Data folder
  2. Right click and select Create/Game/Recipe
  3. Name your file RevolverSuperAmmoRecipe and open it.
  4. Expand the inputs field and click the plus. These are items and their amounts that you need to craft your ammo. Select CopperIngot and set the amount to 3.
  5. Expand the Output window and set Item to RevolverSuperAmmo and set the amount to 30
  6. Expand the Categories window and add as many categories as you want. It defines where this item is craftable.
  7. You can also change the production time, this defines how fast your ammo will be crafted in game.
  8. When you are done it should look like this:

Volcanoids Mods Making Guide

4.3. Mod Asset

Volcanoids Mods Making Guide
  1. Workshop Item ID – This is your mod’s ID on Steam
  2. Unique Mod ID – This is your mod ID in the format: CreatorName.ModName (Has to be unique)
  3. Title – Name of the mod, that will be displayed in the workshop, game and in all lists. You can use spaces
  4. Thumbnail – The Icon of your mod that will be uploaded on the Steam Workshop
  5. Load Group – When your mod will be loaded. (Optional)
  6. Load order – The order that mods will be loaded. (Optional)
  7. Version – This is the version number set by you, it is displayed on Steam
  8. Change Note – What has been changed since the last upload. It will be displayed on Steam.
  9. Skip Content Patches – Whether to skip the automatic application of *.patch files after your mod is loaded.
  10. Debug Build – Whether the Mod is debuggable in Visual Studio.
  11. Assembly Definitions – Here you add All Assembly definitions that are inside the Mod folder. You can use multiple definitions for each mod.
  12. Assemblies – If you are using 3rd party assemblies or dlls, add them here.
  13. Other Files – You can attach text files and so on here.
  14. Bundles – All the bundles that your mod uses. They are children of the Mod.asset file.

We will cover the rest in the building and uploading your mod section.

We will cover the rest in building and uploading your mod section.

4b. Scripting

4.4.Assembly Definitions and handling scripts

You will use Assembly Definitions in case you want to add new scripts.

4.4.1. Creating Assembly Definition

If you add the first script and you don’t have an assembly definition, there will be a button to add one in your Mod.asset.

Go to your mod folder and right click on an empty space.

  1. Navigate to Create -> Assembly Definition and click
  2. Name your file. It’s good to name it this way: CreatorName.ModName, since it will be used for scripting.

4.4.2. Setting up Assembly Definition

This will allow you to create scripts next to this definition or in any subfolder. We still recommend not using the Data folder for these definitions and Scripts.

Volcanoids Mods Making Guide
  1. Name – This is the name of the assembly, it’s better to match it with the file name.
  2. Assembly Definition References List – Add all assemblies that you will use within your mod assembly. List of most used Assembly Definitions:
    • Volcanoids – All game scripts
    • Rock.Base – Framework import
    • Rock.Unity – Framework import
    • Unity.Multiplayer.HLAPI.Runtime – good for networking mods.
  3. Platforms – You can specify which platform this assembly will be used. (You can also create Editor scripts for you to help with editing your mod, but for the game leave it as Any Platform)

Everything else about Assembly Definitions can be found in the Official Unity Documentation.

4.5 Scripting Ammo

For making your custom Ammo mod work, you have to create a custom script. The thing is, that you need to add your ammo type into an existing RevolverReloader, because now, the revolver does not know your ammo and cannot use it. Follow these steps:

  1. Create your first script by right click/Create/C# Script and name it RevolverAmmoMod.
  2. Wait for Unity to finish the compilation and double click the file. It will open up Visual Studio. (If not, navigate the top left menu in Unity -> Edit/Preferences/ExternalTools and select External Script Editor as Visual Studio. If you don’t have it, then you have to install it or use other IDE)
  3. Then copy and paste the following code into script:

using System;

using System.Collections;

using System.Collections.Generic;

using System.Linq;

using UnityEngine;

//Sample Ammo Mod

//Works with these Assemblies in you mor AssemblyDefinition: Volcanoids, Rock.Base

//This will create asset, that you can add by right click in your data folder and then Create/Mods/RevolverAmmoAsset

[CreateAssetMenu(menuName = “Mods/RevolverAmmoAsset”)]

public class RevolverAmmoMod : ModCallbackAsset

{

    //This will update existing weapon reloader of your revolver, reference it from Volcanoids game

    public WeaponReloaderAmmoDefinition weaponReloader;

    //This will be your new ammo type

    public AmmoDefinition ammo;

    //This will backup previous ammo, so after you enter another game, it won’t broke

    AmmoDefinition[] backup;

    //This happens on init mod

    public override void Init() {

        //We backup ammunition

        backup = weaponReloader.Ammunition;

        //We register event for reverting changes the mod will make

        ContentPatch.Push(OnRevert);

        //Gets ammunition to list

        List<AmmoDefinition> list = weaponReloader.Ammunition.ToList();

        //Adds new ammo

        list.Add(ammo);

        //Replaces weapon ammunition with old ones with added new one.

        weaponReloader.Ammunition = list.ToArray();

    }

    //Function created by you to revert all changes after you stop the game

    private void OnRevert() {

        //Sets ammunition back to backuped one

        weaponReloader.Ammunition = backup;

    }

}

  1. Wait for it to compile
  2. Navigate to your Data folder and right click follow: Create/Mods/RevolverAmmoAsset
  3. Into RevolverAmmoAsset add reference RevolverReloader from Volcanoids game
  4. Into RevolverAmmoAsset add reference of Your ammo from your mod.

You are done with Custom Ammo Mod.

4.6 Bundles

In Volcanoids, there are 3 types of bundles.

You can create bundles by right clicking on the mod name.

Volcanoids Mods Making Guide

Right click context menu

Volcanoids Mods Making Guide

Hierarchy of MyNewMod.asset

  1. Data Bundle – All data from the data folder or other folders like materials, models, textures, .asset files etc…
  2. Menu Bundle – Contains assets required for modding the main menu, it cannot contain recipes, module prefabs etc…
  3. Scenes Bundle – Contains only scenes, for example when loading scenes additively, or loading scene as main scene.

4.7. Set up everything correctly

To build and upload your mod correctly you have to follow these steps:

  1. Create a mod
  2. Go to the Mod and change the Unique Mod ID to: CreatorName.ModName
  3. Set a Title
  4. Set a thumbnail (The Icon has to be type Texture2D or Sprite and has to be within the mod folder, also better in .png format.)
  5. There has to be default Data bundle set up
  6. If you have scripts, you have to add an Assembly Definition and add it to the AssemblyDefinitions List
  7. Optionally,

5. Building your first mod

So if you have everything setup correctly, you can hit the Build button in the mod file.

Volcanoids Mods Making Guide

Mod building section

Wait for it to complete and take a look in the Console for the errors. If there are none, your mod is successfully built.

Image Description:

  1. Build – Builds the mod
  2. Refresh – Refreshes build data
  3. Open folder – Opens folder with your mod built.

Note: Build time depends on how strong your machine is, as well as how many objects and scripts you have inside. It may take a while, no need to panic. An Empty mod takes about 2 minutes on an average machine.

Volcanoids Mods Making Guide

A successfully built mod should look like this.

Also Inside the building info there should be the contents of your mod and manifest.json

6. Uploading your first mod to the Steam Workshop

Now that you have successfully built your mod, we can move to uploading it to Steam. To make publishing to Steam Workshop work properly, you have to have spent more than $5 on Steam, and you have to have Steam Guard enabled in your Account settings.

Volcanoids Mods Making Guide

Steam Workshop uploading section

  1. Upload – Hit to upload your built mod to the Steam Workshop.
  2. Open in Steam – Opens Steam to your mod page.
  3. Open Webpage – Opens a web browser to your mod page.
  4. Steam Status – Shows Steam’s status. When Ready, Steam is initialized correctly.
  5. Mod owner – Displays who uploaded the mod.
    • Never uploaded – mod has never been on steam workshop.
    • You – you are the owner
    • Unknown – owner is someone else
  6. Upload Status – When uploading it will show status. Firstly preparing and then uploading.

Tada! Your mod is now on Steam!

7. Steam Workshop Mod Settings

In this section we will take a look at settings for your mod. It’s necessary for uploading the mod. Click on the Open in Steam , or Open webpage button in the Inspector with your mod selected to open the Workshop.

Volcanoids Mods Making Guide
  1. Subscribe – Everyone who would like to download your mod and play it, will have to subscribe to the mod.
  2. Edit title & description – Edits the title of the mod and it’s description. Here you can say something about your mod.
  3. Add/edit images & videos – You can add images and videos to your mod to describe it more.
  4. Add/remove Contributors – More players can contribute to the same mod.
  5. Edit Links/Add Links – You can manage your mods social media links
  6. Allow comments – Will enable the comment section for all users.
  7. Delete – Here you can remove your mod
  8. Visibility – A Mod can be:
    • Public – Available to anyone within the workshop
    • Friends-only – Only you and your friends can subscribe and view the mod
    • Hidden – Visible only to you
    • Unlisted – Only people with the link can edit
  9. Public comments – Anyone can comment your mod
  10. Private dev comments – Developers can comment your mod

For More Information, Check out Steam’s Documentation.

8. Testing the mod

So we have built our mod, now let’s test it.

8.1. Testing a local mod

Testing locally without uploading to the workshop is simple. Just follow these steps:

  1. Build your mod (Section: 5. Building your first mod)
  2. Run the Volcanoids game
  3. Click on the Mods Button (1.)
Volcanoids Mods Making Guide
  1. Click the checkbox (1)
  2. Click Apply configuration (2)
Volcanoids Mods Making Guide

After you click Apply Configuration, your game will be force restarted. Then all your selected mods are applied and you can run the game normally.

8.2. Testing through the workshop

Testing with steam is as simple as testing without it. You just need to follow almost the same steps:

  1. Build your mod (Section: 5. Building your first mod)
  2. Upload your mod to Steam
    (Section: 6. Uploading your first mod to the STEAM Workshop)
  3. Run the Volcanoids game
  4. Click on the Mods Button
  5. In the mods folder click the checkbox next to your mod
  6. Click Apply configuration.

(Images are in Section: 8.1. Testing a_local_mod)

9. Updating the mod

Updating your mod is easy. It’s the same process as building and uploading mods. Just a few steps:

  1. Change whatever you want in your mod
  2. Don’t forget to change the version and change note in the Mod Asset.
  3. Build your mod (Section: 5. Building your first mod)
  4. Upload your mod to Steam
    (Section: 6. Uploading your first mod to the STEAM Workshop)

You are done and the mod is updated.

10. Republishing the mod

If you have accidentally or intentionally deleted your mod, don’t worry, you can reupload it. Follow these steps:

  1. Right click on the mod name
  2. Click the Reset workshop id button
  3. Build your mod (Section: 5. Building your first mod)
  4. Upload your mod to Steam
    (Section: 6. Uploading your first mod to the STEAM Workshop)
Volcanoids Mods Making Guide

Reset workshop id button

This is it guys!! I am sure that you will love Volcanoids Mods Making Guide that we have shared with you. We are always open to discussion and suggestions from you. Just let us what you thought about the guide in the comment section.

Also, we would like to thank Captain. He is the one behind this wonderful guide.