Skip to content

Mapping Prefab Guide

BurgerLUA edited this page Aug 15, 2022 · 1 revision

Want to add your own buildings? Burgerstation is always in need of new buildings, and this guide will help you help us fulfill that need.

Starting out

Three things are required before mapping for Burgerstation

If you need help with any of these, ask on the Discord and anyone can help you. Alternatively, there is also a coderbus discord that can help out with all this as well, located here: https://discord.gg/Vh8TJp9

Map Structure and Format

Burgerstation uses a (mostly) code-free "plug-in and play" method of adding maps. All you have to do is add the map to the right folder of the /maps/prefabs directory. And set the appropriate map size for it.

For City Prefabs

  • Prefabs should be made in the /maps/prefabs/city directory.
  • For city prefabs, the file can be named whatever you want as long as the name makes sense for the prefab.
  • For now, the map size of the city prefab should be x:16, y:16, z:1.
  • The default turf (for empty spaces) should be /turf/dmm_suite/clear_turf.
  • The default area (for blank areas) should be /area/dmm_suite/clear_area.
  • If you want to make your own areas, the path should be under /area/mission/prefab/city

For House Prefabs

  • Prefabs should be made in the /maps/prefabs/house directory.
  • For house prefabs, the file can be named whatever you want as long as the name makes sense for the prefab.
  • For now, the map size of the city prefab should be x:16, y:16, z:1.
  • The default turf (for empty spaces) should be /turf/dmm_suite/clear_turf.
  • The default area (for blank areas) should be /area/dmm_suite/clear_area.
  • If you want to make your own areas, the path should be under /area/mission/prefab/house

General Design and Standards

Here are some quick minimum requirements for maps.

  • The prefab itself should be realistic to exist in a low-income settlement in space. Imagine a combination of wild west minimalism with building materials of iron, steel, clay, and wood with elements of electrical machines.
  • If you're making an area with power, its own area is required to make. See "Area Template" at the bottom of this document for a template of the area.
  • The only mobs that should be placed in prefabs are zombies or humanoids. General wildlife should not exist in the prefab unless you are doing some sort of area that is supposed to contain wildlife, such as a pet clinic.
  • Lighting should be relatively sparse. Avoid making the prefab full bright if you can and preferably use light bulbs for small areas and lighting tubes for larger areas.
  • If making a house, make sure it's a house that actually looks livable. A house without a bathroom or a kitchen looks weird.
  • Items should never be placed unless it is absolutely needed for the prefab. If you want to add loot, look for spawning markers under /obj/marker/spawning/random for random loot.
  • APCs are required to be placed in the main parent area, and not elsewhere. SMES units can be placed anywhere.
  • Windows should be placed via a special marker under the path /obj/marker/spawning/window.

Example Template

/area/mission/prefab/house/example_house //This is the area where you place the APC.
	name = "example house"
	icon_state = "yellow"
	requires_power = TRUE
	link_to_parent_apc = TRUE
	interior = TRUE

/area/mission/prefab/house/example_house/bathroom_01
	icon_state = "red"

/area/mission/prefab/house/example_house/bathroom_02
	icon_state = "blue"

/area/mission/prefab/house/example_house/kitchen
	icon_state = "green"

/area/mission/prefab/house/example_house/master_bedroom
	icon_state = "purple"

/area/mission/prefab/house/example_house/boys_bedroom
	icon_state = "cyan"

/area/mission/prefab/house/example_house/girls_bedroom
	icon_state = "pink"

/area/mission/prefab/house/example_house/hallway
	icon_state = "orange"

/area/mission/prefab/house/example_house/entrance
	icon_state = "brown"
Clone this wiki locally