Basic Submarine Editor Tutorial (kinda outdated)

#1
This tutorial will cover the basics of the submarine editor in Subsurface, and teach you how to make a box that players can breathe in.

When you launch the game, press F3 to open the console and type "edit":
Spoiler
Image
The editor will look like this:
Spoiler
Image
You can zoom in and out with the mousewheel, and move the camera around with WASD.

The first thing you want to do is to open the structures menu and find the walls and platforms. bottomwall looks ugly so you shouldn't use it.
Spoiler
Image
Once you select a structure to add, click and drag from top-left to bottom-right. Dragging in any other way can be confusing.
Spoiler
Image
You should completely seal the map unless you want to add exits.
Spoiler
Image
Once you're done adding walls, ceilings, floors and platforms, you will need to add "hull" objects and "gap" objects. These objects are used by the game to determine where air is, how to distribute water when the ship is flooding, etc.
If you added any platform objects, you should split hulls that the platforms are in and use gaps between each hull:
Spoiler
Image
Now you will need to add waypoints, these are the players' spawnpoints. Each waypoint is for specific jobs, so you have a waypoint for the captain and waypoints for engineers or mechanics.
Make sure you set the waypoint to spawn a Human.
The ID card tag for the captain is "com", and the ID card tag for engineers and mechanics is "eng". The second tag is PX, where X is the player number.
Regalis wrote:Actually you can use whatever ID card tags you want to: when you select a button, you can choose which tags are needed to activate it by switching the "ID Card" text in "required items" to the desired tag or item name (and you should do this if you want the ID Card tags to have any effect). For example, in the default map all the buttons that open the doors to the spawning rooms require the same tag as the ID card tag of the spawnpoint inside the room (P1, P2, P3 etc), meaning that only the player who spawned inside that room has access there, and the buttons at the radar room require the "com" tag.

The required item/tag doesn't even have to be related to ID cards, you could set it to "screwdriver" for example to make it possible to activate the button using a screwdriver.
Spoiler
Image
At this point the map should already be playable, so you should save it. A̶l̶w̶a̶y̶s̶ ̶a̶d̶d̶ ̶a̶ ̶"̶.̶g̶z̶"̶ ̶e̶x̶t̶e̶n̶s̶i̶o̶n̶ ̶t̶o̶ ̶y̶o̶u̶r̶ ̶s̶a̶v̶e̶d̶ ̶m̶a̶p̶s̶.̶ (not needed anymore)
Spoiler
Image
However, there aren't any electrical devices in the submarine, so the players will eventually suffocate. You will need to add these electrical devices, which are located in the Items menu.
The most important items are the Nuclear Reactor, Fuel Rod(s), Junction Box(es), Wires, Oxygen Generator(s) and the Screwdriver. I'll also add some lamps and a ladder.
Spoiler
Image
Now you need to rewire these electrical devices so they actually work. To do this, there is the Character mode.
Spoiler
Image
In character mode, pick up the wires and the screwdriver by pressing E on them. Drag the screwdriver and a wire to your hands.
Spoiler
Image
Press E on the electrical devices to rewire them.
Spoiler
Image
Now, exit Character mode and re-enter it. Any items that were in your inventory will disappear (get rid of the screwdriver this way). Now pick up a fuel rod and put it in the nuclear reactor.
Spoiler
Image
Exit Character mode. Add some vents. You can find the vent in the Items menu.
Spoiler
Image
Click on your oxygen generator. You can tweak some parameters.
Spoiler
Image
While the oxygen generator is selected, hold space and click on your vents. This will link them, distributing oxygen around the submarine.
Spoiler
Image
Once your submarine is finished and ready to be played, you can add a background. Backgrounds are in the Structures menu.
Spoiler
Image
Save the map, restart the game and test it. If everything was done correctly, turning on the Nuclear Reactor will activate your electrical devices.

Here's the tutorial map I made to take images. You can see how the wiring works with it.
I'll write a tutorial on pumps, engines and navigation terminals s̶o̶o̶n̶.
Last edited by juanjp600 on Fri Jan 29, 2016 8:06 pm, edited 6 times in total.

Re: Basic Submarine Editor Tutorial

#2
Nice work, the editor is kind of confusing so I'm sure this will come in handy.
Now you will need to add waypoints, these are the players' spawnpoints. Each waypoint is for specific jobs, so you have a waypoint for the captain and waypoints for engineers or mechanics.
Make sure you set the waypoint to spawn a Human.
The ID card tag for the captain is "com", and the ID card tag for engineers and mechanics is "eng". The second tag is PX, where X is the player number.
Note: you need to deselect everything by clicking on the void before selecting a waypoint, this is likely a bug.
Actually you can use whatever ID card tags you want to: when you select a button, you can choose which tags are needed to activate it by switching the "ID Card" text in "required items" to the desired tag or item name (and you should do this if you want the ID Card tags to have any effect). For example, in the default map all the buttons that open the doors to the spawning rooms require the same tag as the ID card tag of the spawnpoint inside the room (P1, P2, P3 etc), meaning that only the player who spawned inside that room has access there, and the buttons at the radar room require the "com" tag.

The required item/tag doesn't even have to be related to ID cards, you could set it to "screwdriver" for example to make it possible to activate the button using a screwdriver.

Some other notes:
- You can change the color of the wires (or any item actually) by selecting them and changing the value in the color-field. It should be formatted as R,G,B,A where each value is between 0.0 and 1.0
- When you add a door, a gap is automatically added to its position (no need to add one separately)
- Most of the items have a bunch of settings that can be configured when the item is selected, things like the amount of power generated by the reactor or the power consumption of various devices

EDIT:
Oh, and another thing: the collider of the submarine (the one that collides with the level) is currently calculated from the corners of the hulls using the gift wrapping algorithm, so the shape of the sub should be roughly convex. Otherwise there will be spots outside the submarine that collide with the level even though there's nothing there.

Pic related:
Spoiler
Image

Re: Basic Submarine Editor Tutorial

#5
asialsky wrote:How long until we get a proper systems tutorial?
I have a basic ship with wiring identical to the default ship, but the drive on the engine stays stuck at -2.

EDIT: Here's a link to it. (I hid non-important wiring with magic!)
https://www.dropbox.com/s/nbwq1nhawdtzo ... ud.gz?dl=0

fixed

https://www.dropbox.com/s/ikqsdj5qilgcs ... II.gz?dl=0

removed some wires that were causing your junction boxes to overload

dont put a gap over the door to open water in your airlock. it floods the airlock when you start

i like your sub. really nice simple design and the balance between the ballast tanks and overall size makes it easy to dive and surface. all except for using the airlock as a ballast tank too. it'll make it hard to get in and out of the sub without throwing you off balance

Re: Basic Submarine Editor Tutorial

#6
Must have missed it.
My copy of Subsurface isn't entirely safe to edit in because of a failing HDD that keeps corrupting things.
:EXPUNGED:
Anyways, we also need a tutorial for multiplayer.
Noobs may not know how to port forward, or what bugs to expect.
Rule 1) You are expendable.
Rule 2) Asking about Rule 1 will enforce it automatically.