Custom maps have finally arrived for Turbo Overkill!

This guide will go over the basics on how to create a basic map.

Tools needed

• Unity 3D, this is used for creating the custom map geometry
  
• Turbo Overkill running under the BETA branch

The current implementation is in very early access, there are a lot of bugs and Quality of Life tweaks still to come, along with additional triggers and props.

This guide is currently incomplete, please check back every now and then for more bits of information. I will make sure this document is updated every time a new feature is added to the editor.

First, create a new project. The name doesn't really matter. The only thing you will need to do is download and install the assets package into your /Assets/ folder.

This package contains a modified version of the popular plugin RealtimeCSG, a tool we use to create the base game maps for Turbo Overkill. The package also contains base textures and materials, and an OBJ Exporter, for getting maps into Turbo Overkill.

You can download the package from our official Discord[t.co] server under the #modding-toolinfo channel...

Once you have downloaded the ZIP, extract its contents into your /Assets/ folder.


There is a sample scene provided where you can start. I recommend checking out some RealtimeCSG tutorials on how to use the tool, as it can be a very in-depth tool.

The version provided in the ZIP has a few modifications from the standard version of RealtimeCSG. There is a texture browser that can be accessed by clicking on the 'Library' button while in Surface mode (and having at least one surface selected). Clicking on Library will take you to the Material Browser, where you can apply materials to your mesh.


Before you export your geometry out, you will need to create a mod directory in Turbo Overkill, explained in the next section...

Make sure your Turbo Overkill is set to the BETA branch, by right clicking and going to Properties > Betas and setting it to the 'beta' branch.


Once you have done this, launch the game and you will see a 'Custom Mods' option in the main menu.

Click it to be taken to the Custom Mods menu, from here, you can either browse user created maps, or open the level editor. Click 'Level Editor'.

Once inside, you will be prompted to create a new project. It will ask you for...

• A name (the directory name in which the file is stored on your local machine),
  
• A nice name, which is used when uploading to Steam Workshop
  
• An author name... this is to be deprecated so it can be ignored for now.
  
• A description, also used for Steam Workshop

It will also ask you for a Template to use. We are going to want to use 'Custom Geo' for now (Flat Map is just a flat ground, but this can get in the way of our custom geo).

Once inside, you will be taken to the editor screen, but you will also have your project directory created. We can now export our OBJ data into this folder.


Once you have created the geo you want to use with RealtimeCSG, you can go to GameObject > Turbo Overkill Modding > Export to OBJ.

A window will pop up with a button asking you to Export Generated Render Meshes. This will find the meshes generated with RealtimeCSG and will export them. Once clicking on the button, a prompt will pop up on where to save. You will need to save the obj file in your mods directory, which can be found at....

C:/User/[yourname]/LocalLow/Trigger Happy Interactive/Turbo Overkill/ModContent/[the name of your mod file]..

You will need to save the obj file in this directory as 'wgeo.obj', otherwise it will not be read from the editor.

It should export without any issue, but if you have trouble getting the OBJ file to write, try turning on Show Meshes in the 'Mesh (advanced)' section of your Realtime CSG model component.

Now if you go back to Turbo Overkill, you can click the File button on the toolbar to open the File menu. In here, there is a button that will allow you to reload your custom geometry, clicking this should load in the OBJ file you exported from Unity into your level!.

Don't worry, you won't have to click this every time, it is only when you want to refresh the editor to the latest geometry.

You can now start placing objects in your level!

This section explains what the separate categories in TurboEd are and what you will need to get your map up and running.



There are several components you need to make your map playable and valid:

• A Player Start
  
• A Purge Switch (otherwise you cannot exit the level)

First things first, go to the Players & Level Info category. You will see a Player Spawn object. Drag and drop this from the toolbar into the level.


Click on the newly placed Player Spawn. You will notice the Inspector window on the right has come to life with some Properties


Each object has a different set of properties. Monster spawners for example have things like Use Teleport Effects or Start Spawned in.

If you want to modify a property, you can simply type in it (or hold click on the Chainsaw icon to the left to scrub it back and forth). Just keep in mind, you will have to hit Enter on the property to register the changes (not when using the scrubber however).

Now go to the Interactive toolbar category.
You will notice a larger selection of items you can drop in here, like doors, jumppads and ladders. We want to drop a Purge Switch into the level. This is an object players can interact with to finish the level.


CTRL+C - Copy properties from a selected object
CTRL+V - Paste properties onto a selected object
SHIFT+D - Duplicate selection to the mouse cursor
SHIFT+R - Toggle relationship lines between triggers

Triggers are one of the main ways a player will interact with a Turbo Overkill map. They can do many things from spawning in monsters, activating force fields to starting music tracks.

The one way triggers will interact with other objects is with the Tag system. Tags are numbers that are used to connect triggers and objects together.

Lets make a trap for our player, when they pick up the Boomer shotgun, we want to spawn in a bunch of enemies for them to fight.

First, goto the Items category and drag a Weapon Boomer into the level.


Now, goto the Triggers category and drag a Trigger Point over the shotgun. You will notice the Trigger volume has a large green box around it. When a player walks into this green box, the trigger volume will activate. You can change the width, height and depth of the volume inside the Inspector panel.

While in the inspector panel for the Trigger Point, we're going to want to set its tag to a number. Lets set it to 1 for now. You will need to press ENTER once entering a value for it to save on the selected object.

You will notice, nothing has happened... yet.

Now goto the Monsters category and drop down a Techno Junkie. By default, he will start spawned in when we hit play. but we want him to spawn in when we hit the trigger. Inside the Inspector, set his 'Start Spawned' property off. Also tick 'Spawn Teleport FX', this will give him a blue ring effect when appearing.


Now, set his 'Tag' property to 1. You should now notice a line going from the Trigger Point to the Techno Junkie.


Now, we want some more junkies. If you select the Techno Junkie and press Left-Shift + D, it will duplicate the junkie to the position our mouse is hovering over. What's handy, is it will copy all the properties we just set on the Techno Junkie!

Once you are happy with your map, you can upload it to Steam Workshop via the File menu.
Make sure you save your map and have a thumbnail snapshotted before you do so.

If you like, you can also manually edit the thumbnail with an external photo editor. Also, if you have a loadingscreen.png file provided in your mods content folder, it will use that when loading a level.

Once you have published your map, in a few minutes it will appear in the map browser that can be accessed via the main menu. It will also appear on Steam Workshop.

Keep in mind, your local working files are located under AppData/LocalLow. Downloaded mods are saved under the steamapps/workshop folder.

The top two text fields allow you to change the mods name and description. You must press ENTER for changes to become valid. There is also a thumbnail preview of what will be uploaded to Steam Workshop when you publish.


Check out the Triggers section for more info on these

Place one of these bad boys down and set its TAG to be the same as a nearby Trigger Point to start cranking out some tunes.

This is used to place monsters in the level. There are several properties that can be set on monsters. By default, they will spawn in automatically, but you can set them to only spawn in from a trigger.

Drops items, weapons and ammo into the level.

Check out the Triggers section for more info on these


A category with assorted props that can be used to make the level prettier.

A handy tab that displays all the current editor shortcuts

Takes a screenshot from the cameras current position for the Steam Workshop thumbnail

Hides/Reveals the inspector

Saves the level and starts a playtest of it