Редактирование: Участник:SpaceSmithers/guide sandbox

{{Under construction
|reason = This is a sandbox to make incremental edits to incorporate [[User:San7890|san7890's]] improved guide to mapping. Absolutely everything is subject to change, and I encourage you to overwrite literally anything. Editors note: standardize linking all headers to the respective HackMD headers so that readers absolutely can not miss it.
}}
Other related guides: [[Understanding SS13 code]], [[SS13 for experienced programmers]], [[Guide to door access]] and [[Map Merger]]

{{Important
|Title=Read this!
|Note=This page is mostly port of <big>'''[https://hackmd.io/@tgstation/SyVma0dS5 san7890's A-Z Guide to Mapping]'''</big>, a HackMD document that details the mapping essentials. It is recommended that you read that document '''first''' as it is well organized, updated, and contains very useful visuals that this page may lack. If you are an experienced mapper, <big>'''[https://hackmd.io/@tgstation/ry4-gbKH5 san7890's Mapping Reference Collection]'''</big> may be more useful to you.
|Image=Notice.png
|Color=Blue
}}
{{Speech|image=[[File:Bigchungus.png|64px|right]]|name=Big Chungus|text=Nyehehehehe I'm Big Chungus (big chungus voice). I just went through some stuff and left some comments. If you want something nice to write about the Guide to Mapping (and the Mapping Reference Collection) in those above chat bubbles, I like Goonstation ZeWaka's Prompt (inspired probably by san7890's own words), which can be found here: https://hackmd.io/@goonstation/maps#Goonstation-Mapping-Guide .}}

=[https://hackmd.io/@tgstation/SyVma0dS5#Ingredients Getting Set Up]=
Setting up before doing anything is crucial to having a smooth and painless mapping experience.
== Mapper's Checklist ==
Listed below is the software we'll be using:
*[https://git-scm.com/download/win '''Git''' (Windows)]
*[https://desktop.github.com/ '''Github Desktop'''] (and a '''GitHub Account''')
**You may substitute this for any Git client that you know how to use already (Bash or GitKraken). If you do not know how to use any Git client, Github Desktop remains a perfectly acceptable client for mapping changes, and I will be using it throughout this guide.
*[https://github.com/SpaiR/StrongDMM/releases '''StrongDMM Map Editor'''] (available for Windows, Linux, and MacOS)
**If you prefer to use a web-based utility, you may use [https://github.com/monster860/FastDMM2 FastDMM2]. Never, ever use Dream Maker to map. You will only harm yourself.
*[https://code.visualstudio.com/ '''Visual Studio Code'''] with the [https://marketplace.visualstudio.com/items?itemName=Goonstation.goonstation-extpack '''Goonstation Extension Pack''']
**This is recommended because you will need to test your mapping changes! In the words of MMMiracles (creator of [[CereStation|Cere]], [[Donutstation|Donut]], and [[Tramstation|Tram]]): “Knowing how to code greatly expands your mapping horizons.” You will not need to know how to code in order to map but having this set up at the very start will greatly assist your future endeavors!
**We use the Goonstation Extension Pack for easy interaction with BYOND’s Dream Maker code, it is a must-have. Don’t fret the name (because /tg/ coders made most of the stuff anyways haha).
*'''[https://www.python.org/downloads/ Python]'''
**This is needed for Git Hooks, which are important in your mapping endeavors.
*'''Love'''

It is ''imperative'' that you use the [[Map Merger]] tools before committing any changes to a map. See [[Map_Merger|here]] for how. Some modern programs do similar functions to what Map Merger does, but running this and getting your Git Hooks set up save you a lot of headache.
==[https://hackmd.io/@tgstation/SyVma0dS5#Gitting-Set-Up Forking the Repository]==
Firstly, you need a fork. A fork will be your very own copy of our repository, free do with as you wish! Just hit the "Fork" button on https://github.com/tgstation/tgstation. Feel free to be creative with the name of your fork. {{Tooltip2|[https://tgstation13.org/wiki/images/7/7f/Mappingguide_branch.png Displayed should be "(GitHub username)/(name of fork), forked from tgstation/tgstation",]|It should look something like this: [[file:Mappingguide_branch.png]]}}. 

Within your fork, you'll want to click {{Tooltip2|[https://tgstation13.org/wiki/images/d/d6/Mappingguide_opengitdesktop.png the "Code" button, then click "Open with GitHub Desktop"]|[[File:Mappingguide_opengitdesktop.png]]}} (assuming you've downloaded it) under the dropdown. A prompt from the application will open; find a clean folder to locally copy your repository and click Clone. This may take a few minutes. Another prompt will appear asking: "How are you planning to use this fork?" You will want to select "To contribute to the parent project". This will make creating [[#Pull Requests|Pull Requests]] easier.
===Branching the Fork===
[[File:Gitdesktop1.png|right|thumb|GitHub Desktop should look something like this]]
The final part to setting up GitHub is to make a new branch. '''This part is super-duper important''', because you want to keep your “master” branch on your fork as clean as possible, since it’s a pain to clean out and send pull requests to.<br>
To do this, {{Tooltip2|[https://tgstation13.org/wiki/images/5/5b/Mappingguide_newbranch.png click on the Current branch (which defaults to "master") and click on the "New branch" button next to the filter bar]|[[File:Mappingguide_newbranch.png]]}}. For every individual project you work on and submit a Pull Request for, you want to be on a brand new branch. Feel free to name it whatever you want, can be as goofy or as organizational as you want. It’s your fork, after all.<br>
:You may also get a screen that says “base it off the current branch” or “base it off the upstream/master”. That depends on what you want, but if you want to start fresh on a new project, always hit “base it off the upstream/master”.
=Mapping: [https://hackmd.io/@tgstation/SyVma0dS5#StrongDMM-and-You-The-Basics San7890's Guide to StrongDMM]=
===Preamble===
In the time of Metacide, the creator of MetaStation and the last person to make a [https://tgstation13.org/wiki/index.php?title=Guide_to_mapping&oldid=37972 "Guide to Mapping"], all that you had was Dream Maker's program. Dream Maker sucks though, and we have better tools. While all of the content you see on the rest of this page and elsewhere may be lifted straight from DreamMaker, this will serve as a small "pointer" to where you can find that same functionality in StrongDMM. Everything you can do in Dream Maker, you can do about 100 times better in StrongDMM. If you've managed to grasp the bare essentials of even playing Space Station 13, then I have no doubt that getting acclimated to StrongDMM will probably be a walk-in-the-park. However, BYOND hasn't changed in how it parses maps, so that will all hold steadfast and true.

At the time of me writing this guide, StrongDMM is currently in an “alpha state” (Versions 2.0.0 and up). I will be using the alpha version since it’s the path the program is going to take in the future, but if you’re hesitant about an alpha version, feel free to downgrade to Version 1.9.1 (it has a few features 2.0.0 is missing). You can actually run both concurrently, too! Regardless, let’s start mapping!

===Starting StrongDMM===
Go into "File" in the top-right of your screen and hit “Open Environment”. The “environment” is how StrongDMM is able to find, collect, and parse the atoms that make up every part of every map. This is an important step, and make sure you always use the .DME (Dream Maker Environment) file on your repository to keep things as straightforward as possible. Just get tgstation.dme.

{|
|[[File:MetaStation in StrongDMM.jpg|left|frame|Your map in StrongDMM]]
|Then, go back into "File" and hit "Open Map". You'll want to go into the ``_maps`` directory of your repository, and then find any map you like. I'll be using MetaStation.dmm for the purposes of this guide. Once StrongDMM loads the map of your choosing, you can use Middle-Click and the Scroll Wheel to find your way around. Soon, you should get something that looks like this:
|}

[[File:strongdmm_hide.png|frame|right|Layers and their keybinds to toggle them]]
Beautiful! Let’s talk about those colors. Those are [https://www.byond.com/docs/ref/#/area areas] which are important for the game to understand what discrete location is what, and we use it for several things code-side. For example, the [[bridge]] is a different area than the [[bar]], so you want to make sure everything is defined appropriately. They tend to be a bit distracting through, so you can hit {{Key|Ctrl}}+{{Key|1}} to get rid of those. Do make sure you define them properly when you’re done, though.

Areas are one of four different, distinct “layers” we use in BYOND. The other three are [https://www.byond.com/docs/ref/#/turf turfs], [https://www.byond.com/docs/ref/#/obj objs] (for Objects), and [https://www.byond.com/docs/ref/#/mob mob] (for creatures/animals/what-have-you). Their progenitor species is the [https://www.byond.com/docs/ref/#/atom atom]. You can go into the options tab or hit the respective keybind to quickly filter for those.
<br clear=all>
----
===Editing===
{|
|[[File:Sdmm_tools.png|left|frame]]
|These are your tools to edit with. From left to right, they are:
* Add ({{Key|1}})
* Fill ({{Key|2}})
* Grab ({{Key|3}})
* Pick (Hold {{Key|S}})
* Delete (Hold {{Key|D}})
* Replace (Hold {{Key|R}})
They each do their own thing, and you can hover over them in the program to see what you might want to use. Feel free to get a feel with the tools by toying around with stuff, and eventually getting to work on your own maps as you desire.
|}
===Testing Your Map===
[[File:Githubdesktop_externaleditor.png|right|400px|thumb|The “Open in Visual Studio Code” button. Click the image to expand.]]
You should always test your code, test your maps, test your sprites, test everything whenever it’s a non-trivial amount of work. There’s an incredibly simple way to do this, which I’ll reveal to you now:

The easiest/fastest way to do this is to go into Github Desktop and find the button that reads “Open in Visual Studio Code”. If it doesn’t, [https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor set your default editor] to Visual Studio Code.

Once inside Visual Studio Code, you'll want to hit {{Key|Ctrl}}+{{Key|F5}}, or just {{Key|F5}}. This will start [https://github.com/tgstation/tgstation/blob/master/tools/build/README.md compiling your code], which shouldn’t take more than a few minutes. Once done, it’ll boot up BYOND’s Dream Seeker, connect you to the [https://github.com/tgstation/tgstation/blob/master/.github/guides/RUNNING_A_SERVER.md#installation local server], and automatically give you the highest permissions. This is because you’re doing everything in the debugging mode, which is quite nifty. This is arguably the simplest way to do it.

Once Space Station 13 has started, the Server tab located in the Stat-Panel will be a big help. From there, you can change maps and also skip the post-initialization wait time by clicking Start Now (or just type <code>Start-Now</code> in the command bar). Observe as a ghost and view your changes. Compiling is a good way to view the more subtle nuances that you weren’t able to pick up on through the editor. This includes (but is certainly not limited to): lighting, door accesses, mob interactions, and just figuring out if it looks good.
----
Simply follow these steps and you should be able to catch most errors mapping brings. The [https://hackmd.io/@tgstation/ry4-gbKH5#Pre-Commit-Checklist Pre-Commit Checklist], also provided in a dropdown below, best applies to outright Station Mapping and may not be applicable to ruins/away missions/shuttles/etc., but it’s still quite good to check as much as you can rather than assume that it works.

<div style="text-align: left; max-width: 95%">{{#tag:tab|
*Are floors with or without air, as they should be? (regular or airless)
**You can test this one out by looking for Active Turfs.
*Does the area have an APC?
*Does the area have an Air Alarm?
*Does the area have a Request Console?
**Not every area needs this, look at other stations.
*Does the area have lights?
**When you compile your map for testing, make sure the lighting is adequate. You don’t want any unwarranted “dark” spots in your rooms. If you’re going for “warm” or “cold” lighting, make sure it all matches.
*Does the area have a light switch?
*Does the area have enough security cameras? (Use the Debug Verbs for help)
*Does the area have enough intercoms? (The verb Intercom Range Display in the Mapping Debug Verbs helps with this.)
*Are all the vents in this area connected to the vent air loop (distro)?
*Are all the scrubber in this area connected to the scrubber air loop (waste)?
*Is everything wired properly?
*Does the area have a fire alarm and firelocks?
**Typically, doors leading into maintenance do not need firelocks. Do not place firelocks on doors facing the exterior of the station (like space or the planet).
*Do all airlocks work properly?
*Are accesses set properly on doors, buttons, etc?
**For typical airlocks, you can use the Airlock Mapping Helpers. Otherwise, consult the reference for Door Accesses.
*Are all items placed properly?
**In summary, are your objects all on tables as needed? Are tables or other objects obscuring your vents/scrubbers?
*Does the disposal system work properly from all the disposal units in this room as well as the pipes of which pass through this room?
**Just throw yourself through a few disposals systems that seem to pass through the area you touched. Easy to forget.
*Check for any misplaced or stacked piece of pipe.
**/tg/station also lints for this to catch you if you forget.
*Check for any misplaced or stacked piece of wire.
**/tg/station also lints for this to catch you if you forget.
*Identify how hard it is to break into the area and where the weak points are, and balance the area accordingly.
**For example, the Vault should be made of reinforced structures and electrified windows, the Kitchen should not. Be reasonable, not everything has to be an overly-secure structure to prevent the “tide” or other events. You will be vetted on this, just make your best choice.
*Check if the area has too much empty space.
**You don’t want vast, bald spots in your rooms that serve little purpose. Fill it up with stuff if you can, or just trim the fat entirely. Whatever works best for the station and your design.
*Are there any indestructible turfs where they shouldn’t be? |dropdown|collapsed=true|closename=Click to retract Map Testing Checklist|openname=Click to expand Map Testing Checklist}}</div>

{{Speech
|name=SpaceSmithers
|text=hell yeah this is awesome. usually i HATE the tabs extension.
|image=[[File:Spell.png|64px|right]]
}}

*In the Stat-Panel (mentioned previously), go into the <code>Debug</code> Tab. Now, select the <code>Mapping Verbs - Enable</code> verb.
*You should now have the <code>Mapping</code> Tab.
*Check for errors for cameras, power cables, and atmos pipes.
*Powersink the station and ghost around to check for unconnected powernets (APCs that aren’t discharging/charging).
*Ride disposals from start to finish to check for broken disposals.
*Make yourself an AI and check for blindspots in camera networks. You can also use the Camera Range Display Verb.
*Spawn yourself in (check [https://hackmd.io/@tgstation/SyVma0dS5#Debugging-Hottips Debugging Hottips])

Fix your errors, and run through this list again to double check, because chances are you missed something or you broke something else. That’s just how it is.
Doing so will save everyone a lot of headaches down the line. Specifically, yours, because you will have to fix your own shit.
----
In mapping, there are a lot of errors that may come up during [http://www.byond.com/forum/post/2012623 Initialization of the world]. However, we do check for a lot of these errors. Here’s how you can check these out and get them ironed out before we have to catch it for you.

Assuming your world is already compiled, wait for Initialization to finish, and then type in this verb into your chat box <code>Get-Current-Logs</code>. You should see a pop-up with a whole list of logs. You just want to go down this list and select the option that says <code>map_errors.log</code>. Go ahead and either “View” or “Download” this log file (“Open” doesn’t typically work for me).

We also now do this check for you on every pull request for ''station'' maps through our GitHub [https://en.wikipedia.org/wiki/Continuous_integration Continuous Integration] process. I would advise checking this for non-station maps, though.

===Committing and Pulling===
Return to GitHub and you'll see your modifications to the [https://hackmd.io/@tgstation/ry4-gbKH5#Map-Keys-no-holds-barred Map Keys] in the line changes. In the bottom-left corner, you'll see the commit menu. [https://github.com/tgstation/tgstation/blob/master/.github/CONTRIBUTING.md#pull-request-process Maintainers at /tg/ really do appreciate if you write out a thoughtful commit title and description, because you will need to justify your changes in one way or another when you submit it for review through the Pull Request Process!]
====Committing your changes====
[[File:Mappingguide_commitbox.png|thumb|An example of a good commit title and message.]]
Once you've written the constructive title and brief description, hit "'''[https://git-scm.com/docs/git-commit Commit] to (your branch name here)'''”. If it says “Commit to Master/Main”, don’t hit that button because you’ll dirty the master branch of your forked repository. Make a new branch, and base it off what you’re currently on. If it doesn’t say that, everything’s just fine. Congratulations, you’ve “committed” your changes!<br>

What if you didn’t like that, realize you made a typo, or just wanna go back? You can always just go back into StrongDMM to edit your map and make a new commit, but you can also go to the History tab, right-click on your commit, and click "'''[https://git-scm.com/book/en/v2/Git-Basics-Undoing-Things Undo commit...]'''", which will just undo your commit, and then you can make as many changes as you please, then recommit. This is one of the greatest advantages of Git, [https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control it has a powerful versioning system] that you can easily use to hop from one day’s work to another.<br>

If you’re happy, then seek out a '''"Publish branch"''' button. This will [https://git-scm.com/docs/git-remote upload your branch] to the remote ([https://github.com/ github.com]).<br>
====Creating a Pull Request====
Once all the "[https://git-scm.com/docs/pack-heuristics deltas are resolved]" and what-not, a '''"Create Pull Request"''' button should appear on GitHub Desktop. Click that, and your web browser will open to GitHub. Ta-da, just fill in the [https://github.com/tgstation/tgstation/blob/master/.github/PULL_REQUEST_TEMPLATE.md?plain=1 template just like the descriptions in the contributing template say] (including an image or two of your changes is always well appreciated), hit '''“Create Pull Request”''', and wait for the feedback to roll through. I would advise viewing some example PRs, open up a few of them (if you haven’t already been tracking how people write Pull Requests) and try to learn well.

For more advice on making a Pull Request, you can read more [https://hackmd.io/@tgstation/ry4-gbKH5#The-Pull-Request-Process-on-the-Technical-and-Emotional-Levels here].
{{Speech
|name=SpaceSmithers
|text=I like [https://github.com/tgstation/tgstation/blob/master/.github/CONTRIBUTING.md#pull-request-process the /tg/ git page regarding pull requests] Think I could squeeze it in here?
|image=[[File:Spell.png|64px|right]]
}}
----
You’ve done it! You’ve done mapping! I hope that wasn’t too painful, and the rest of this page (or the links below) will introduce you to some deeper contents that I briefly touched on in regards to mapping.

===Closing Notes===
While this guide is meant to contain the bare-bones of information to get people started on mapping, the [https://hackmd.io/@tgstation/ry4-gbKH5 Mapping Reference Collection] will contain a wealth of information for mappers. I heavily recommend reading this.

Stumped? Feel free to ask some more experienced mappers any questions on the [https://tgstation13.org/phpBB/viewforum.php?f=11 /tg/ forums] or the [https://discord.com/invite/VW9ZEwc Discord]

<big>'''End of san7890 guide and StrongDMM'''</big>
{{Speech
|name=SpaceSmithers
|text=Need to find a good way to transition from StrongDMM to Meta's Dream Maker sections.<br> '''Edit:''' I might just overwrite and renew all of Meta's stuff actually. I'll include a hyperlink at the top of the page that will take the user to an older version of the page with Dream Maker instructions.
|image=[[File:Spell.png|64px|right]]
}}
{{Speech
|name=SpaceSmithers
|text=(7/27) reminder to myself to hyperlink the hell out of the headers & more to the original hackmd. Make it clear that this page is merely a surrogate of sorts. Double check for missing hyperlinks. Add more images. Leech any potentially useful information out of the old guide, which is tucked away in a collapsible. (definitely copy [https://tgstation13.org/wiki/File:Directions.png that direction image], SUPER useful.)
|image=[[File:Spell.png|64px|right]]
}}
----
<div class="toccolours mw-collapsible mw-collapsed">
Hid all this stuff to make scrolling and editing easier. <span style=background-color:yellow;">EDIT: updated various sections here with yellow highlights and speech bubbles.</span>
<div class="mw-collapsible-content">
<div class="toccolours mw-collapsible mw-collapsed">
marked for death
<div class="mw-collapsible-content">
<s>So now you have your folder with the latest code in, and a zip backup to go back to if you break everything. In the master folder, you'll see "tgstation.dme". You want to open this with Dream Maker a program that'll be in your BYOND folder. Set Dream Maker as the default program for opening .dme files, if it isn't already. When you open it, you'll see a two tabs on the left: file, and object. In the file tab, open '''maps''', and then open 'tgstation.2.1.2.dmm', or whatever the current map version is called. You'll then get something looking a bit like this:</s>

{{Speech
|name=SpaceSmithers
|text=san removed this image for some reason <pre>[[File:Dreammakermap.png|center|600px]]</pre>
|image=[[File:Michael Stevens VidCon 2016.jpg|64px|right]]
}}
{{Speech|image=[[File:Bigchungus.png|64px|right]]|name=Big Chungus|text=I think it's because san7890 was trying to overwrite the outdated version of what the fuck map it was with a StrongDMM screencap, but the whole part wasn't formatted correctly to accomodate, so I think he just gave up. I'm big chungus but just trust me on this one. Also, I went through and looked at what you had already copied over from the Guide to Mapping and struck that through just to keep things managed (as well as stuff that only applies to Dream Maker Mapping), feel free to undo that if it interrupts your workflow.}}
{{Speech
|name=SpaceSmithers
|text=dont sweat it, its just there to remind me in case i check on the main and see a difference.
|image=[[File:Spell.png|64px|right]]
}}

<s>Switch from the '''files''' tab to the '''objects''' tab, and you'll see '''area''', '''mob''', '''objects''', and '''turf'''. These are the four primary 'layers' that you can see in the editor. You can toggle their visibility and interactivity on and off using the '''layers '''dropdown. I'd advise copying this map, and renaming it to, say, teststation.dmm.  Perhaps delete most or all of the default station, and build on the now-empty z-level, wherever you like. To build stuff, use the object tree on the left of the UI to select things, then click to place them. A simple click lets you place one item per tile from each category, while Ctrl-click '''stacks''' it on '''top''' of all previous ones and Shift-click deletes the '''topmost''' item. You can have multiple maps open at once - I usually have the default /tg/station map and mine open, and can then shamelessly copy-paste things far more easily. Also, finding stuff in the object tree can be tedious as hell - right click something you see and you can see its path in the tree - obj/structure/closet/etc. This will help you find things. From this point on, really, you can begin mapping proper.</s>

You can select areas to copy/paste/delete, or enter add or fill mode when placing objects. Basically just click around all the menus and you'll work out how they work, more or less. <s>Options>Zoom allows you to zoom out to 50% to see more stuff</s>. Use layers to select which of area, objects and turf you want to edit. If you actually want to be able to see anything, I'd deselect area, and tick 'only show selectable layers'.
</div></div>

The first step, then, is to be able to create your first few rooms. Select a turf (floor) from the generic simulated floors. These will start with the right make-up and pressure of air on them, which is how you'll want it. Surround these floors with walls, and hey presto you have a room. Try sticking some tables in there, perhaps a vending machine or two. 

If you want to add some chips to your new den but are unhappy with how they neatly stack on top of each other, you can change their "pixel_x" and "pixel_y" values in the <span style=background-color:yellow;">(add info here)</span>. Also, all custom values are '''bold''' so it's easier to identify them <span style=background-color:yellow;">(not bold in SDMM2 but.. labelled? marked? however its described, update it here.)</span>. In fact, most wall-mounted machines on stations are shifted like this, and while they APPEAR to be on a wall, they are actually on the tile in front of it <span style=background-color:yellow;">(add info regarding directionals here)</span>. Just don't go overboard with this, as every new instance of an object is added as its own entry in the menu, and when there are dozens of them it can get hard to remember which one you wanted<span style=background-color:yellow;">(still relevant? I guess it clogs the prefab menu.)</span>. Once you've made your room you'll want to put lights in.

{|
|[[File:Mystery pipe.png|left|frame|There is one uninvited guest here!]]
|<s>'''Important:''' While building your station you might find yourself in need of an object with a specific alignment (windows, pipes, cables etc) that does not appear in your menu. This is because BYOND does not simulate instances of an object other than its base state unless they are present on the map. You can generate them by right clicking an object and selecting "generate instance from state/direction". This function has an '''unwanted feature''' in which a generated object sometimes has a tag added automatically. These tags can cause error with certain features of the game during a round, and need to be removed. To check for it, right click an item on the map or in the menu, select "edit" and scroll to the "tag" line, which should be empty save for two doublequotes (""). If it's not (which is easy to tell since the tag is massive and bold, impossible to miss even scrolling at lightspeed), change it. Well maintained maps don't usually contain these, so you should be safe to copy-paste to your heart's content. As a tip, remember that all non-standard objects have their own entry in the menu, and having a tag is not standard at all for most object!</s>
{{Speech|image=[[File:Bigchungus.png|64px|right]]|name=Big Chungus|text=I think this is just a really shitty way of explaining what a pre-fabrication is. It's functionable in how it mentions how you can have "rogue" prefabs, but it's full of BYOND specific instructions and it's just not really useful. It's serviceable, but definitely dated and hard to comprehend unless you know what it's trying to get at (I feel). I'll look at adding a better explanation to the Mapping Reference Collection sometime. Also, those pipes are WAY outdated (picture at left). Definitely needs to go. *chomps on carrot*}}
{{Speech
|name=SpaceSmithers
|text=Sounds good. I'll see to getting a replacement image. Maybe there's a decal or something that has the same sprite for different dirs.
|image=[[File:Spell.png|64px|right]]
}}
|}
{|
|[[File:Editinstance.png|left|200px]]
| So now we get to the basics of making a functioning room. First of all, you'll need to re-enable the area layer. Pick some area from the object tree, and cover your room in it. You can rename this area if you want, we'll do that later. Make sure the area isn't used anywhere else on the map. Each area should have one APC or Area Power Controller in it. Copy one in from the default map or spawn one yourself, then rename its "name" variable through "edit" to something appropriate<span style=background-color:yellow;">(update this sentence, add info regarding autoname APCs.)</span>. If you copied your APC from another map, chances are that cell type and dir are both in bold <span style=background-color:yellow;">(probably not anymore?)</span>. Cell type defines how much power the APC can hold, and for your first map you'll want to set this nice and high as you don't have any sort of generator yet - 10,000 ought to do<span style=background-color:yellow;">(guh, is there an infinite apc in the obj tree? or just use debug rtg or something? don't pester new mappers with var editing an APC. that's my take, anyhow.)</span>. Dir defines the direction the APC is in with regards to the cell it occupies. Basically, 1 means it is above the cell you place it in, 2 is below, 4 is to the right and 8 to the left<span style=background-color:yellow;">(again, add info regarding directional APC types. That, or move this part to a more generic blurb specifically about "dir"s.)</span>.

Note that with APCs, '''dir ''' is the only variable controlling their position. Other objects have their positions defined by '''pixel_x '''and '''pixel_y''' - this changes where APCs appear in the editor, but once ingame they snap to whatever the '''dir''' variable says. Other things, like signs on walls, will only take notice of the pixel variables and not necessarily dir. In a normal power system, you'd connect the APC up to all the others and the station's generator via SMES cells, but we'll do that later. For now you have a basic room that is powered and starts with enough air to breathe happily. You can put an air canister in if you think you'll consume all the oxygen, or somesuch. 
|[[File:Directions.png|right|200px]]
|}



'''<u>Important Note:</u>''' There are '''nudge_x '''and '''nudge_y''' variables in the editor, as well as various z-axis variables. Don't ever change these, they're not used in SS13 and break things.

To be able to actually spawn into a room, you'll want to place spawners. You'll see these as the big red X symbols on the default map, for each role. There are also blue Xs for xeno spawn locations <span style=background-color:yellow;">(pretty sure spawners now use fancy sprites for their respective spawns)</span> and the spawns for all latecomers on the arrival shuttle.<span style=background-color:yellow;">(old/irrelevant, shuttles are not placed onto station maps anymore.)</span> Stick in a spawn_late somewhere in your room for now. 

<span style=background-color:yellow;">(may change for redundancy reasons)</span>
To actually test your map and be able to screw around in it as an admin, you'll have to compile it. The easiest way to do this is through Github Desktop, where you will open the repository in your external editor by clicking the "Open in Visual Studio Code" button. If this is not present, change your default editor in the options to Visual Studio Code. In Visual Studio Code, press <code>F5</code> to both compile and launch the game. Full permissions are automatically granted as "localhost".

The best possible training is through experience. From here on out, you can make whatever you like, really. Copying the default map and working out how everything works isn't too hard and is fairly rewarding. You could just tweak the default one if you like. The first thing I made was a small shuttle - you can see this at the bottom. Just tweak and add stuff and you'll work out how almost everything works fairly easily. Poke around with both Github Desktop and StrongDMM. For explanations of wiring, piping, and atmos, ask away on [https://discord.tgstation13.org/ the mapping channel of our discord] or [https://tgstation13.org/phpBB/viewforum.php?f=11 on the forums].

<!-- About 90% of the stuff from this point onwards is outdated. I rewrote everything from this point in another HackMD (https://hackmd.io/@tgstation/ry4-gbKH5#Pre-Commit-Checklist) onwards.  I need someone to explain how shuttles work to me (again) before I'm 100% done with that though, but I've struck through everything ported over (or that I don't really see why it should be ported over). -->

== [https://hackmd.io/@tgstation/ry4-gbKH5#Pre-Commit-Checklist Pre-commit checklist] ==

*Are floors with or without air, as they should be? (regular or airless)
**You can test this one out by looking for Active Turfs.
*Does the area have an APC?
*Does the area have an Air Alarm?
*Does the area have a Request Console?
**Not every area needs this, look at other stations.
*Does the area have lights?
**When you compile your map for testing, make sure the lighting is adequate. You don’t want any unwarranted “dark” spots in your rooms. If you’re going for “warm” or “cold” lighting, make sure it all matches.
*Does the area have a light switch?
**Only smaller rooms that get minimal traffic should recieve lightswitches. Areas like primary hallways should definitely not have them.
*Does the area have enough security cameras? (Use the '''[https://hackmd.io/@tgstation/SyVma0dS5#Things-To-Look-Out-For Debug Verbs]''' for help)
*Does the area have enough security cameras? (Use the verbs under Mapping for help)
*Does the area have enough intercoms? (The verb <code>Intercom Range Display</code> in the [https://hackmd.io/@tgstation/SyVma0dS5#Things-To-Look-Out-For Mapping Debug Verbs] helps with this.)
*Is the area connected to the vent air loop (distro)?
*Is the area connected to the scrubber air loop (waste)?
*Is everything wired properly?
*Does the area have a fire alarm and firelocks?
**Typically, doors leading into maintenance do not need firelocks. Do not place firelocks on doors facing the exterior of the station (like space or the planet).
*Do all airlocks work properly?
*Are accesses set properly on doors, buttons, etc.?
**For typical airlocks, you can use the [https://github.com/tgstation/tgstation/pull/65580 Airlock Mapping Helpers]. Otherwise, consult the [[Guide_to_door_access|reference for Door Accesses]].
{{Speech
|name=SpaceSmithers
|text=I'm working on an Access Helper table which might help for this part. Also, I copied the checklist into a nifty dropdown seen above in the hackmd port. NOTE TO SELF: this is where i left off.
|image=[[File:spell.png|64px|right]]
}}
*Are all items placed properly?
**In summary, are your objects all on tables as needed? Are tables or other objects obscuring your vents/scrubbers?
*Does the disposal system work properly from all the disposal units in this room as well as the pipes of which pass through this room?
**Just throw yourself through a few disposals systems that seem to pass through the area you touched. Easy to forget.
*Check for any misplaced or stacked piece of pipe.
**/tg/station also [https://hackmd.io/@tgstation/ry4-gbKH5#Linters lints] for this to catch you if you forget.
*Check for any misplaced or stacked piece of wire.
**/tg/station also [https://hackmd.io/@tgstation/ry4-gbKH5#Linters lints] for this to catch you if you forget.
*Identify how hard it is to break into the area and where the weak points are and balance the area accordingly.
**For example, the [[Vault]] should be made of reinforced structures and electrified windows, the [[Kitchen]] should not. Be reasonable, not everything has to be an overly-secure structure to prevent the “tide” or other events. You will be vetted on this, just make your best choice.
*Check if the area has too much empty space.
**You don’t want vast, bald spots in your rooms that serve little purpose. Fill it up with stuff if you can, or just trim the fat entirely. Whatever works best for the station and your design.
*Are there any [[guide_to_mapping#Room Structure|indestructible turfs]] where they shouldn't be?

== <s>General Station-wide Mapping Guidelines</s> ==

=== <s>In general</s> ===
* <s>Don't run pipes/cables/disposals through walls if you can avoid it. Otherwise it's a pain to repair or sabotage them, especially under r-walls.</s>
* <s>Try to connect departments to maintenance through a back or side door. This lets players escape and allows antags to break in. Metastation is a good example for this.</s>

=== <s>Atmospherics</s> ===
* <s>Each area should have EXACTLY one air alarm (Exceptions are only possible if a room has scrubbers or vent pumps on different frequencies).</s>
* <s>Each ROOM (Walled off space) should have at least one vent pump and scrubber, which is properly connected to its respective loop.<br> Keep in mind that scrubbers don't detect gases/pressure; only air alarms do.</s>
* <s>The air supply loop's pipes should be colored blue.</s>
* <s>The scrubbers loop's pipes should be colored red.</s>
* <s>Some areas require special air alarm subtypes: /engine for the SME and /server for tcomms or the RnD server room.</s>

=== <s>Power</s> ===
* <s>Each area (which requires power) should have exactly one APC. For areas with a high roundstart power draw (engineering/cargo), one of the highcap subtypes can be used.</s>

== <s>Atmospherics</s> ==

=== <s>Pipes and manifolds</s> ===

<s>Atmospherics releases it's cocktail of gases into the air supply loop (blue pipes). The station is also equipped with a scrubber loop, which filters unwanted gases and sends them back to atmospherics via the scrubber loop (red pipes).</s>

<s>If you're expanding the air supply loop (blue pipes) use the objects in /obj/machinery/atmospherics/pipe/simple/supply/visible or ../hidden depending on if you want it to show above floors or below them. For manifolds use the objects in /obj/machinery/atmospherics/pipe/manifold/supply/visible and ../hidden.</s>

<s>If you are expanding the scrubber loop (red pipes) use the objects in /obj/machinery/atmospherics/pipe/simple/scrubbers/visible or ../hidden depending on if you want it to show above floors or below them. For manifolds use the objects in /obj/machinery/atmospherics/pipe/manifold/scrubbers/visible and ../hidden.</s>

<s>If you are however building a pipe network which has nothing to do with the air supply or scrubbers loop, you should use the objects in /obj/machinery/atmospherics/pipe/simple/general/visible or ../hidden. For manifolds use the objects in /obj/machinery/atmospherics/pipe/manifold/general/visible and ../hidden.</s> 

<s>To add new colors of pipes, you will need add a new subtypes in the appropriate .dm files located in tgstation\code\modules\atmospherics\machinery\pipes</s>

<s>Please refrain from var-editing pipes, as it typically introduces graphical glitches and other issues.</s>

=== <s>Air Alarm</s> ===

<s>Every single area (with scrubbers and/or vent pumps) should have exactly one air alarm. More than one should be placed if vent pumps or scrubbers use different radio frequencies than the default one (1439).</s>

=== <s>Scrubbers (Station air supply)</s> ===

<s>Every room (ie. walled off space) except for maintenance hallways should have at least one scrubber.</s>

<s>The path for scrubbers that start on is '''/obj/machinery/atmospherics/components/unary/vent_scrubber/on'''</s>

<s>And make sure the '''id_tag''' is the default one (null)</s>

<s>Also ensure the scrubber is connected to the scrubber loop!!</s>

=== <s>Vent Pumps (Station air supply)</s> ===

<s>Every room (ie. walled off space) except for maintenance hallways should have at least one vent pump.</s>

<s>The path for vents that start on is '''/obj/machinery/atmospherics/components/unary/vent_pump/on'''</s>

<s>Please make sure the '''id_tag''' is the default one (null)</s>

<s>Also ensure the vent pump is connected to the air supply loop!!</s>

=== <s>Gas tanks and filters</s> ===

<s>Each station should have a full set of these - or at the bare minimum, one for N2, one for O2 and a third tank to filter dangerous gases into.</s>

[[File:Atmos mapping.jpg|right|frame|Left to right: N2, O2, Airmix. The canisters inside are just for decoration.]]

<s>Each gas tank needs:</s>
* <s>'''Outside''': A tank computer and a gas filter to pick what gases will be filtered into it.</s>
* <s>'''Inside''': A gas injector (input), a vent pump (output), a gas sensor and a specific turf.</s>

<s>The tank computer controls the input/output and receives data from the gas sensor.</s>

<s>The specific turf creates the gases that will be inside each tank - the gas canister is just for decoration.</s>

<s>Let's take a look at the MetaStation N2 tank:</s>

* <s>'''Tank computer''': /obj/machinery/computer/atmos_control/tank/nitrogen_tank</s>
* <s>'''N2 filter''': /obj/machinery/atmospherics/components/trinary/filter/atmos/n2</s>
* <s>'''Gas injector''': /obj/machinery/atmospherics/components/unary/outlet_injector/atmos/nitrogen_input</s>
* <s>'''Vent pump''': /obj/machinery/atmospherics/components/unary/vent_pump/siphon/atmos/nitrogen_output</s>
* <s>'''Gas sensor''': /obj/machinery/air_sensor/atmos/nitrogen_tank</s>
* <s>'''Turf''': /turf/open/floor/engine/n2</s>

<s>These objects have all the neccessary vars preset and start switched on - you'll only have to edit the dir if neccessary.</s>

<s>Additionally, you'll want this type of gas mixer for the airmix tank (N2 + O2):</s>

* <s>'''Air mixer''': /obj/machinery/atmospherics/components/trinary/mixer/airmix</s>

== <s>Power</s> ==

=== <s>APC</s> ===
<s>Each new room needs at least one, this will provide all the power for the room (magically). Each piece of machinery inside the APC's area will draw power from either the lighting, equipment or environmental channel.</s>

<s>Any room that is very equipment heavy (for example cargo bay) may need a beefed up APC (apc/highcap) to prevent early blackouts. These start with higher capacity power cells.</s>

=== <s>Wiring</s> ===
<s>Make sure the wires lead from the main power grid, and to the APC(s) of your area. If any equipment in your new area requires a wire under it, line it up, connected to the main power grid, and under the machinery.</s> 

<s>Wires are also helpful when making electrical grilles (just dot wire under a grille), make sure the wires touch the main power grid (or they won't shock people).</s>

== <s>Equipment</s> ==

=== <s>Lights</s> ===
<s>Lights take up a lot of power, don't use too many! Make sure to put in just enough so the room is fully lit, but not so many that the equipment will go out in ten minutes of the round starting.</s>

=== <s>Light switch</s> ===
<s>For mood lighting, or to show the room is currently not in use by the primary occupant. These disable the lighting equipment (and power drain associated) in the area, but not desk lamps. Place these on walls, usually by a door.</s>

=== <s>Request Console</s> ===
<s>If a certain room has no need for materials, or produces no materials, do not give it a Request Console. If it does (for either case or both) make sure it has at least one, that is in a place where some one will see it.</s>

=== <s>Intercoms</s> ===
<s>At least every room should have one of these. They should be set to 145.9, and be speaker ON Microphone OFF. This is so radio signals can reach people even without head sets on. Larger room will require more than one at a time.</s>

=== <s>Security Cameras</s> ===
<s>Most areas should have these, enough to see the general area from a Human point of view, but, not bunched together for the AI's sake. Larger rooms may require more than one.</s>

== <s>Room Structure</s> ==

=== <s>Access</s> ===
''' <s><span style="color:#FF5238"> Refer to ..\code\__DEFINES\access.dm for door access values.</span></s>'''

<s>Access to doors is handled by req_access values. There are four when editing a door - req_access, req_access_txt, req_one_access, and req_one_access_txt. The one's we're concerned with are '''req_access_txt''' and '''req_one_access_txt'''.</s> 

[[File:DoorAccessImage1.png|thumb|left|300px]] <s>This image shows a door on the Arrivals shuttle - since it's a public door, the access is set to "0", as everyone should be able to open it. If we look at the Brig front door, we would set the access to 63, because that's the value for Security front doors - accessible by Security positions, but no one else.</s>

<s>Multiple accesses to doors are handled by adding a semicolon (with no spaces) between access values (eg. "28;31" is for Kitchen and Cargo access). This might seem worthless, but it's useful for small maps, where jobs might need to share access due to cramped spaces.</s>

<s>There's an important difference between the two that you need to pay attention to - req_access_txt requires '''ALL LISTED ACCESSES''' to open the door, while req_one_access_txt lets anyone with '''ONE OF THE LISTED ACCESSES''' open the door. For example - say you want your Brig to be openable by the Detective and Security Officers, we would put "63;4" in '''req_one_access_txt''', because we want the Detective '''AND''' Security to have access. If we used req_access_txt, you would need '''BOTH''' accesses to open the door, meaning neither the Detective or Security could open it.</s>

<s>You can view all of the access values in the code/game/jobs/access.dm file. (Most should be self explanatory or have a label, but if you really aren't sure, you can take a look at Boxstation's map file and check the value on the door you're looking for).</s>

=== <s>Airless Floors</s> ===

<s>Ideal for rooms or chambers that mix gas, and for tiles exposed to space. Not ideal for areas that humans will cross in frequency.</s>

<s>Use these on external tiles (to prevent lag when the game starts) and chambers that will require gas mixing (toxins mix chamber/ furnace). Double check these to make sure you don't suffocate mobs in the new rooms.</s>

=== <s>Fire Alarms and Fire Doors</s> ===
<s>Make sure to put these INSIDE of the boundary of the area, so there is a lock down. Any spot that gets hot as a normal function should not have a fire Alarm right next to the heat source (toxin mix chamber). Make sure there is a fully sealed area (with the exception of maintenance doors for people to escape fires) that can't be open by normal civilians.</s>

=== <s>Weak Points</s> ===
<s>Judge how high security the room will be, if it is high security, reinforced walls and electrified grill windows may be in order. Areas that do not need a lot of security can use basic walls, and windows to your liking (though normal glass windows break very very easy). Each room should have one place that's weaker than the rest (like a back door, side entrance, or a window), just because the main entrance might be out of commission (and realistically, for traitors to break into).</s>

=== <s>Item and Machinery Distribution</s> ===
<s>Be smart about what will go in an area, keep a fine balance between the size of the room and amount of equipment. Large rooms may require multiple APCs to prevent power outages early in game. Second, make sure to place equipment that make sense for the area (security computer in a security area/ Medical vendor in a medical area).</s>

=== <s>Indestructible Turfs</s> ===
<s>Before you finalize a map, check for any indestructible turfs. These turfs ignore things like external damage and are typically meant for things like special ruins/rooms where you want to avoid people trying to circumvent a path. Due to these characteristics, they have no real place on regular station maps and would probably lead to confusion for players more than anything.</s>

== <s>Balance</s> ==

=== <s>Item contents</s> ===
<s>The harder the room is to enter, the more goodies or sensitive equipment there is inside. Make sure to keep this in mind (and don't make an empty room that's covered in blast doors, electrified grills, reinforced walls, and captain level doors).</s>

=== <s>Room security</s> ===
<s>A room is only as secure as its necessity. Public rooms should not have many security functions (other than a fire alarm), but private work space must be more secure (based on job). The bartenders do not need reinforced walls around their storage, but engineers do.</s>

<s>The highest security rooms should utilize the highest security measures. The lowest security rooms should utilize the cheapest security measures.</s>

== <s>Step_x, step_y and the broken movement syndrome</s> ==

<s>So you compiled the map and suddenly whenever you move you no longer get the animation of moving but just 'appear' on the next tile?</s>

<s>So a while back step_x and step_y were introduced to allow pixel based movement. SS13 does not utilize this. Step_x and step_y are variables that each atom has. The way they work is that as soon as you set any object on the map to use one of these variables, the game interprets that you overrode all default movement code and wrote your own - but you didn't (The code that makes the animation from tile to tile).</s> 

<s>To fix this problem you need to close dream maker (save the project first, obviously). Open your map (.dmm) file in a text editor, such as notepad or notepad++. Search (ctrl+f) through the file for step_x and step_y and remove any reference to it. Once no more step_x or step_y -es are found in the file, save it and open it in dream maker once again. Compile the code and movement should work fine once more. Go to [[Community|the development IRC]] if you need more help.</s>

== <!-- This entire section regarding shuttles is just garbage that doesn't actually make sense by the way... I'm going to chase down someone to baby me through it so I can get a suitable rewrite done for modern shuttles. --> ==

==<s>Shuttles</s> ==
<s>Basically there's 3 types of shuttle dock stationary, transit and mobile</s>
*<s>stationary == places where the shuttle can dock</s>
*<s>transit == shuttle as it moves</s>
*<s>mobile == the place with the actual shuttle</s>
<s>so you'd have a transit dock in the transit area and 2 stationary docks, one in centcomm and the other one in the station and 1 mobile dock, in centcomm for most shuttles (apart from mining)</s>

<s>The shuttle docks are grouped by id eg id = "cargo_away" id = "cargo_transit"</s>

<s>You need to add the dock types to the map and edit the bounding boxes via varediting the dock, you need to varedit height, width, dheight and dwidth at minimum. These are offset by the dir so do keep that in mind, eg if dir == 2 then width goes from EAST to WEST, if dir == 4 then width goes from NORTH to SOUTH and dwidth/dheight are offsets from the lower-left corner of the plane switched to the dock's dir</s>

<s>You should also ensure the directions face the shuttle or face away from the thing the shuttle docks with.</s>

<s>If a shuttle's mobile docking port direction is different then the stationary docking port's direction, the shuttle and all items on it will be rotated accordingly. (Try it, it works properly for just about everything)</s>

<s>'''Warning the bounding box for the mobile dock must fit inside of the stationary dock (after any rotation)''' Or the shuttle will refuse to move.</s>

<s>If the shuttle's mobile docking port is in an area that is a subtype of /area/shuttle, Only turfs in the bounding box in that same area are moved. Otherwise it moves all turfs in the bounding box. This can be used for odd shaped shuttles. (the area will be transfer over as well)</s>

<s>Also note that the emergency shuttle and cargo shuttle need special subtypes of the dock type eg so /obj/docking_port/mobile/emergency</s>

<s>The other variables of note is traveldir, which defines if the shuttle rotates on transit, it's an angle in degrees (just imagine the shuttle is inside a circle . For example, if you want the shuttle going right to left set it to 270 degrees.</s>

===<s>Dwidth and Dheight in more depth</s>===
<s>dwidth/dheight is the offset of the docking_port obj from the (0,0) bounding box corner. In dir == 1 (north) 0,0 is the bottom left corner? This changes for each direction, For example when dir is 2 it's the upper right corner. so dwidth and dheight identify where the bounding box starts relative to the docking port obj whereaswidth and height determine the actual width and height of the bounding box</s>

'''<s>Note: We count step 0 as a tile, so a height and width of 9 is actually 10 tiles (tile 0 to tile 9)</s>'''

<s>Here is an example for the north facing shuttle dock direction - you can rotate this image to determine where the offset is for each other cardinal direction
[[File:ShuttleBox.png]]</s>

==<s>Other files</s>==
<s>If you are adding a map to the game, you need to ensure it has a JSON file under _maps, and is included in the maps config file.</s>

= <!-- I'm going to keep it 100% with you, I don't even know why we have this section. I didn't bother adding it to the modern guides because I don't even know the usecase of it... feel free to leave it here if you want, but I don't know of a usecase. --> =

==<s>Helpful regular expressions</s>==
<s>Everything in the code blocks is a regular expression, most decent text editors are able to use regex in their searches.</s>

<s>Replace the regex proceding <tt>=></tt> with what follows.</s>

=== <s>Pesky var edits for the `something` var are all over my map</s> ===
<s>Replace <tt>something</tt> with the var that needs to be removed. You need to run both replacements to catch all cases.</s>

<s>For standard dmm format:</s>
* <s><code>\bsomething *= *.+?; *</code> => nothing</s>
* <s><code>{\W*\bsomething *= *[^;]+?\W*}</code> => nothing</s>

<s>For TGM format:</s>
* <s><code>^\W+\bsomething *= *.+?;\n</code> => nothing</s>
* <s><code>{\W*\bsomething *= *[^;]+?\W*}</code> => nothing</s>

<s><br /></s>
== <s>Multi-Z</s> ==

<s>Multi-Z is a feature which allows a station map to have multiple Z-levels layered on top of each other, behaving as a single station with multiple floors. This feature is currently in use on the [[Tramstation]] and [[IceboxStation]] maps. A station's multiple levels can be bundled into one map file, or in several seperate files. The traits section of the map configuration json tells SS13 how to link the maps together.</s> 

* <s>If you are building station rooms on a lower Z level, ensure that a floor of some type is mapped on the Z level above the room. You can check the coordinates in the mapping editor to ensure you floor over the correct dimensions of the room. When running the server in Dream Daemon to test the map, you can go to the Debug tab and hit show debug verbs, go to Mapping tab and hit Show ATs, if the list is empty, you are good.</s>

* <s>Earlier versions of multi-z did not require a baseturf to be defined under each z-level's traits in the config json. Each level must now have a baseturf set.</s>

* <s>The maploader '''will not''' load and link a map file without areas or turfs defined. An empty space (nothing but baseturf) map will runtime. If you are adding a Z-level to an existing map, be aware of this.</s>

* <s>SS13 will cache a map's configuration json file in data\next_map.json. If you alter a map's configuration json locally, you must also clear this file by using the change-map verb in game, deleting the file, or replacing it with your updated json file.</s>
</div></div>