Difference between revisions of "IntruderMM"

From Superboss Games Wiki
Jump to navigation Jump to search
(Added mention of the step-by-step video)
 
(38 intermediate revisions by 8 users not shown)
Line 1: Line 1:
== Overview ==
+
= Overview =
 +
The [[Intruder]] Map Maker (or [[IntruderMM]]) is used to create [[custom maps]] for [[Intruder]] through Unity3D. These custom maps can then be uploaded to the steam workshop to be shared amongst users. Included in the IntruderMM package is a large array of [[Template:IntruderMM Assets |tools and prefabs]] which allow users to customize the layout and gameplay mechanics of their map.
 +
<!--The following link is redundant, as all information present there is also on this page with more information.-->
 +
<!--:*A page for how to set up [[IntruderMM]], including tools, props, and textures to help with creating a map: [https://sharklootgilt.superbossgames.com/wiki/index.php?title=Mapmaker_resources Intruder Map Maker Resources]-->
  
The [[Intruder]] Map Maker (or [[IntruderMM]]) is used to create [[custom maps]] for [[Intruder]] through Unity3D.
+
= Creating a Map =
 +
In order to begin creating a custom map, users will need two items:
  
:*A page for how to set up [[IntruderMM]], includes tools, props, and textures to help with creating a map: [https://docs.google.com/document/d/10Qvao_pA-lM8IFASWaAr6AGlNYG28CJaLqyOd5aUrss/edit#heading=h.cydappkra2sr Intruder Map Maker Resources]
+
1. Unity {{IntruderMMUnityVersion}} via Unity Hub'''
 +
::*'''Unity Hub Download''': https://unity3d.com/get-unity/download
 +
::*You '''MUST''' install version {{IntruderMMUnityVersion}} or earlier or you will not be able to launch your map
 +
::*If it is not listed in the Unity Hub application, you can find {{IntruderMMUnityVersion}} in the Unity Download Archive: https://unity.com/releases/editor/archive
 +
::**You '''MUST''' make sure to install both Windows and Mac build platforms!
  
== What you'll need ==
+
2. Intruder MM Unity package {{IntruderMMVersion}}
 +
:::*'''Google Drive Download''': https://drive.google.com/drive/folders/0B8N1PnL3QcxtWW85eXhtWFFmWWM?resourcekey=0-vllq8UVBE4IYOaqBx4W5_w
 +
:::*Intruder MM {{IntruderMMVersion}} is '''NECESSARY''' for Steam Workshop version and Unity {{IntruderMMUnityVersion}}
  
:'''Unity 2020.3.15f2 via Unity Hub'''
+
== Getting Started ==
:::*'''Windows Download''': unity3d.com/get-unity/download
 
:'''You MUST make sure to install both Windows and Mac build platforms!!
 
  
Intruder MM Unity package 2.067 '''NEEDED''' for Steam Workshop version and above
+
There's a step-by-step video guide that guides you through the installation process that you can watch [https://www.youtube.com/watch?v=hJit2Nw1ynQ here].
  
:*'''Download''': https://drive.google.com/embeddedfolderview?id=0B8N1PnL3QcxtWW85eXhtWFFmWWM#list
+
=== Unity Installation ===
  
== Installation ==
+
:To begin, install [https://unity3d.com/get-unity/download Unity Hub] to your computer. After the installation is complete, open Unity Hub and click "Add" from the installs section. Choose Unity {{IntruderMMUnityVersion}} from the list to begin the installation process. If the version is not listed, you are able access it on the [https://unity.com/releases/editor/archive Unity Archives] webpage.
 +
::'''Note:''' Make sure to install both Windows and Mac builds! These options are available after starting the installation process. A window will appear allowing you to select installation packages; ensure that Windows and Mac builds are selected before proceeding!
  
=== Step 1 ===
+
=== Importing IntruderMM ===
  
:Install the Unity Hub from the link above
+
:After installing the correct Unity version, start a new project. Make sure the path to the project has no spaces in it, (e.g. C:/UnityProjects/MyMap instead of C:/My Documents/Intruder Map) or else you won't be able to export and test or upload the map. Now, import the IntruderMM Unity package to your opened project. This will set you up with everything you need to start making your level. Just double click the package when you have your project open and it will begin importing it into your project directory. Alternatively, you can use the dropdown on the top toolbar to import it (Assets->Import Package->Custom Package).
  
=== Step 2 ===
+
=== Creating Your Map ===
  
:Open Unity Hub, and click "add" from the installs section. Choose Unity 2020.3.15f2 from the list, or whatever the most recent version of Unity 2020 is available.
+
:Now that the package is imported, you are able to start making your level! Make sure to grab a [[SpawnA]] and [[SpawnB]] from the IntruderMM Prefabs folder and place them in your level to choose where your guards and intruders will spawn. The prefabs folder is full of great things to get your levels started such as [[doors]], windows, [[GoalPointProxy|goal points]], [[briefcase|briefcases]], and more.
 +
::To add doors, you'll need to download the Superboss Doors package, which can be found in the same [https://drive.google.com/drive/folders/0B8N1PnL3QcxtWW85eXhtWFFmWWM?resourcekey=0-vllq8UVBE4IYOaqBx4W5_w google drive] as the MM package. The package is imported the same as the MM package, and once you have it in your project you can place the prefabs in your level wherever you need them.
 +
:Because we are using Unity as the editor, you have control over all of its level editing power. This means that you are able to use any tool or resource available to you, aside from creating custom scripts. Despite this, you are able to access [[Activator|Activators]] which can be used to create complicated map mechanics, such as teleporters, timed spawns, traps, and more.
  
::'''Make sure to install both Windows and Mac builds!'''.
+
=== Playtesting ===
  
=== Step 3 ===
+
:As you are creating your level, you are able to playtest the map in-game to get a feel for how players will use it. To test your map, you can either use the Intruder menu at the top toolbar, or by pressing the "Test Map" button at the bottom right of the view-finder. If it is the first time you are testing the map, Unity will ask you to locate your copy of Intruder.exe or Intruder.App. After you select the file (where Steam stores the Intruder app), it will launch the level inside of Intruder so you can test it out offline!
  
:Open Unity. Start a new project and make sure the path to the project has no spaces in it, (e.g. C:/UnityProjects/MyMap instead of C:/My Documents/Intruder Map) or else you won't be able to export and test or upload the map.
+
=== Uploading your map ===
  
=== Step 4 ===
+
:Once you are satisfied with your map or would like to test it with others, you may upload it to the steam workshop for anyone to download. Open the "Intruder" tab in the top toolbar and press "Map Upload" to open the options window to begin the upload process. If it's the first time uploading the map, leave the Workshop ID blank. Otherwise, you can grab the Workshop ID from the URL of the map you want to Update.
 
 
:Now import the IntruderMM Unity package. This will set you up with everything you need to start making your level. Just double click the package when you have your project open or alternatively you can use the dropdown on the top bar to import it. (Assets->Import Package->Custom Package)
 
 
 
=== Step 5 ===
 
 
 
:Start making your level! Make sure to grab a [[SpawnA]] and [[SpawnB]] from the Prefabs folder and place them in your level to choose where your guards and intruders will spawn. The prefabs folder is full a great things to get your levels started such as [[doors]], windows, [[GoalPointProxy|goal points]], [[briefcase|briefcases]], etc.
 
 
 
To add doors, you'll need to download the Superboss Doors package, which can be found in the same google drive as the MM package. The package is imported the same as the MM package, and once you have it in your project you can place the prefabs in your level wherever you need them.
 
 
 
:Because we are using Unity as the editor, you have control over all of its level editing power, so please check out tutorials over the web if there’s anything you want to try.
 
 
 
=== Step 6 ===
 
 
 
:Test your level. Use the Intruder menu at the top for different options.
 
:Intruder->Play Scene in Intruder. The first time it will ask you to find your copy of Intruder.exe or Intruder.App. After you find that (where Steam stores the Intruder app) it will launch the level inside of Intruder so you can test it out offline!
 
 
 
=== Step 7 ===
 
 
 
:Upload and play your levels with others!
 
:Intruder->Map Upload will allow you to upload your map and set tags. If it's the first time uploading the map, leave the Workshop ID blank. Otherwise, you can grab the Workshop ID from the URL of the map you want to Update.
 
  
 
== Rules ==
 
== Rules ==
Line 62: Line 53:
  
 
= Resources =
 
= Resources =
== Official Resources ==
+
For a detailed list please see the [[Mapmaker_resources|Mapmaker Resources page]].
Superboss Games have provided the map-making community with a bunch of assets that greatly aid with the development of maps.
 
{| class="wikitable"
 
! colspan="1" | Name
 
! colspan="1" | Usage
 
! colspan="1" | Download
 
|-
 
|Player Models
 
|The player models are useful to get the right proportion and height of your maps, resulting in a better looking and feeling map. I would recommend downloading the player skins package is well to put materials on the player model in unity and to make sure the player models don't get in the way of players in-game, make sure to use the EditorOnly tag on them.
 
|[https://drive.google.com/file/d/0B8N1PnL3QcxtOVY3N09FdjUxRDQ/view?usp=sharing Download]
 
|-
 
|Door Package
 
|The Door Package allows map makers to use the doors found in the official maps.
 
|[https://drive.google.com/file/d/1vmPGZbNuDNXvNTN1Vq42h2M8f7MVLC20/view Download]
 
|}
 
 
 
 
 
== Community Resources ==
 
 
 
The community has made many props and prefabs that are free to share and reuse in your own maps. Some are [[Mapmaker resources|listed here]].
 
 
 
== Unity Plugins ==
 
These plugins can greatly improve your workflow for level design, shader development, and lighting! Make sure to put these in a folder named Plugins from the root directory of the assets folder or else they will highly likely not work.
 
 
 
{| class="wikitable"
 
! colspan="1" | Name
 
! colspan="1" | Price
 
! colspan="1" | Type
 
! colspan="1" | Description
 
! colspan="1" | Links
 
|-
 
| SabreCSG
 
| Free
 
| Level Design
 
| Most popular Level Editing Plugin in the community, due to it being free, open-source and easy to use. SabreCSG allows users to make maps using brush geometry similar to editors such as Source SDK Hammer. SabreCSG is included in the MapMaker package, so you don't need to download or import any other version.
 
|
 
 
 
|-
 
| RealtimeCSG
 
| Free
 
| Level Design
 
| RealtimeCSG is the Realtime equivalent of SabreCSG only less accurate and doesn't break all the time. It's a bit tricky to install, you have to extract all the contents then only grab the RealtimeCSG/Assets/Plugins/RealtimeCSG folder then drag that into the Plugins folder you made before to install plugins. RealtimeCSG allows users to make maps using brush geometry similar to editors such as Source SDK Hammer in Realtime.
 
| [https://github.com/LogicalError/realtime-CSG-for-unity Download]
 
[https://https://www.realtimecsg.com/ Website]
 
 
 
[https://discord.gg/BK5gt8R Discord]
 
|-
 
| Bakery
 
| Paid
 
| Lightmapping
 
| Bakery is a lightmapping plugin that allows the utilization of the GPU. This plugin requires a modern Nvidia GPU (6xx or newer) and 64-bit Windows (7 or higher).
 
| [https://assetstore.unity.com/packages/tools/level-design/bakery-gpu-lightmapper-122218 Asset Store]
 
[https://geom.io/bakery/wiki/index.php?title=Bakery_-_GPU_Lightmapper Wiki]
 
|}
 
  
 
== Help Links ==
 
== Help Links ==
[https://superbossgames.com/forum/viewtopic.php?f=14&t=2030 Official Forum Thread]
+
[https://discordapp.com/invite/superbossgames The Discord Server has a dedicated MapMaking channel where you can make any question you want about how to make your first map]
  
[https://discordapp.com/invite/superbossgames Discord Server]
+
{{Template:IntruderMM Assets}}
  
 
[[Category: Intruder]]
 
[[Category: Intruder]]
 
[[Category: IntruderMM]]
 
[[Category: IntruderMM]]

Latest revision as of 01:41, 15 March 2025

Overview

The Intruder Map Maker (or IntruderMM) is used to create custom maps for Intruder through Unity3D. These custom maps can then be uploaded to the steam workshop to be shared amongst users. Included in the IntruderMM package is a large array of tools and prefabs which allow users to customize the layout and gameplay mechanics of their map.

Creating a Map

In order to begin creating a custom map, users will need two items:

1. Unity 2020.3.48f1 via Unity Hub

2. Intruder MM Unity package 2.22

Getting Started

There's a step-by-step video guide that guides you through the installation process that you can watch here.

Unity Installation

To begin, install Unity Hub to your computer. After the installation is complete, open Unity Hub and click "Add" from the installs section. Choose Unity 2020.3.48f1 from the list to begin the installation process. If the version is not listed, you are able access it on the Unity Archives webpage.
Note: Make sure to install both Windows and Mac builds! These options are available after starting the installation process. A window will appear allowing you to select installation packages; ensure that Windows and Mac builds are selected before proceeding!

Importing IntruderMM

After installing the correct Unity version, start a new project. Make sure the path to the project has no spaces in it, (e.g. C:/UnityProjects/MyMap instead of C:/My Documents/Intruder Map) or else you won't be able to export and test or upload the map. Now, import the IntruderMM Unity package to your opened project. This will set you up with everything you need to start making your level. Just double click the package when you have your project open and it will begin importing it into your project directory. Alternatively, you can use the dropdown on the top toolbar to import it (Assets->Import Package->Custom Package).

Creating Your Map

Now that the package is imported, you are able to start making your level! Make sure to grab a SpawnA and SpawnB from the IntruderMM Prefabs folder and place them in your level to choose where your guards and intruders will spawn. The prefabs folder is full of great things to get your levels started such as doors, windows, goal points, briefcases, and more.
To add doors, you'll need to download the Superboss Doors package, which can be found in the same google drive as the MM package. The package is imported the same as the MM package, and once you have it in your project you can place the prefabs in your level wherever you need them.
Because we are using Unity as the editor, you have control over all of its level editing power. This means that you are able to use any tool or resource available to you, aside from creating custom scripts. Despite this, you are able to access Activators which can be used to create complicated map mechanics, such as teleporters, timed spawns, traps, and more.

Playtesting

As you are creating your level, you are able to playtest the map in-game to get a feel for how players will use it. To test your map, you can either use the Intruder menu at the top toolbar, or by pressing the "Test Map" button at the bottom right of the view-finder. If it is the first time you are testing the map, Unity will ask you to locate your copy of Intruder.exe or Intruder.App. After you select the file (where Steam stores the Intruder app), it will launch the level inside of Intruder so you can test it out offline!

Uploading your map

Once you are satisfied with your map or would like to test it with others, you may upload it to the steam workshop for anyone to download. Open the "Intruder" tab in the top toolbar and press "Map Upload" to open the options window to begin the upload process. If it's the first time uploading the map, leave the Workshop ID blank. Otherwise, you can grab the Workshop ID from the URL of the map you want to Update.

Rules

Levels with offensive or copyrighted material may be removed from the Workshop level list at the discretion of Superboss Games. If you frequently upload material which is unsuitable, your account may be cut off from ever uploading levels again.

More

Make sure to join the Discord Server for more help using the IntruderMM: https://discordapp.com/invite/superbossgames

Resources

For a detailed list please see the Mapmaker Resources page.

Help Links

The Discord Server has a dedicated MapMaking channel where you can make any question you want about how to make your first map

IntruderMM Assets
Items Name
Prefabs BriefcaseProxy - CustomDoorProxy - DoorProxy - EquipmentManager - GlassProxy - GoalPointProxy - Keypad - Ladder - LockedObject - MortarProxy - Mover Parent - NoteProxy - ObserveCamProxy - Pickup - RandomGunPickup - RandomItemPickup - SecuritySetup - SlidingDoor - SpawnA - SpawnB - WaterLevel - WindProxy - ZipLine - Limits
Scripts ActivateActivator - Activator - AdvancedMaterial - AnimateColor - BriefcaseProxy (Script) - CustomDoorProxy - CustomLevelSettings - CustomMapSkins - DestructibleProxy - DoorProxy - EquipmentManager - GlassProxy - GoalPointProxy - GravityProxy - HackModeProxy - HideOnStart - IgnoreSticky - KeypadProxy - LayerProxy - LockedObject - MaterialManager - MortarProxy - Mover - NoteProxy - ObjectiveTabSettings - ObjectTagger - ObserveCamProxy - PickupProxy - PlayAudio - ReplaceAll - ResetProxy - ScrollingUVs - SecurityRoom - SecurityScreen - SetTagsAndLayers - SoundSettings - TimedObjectDestroyer - TuningProxy - WindProxy - World Screen Object - ZiplineProxy
Level/Maps Target - SniperRange - Demo