Add a terminology section to mapping guide #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

kontakt wants to merge 9 commits into space-wizards:master from kontakt:20251104-mapping-improvement

kontakt commented Nov 5, 2025

Based on discussion in discord, the terminology was confusing.
I've added a terminology segment to hopefully introduce new mappers to what things mean.

I also fixed typos and grammar errors.

kontakt added 9 commits

November 4, 2025 20:49


          Update link

978b10c


          Typo


          Add terminology segment

8d2eca1


          Typos

35f922a


          Update link

31961e9


          Add terminology segment

27720ce


          Typo

52857ff


          Typos

5a1830b


          Grammar

a2ce87e

github-actions bot added the English label

RemFexxel reviewed

View reviewed changes

Contributor

RemFexxel left a comment

There are a few parts that could use changes.

src/en/space-station-14/mapping/guides/general-guide.md

    
              # Terminology

              - **Entity** - An in-game object. Entities are game items like vending machines or chairs.

              - **[Grid](../../../robust-toolbox/transform/grids.md)** - Composed of linked tiles, a grids is a structure such as a station, shuttle or asteroid. Grids are placed on maps.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            - **[Grid](../../../robust-toolbox/transform/grids.md)** - Composed of linked tiles, a grids is a structure such as a station, shuttle or asteroid. Grids are placed on maps.
          
            - **[Grid](../../../robust-toolbox/transform/grids.md)** - Composed of linked tiles, a grid is a structure such as a station, shuttle, or asteroid. Grids are placed on maps.

src/en/space-station-14/mapping/guides/general-guide.md

    
              - **Entity** - An in-game object. Entities are game items like vending machines or chairs.

              - **[Grid](../../../robust-toolbox/transform/grids.md)** - Composed of linked tiles, a grids is a structure such as a station, shuttle or asteroid. Grids are placed on maps.

              - **Map** - Map, in this context, refers to an in-game region of empty space. Travel between maps requires an FTL jump. Each map that exists within the current game has a unique ID. Think of a map as a canvas to place a grid or grids on. A map is ***not*** the same as a mapfile.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            - **Map** - Map, in this context, refers to an in-game region of empty space. Travel between maps requires an FTL jump. Each map that exists within the current game has a unique ID. Think of a map as a canvas to place a grid or grids on. A map is ***not*** the same as a mapfile.
          
            - **Map** - In this context, Map refers to an in-game region of empty space. Travel between maps requires an FTL jump. Each map that exists within the current game has a unique ID. Think of a map as a canvas to place a grid or grids. A map is ***not*** the same as a mapfile.

src/en/space-station-14/mapping/guides/general-guide.md

    
              - **Entity** - An in-game object. Entities are game items like vending machines or chairs.

              - **[Grid](../../../robust-toolbox/transform/grids.md)** - Composed of linked tiles, a grids is a structure such as a station, shuttle or asteroid. Grids are placed on maps.

              - **Map** - Map, in this context, refers to an in-game region of empty space. Travel between maps requires an FTL jump. Each map that exists within the current game has a unique ID. Think of a map as a canvas to place a grid or grids on. A map is ***not*** the same as a mapfile.

              - **MapFile** - The representation of a map on disk. These YAML files contain all of the entities on a map and their locations. These files should never be edited directly. This is the map prototype.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            - **MapFile** - The representation of a map on disk. These YAML files contain all of the entities on a map and their locations. These files should never be edited directly. This is the map prototype.
          
            - **MapFile** - The representation of a map on disk. These YAML files contain all the entities on a map and their locations. These files should never be edited directly. This is the map prototype.

src/en/space-station-14/mapping/guides/general-guide.md

    
              - **[Grid](../../../robust-toolbox/transform/grids.md)** - Composed of linked tiles, a grids is a structure such as a station, shuttle or asteroid. Grids are placed on maps.

              - **Map** - Map, in this context, refers to an in-game region of empty space. Travel between maps requires an FTL jump. Each map that exists within the current game has a unique ID. Think of a map as a canvas to place a grid or grids on. A map is ***not*** the same as a mapfile.

              - **MapFile** - The representation of a map on disk. These YAML files contain all of the entities on a map and their locations. These files should never be edited directly. This is the map prototype.

              - **Prototype** - Two types of prototype are important to specify for maps.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            - **Prototype** - Two types of prototype are important to specify for maps. 
          
            - **Prototype** - Two types of prototypes are important to specify for maps.

I don't think it should be a ‘prototype’ since you mention two types.

src/en/space-station-14/mapping/guides/general-guide.md

    
              - **Map** - Map, in this context, refers to an in-game region of empty space. Travel between maps requires an FTL jump. Each map that exists within the current game has a unique ID. Think of a map as a canvas to place a grid or grids on. A map is ***not*** the same as a mapfile.

              - **MapFile** - The representation of a map on disk. These YAML files contain all of the entities on a map and their locations. These files should never be edited directly. This is the map prototype.

              - **Prototype** - Two types of prototype are important to specify for maps. 

                - The prototype of a map is a structure in `Resources/Maps` that defines by which it is called. This is the MapFile.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
              - The prototype of a map is a structure in `Resources/Maps` that defines by which it is called. This is the MapFile. 
          
              - The prototype of a map is a structure in `Resources/Maps` that defines how it is called. This is the MapFile.

“-that defines by which it is called” doesn't sound right.

src/en/space-station-14/mapping/guides/general-guide.md

    
              1. Copy your newly saved mapping file from "space-station-14/bin/Content.Server/data/" to "space-station-14/Resources/Maps/". You will also need to do this to submit your changes later.

              2. If this is a brand new map, head to "space-station-14/Resources/Prototypes/Maps" and create a .yml file for your map (known as a map prototype). As a guide, copy an existing one and change the name to match your new map, and edit the contents in a word editor like Notepad++ or your prefered method so that your new map has a unique ID and name. See section on multi-grid and multi-station for Station IDs (this is not the same as your map ID).

              2. If this is a brand new map, head to "space-station-14/Resources/Prototypes/Maps" and create a .yml file for your map (known as a map prototype). As a guide, copy an existing one and change the name to match your new map, and edit the contents in a word editor like Notepad++ or your preferred method so that your new map has a unique ID and name. See section on multi-grid and multi-station for Station IDs (this is not the same as your map ID).

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            2. If this is a brand new map, head to "space-station-14/Resources/Prototypes/Maps" and create a .yml file for your map (known as a map prototype). As a guide, copy an existing one and change the name to match your new map, and edit the contents in a word editor like Notepad++ or your preferred method so that your new map has a unique ID and name. See section on multi-grid and multi-station for Station IDs (this is not the same as your map ID).
          
            2. If this is a brand new map, head to "space-station-14/Resources/Prototypes/Maps" and create a .yml file for your map (known as a map prototype). As a guide, copy an existing one, change the name to match your new map, and edit the contents in a word editor like Notepad++ or your preferred method so your new map has a unique ID and name. See the section on multi-grid and multi-station for Station IDs (this is not the same as your map ID).

src/en/space-station-14/mapping/guides/general-guide.md

    
              To pull request:

              1. Create a branch on your cloned respository either through your Github client.

              1. Create a branch on your cloned repository either through your Github client.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            1. Create a branch on your cloned repository either through your Github client.
          
            1. Create a branch on your cloned repository through your GitHub client.

src/en/space-station-14/mapping/guides/general-guide.md

    
              - To remove tiles use the "Space" tile.

              - You do not need to place plating down first then tiles, you can just place any tile and it will pry up to show the below tile in game (usually plating).

              - Similary you can overwrite tiles by placing a new one in its place - no need to remove them first.

              - Similarly you can overwrite tiles by placing a new one in its place - no need to remove them first.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            - Similarly you can overwrite tiles by placing a new one in its place - no need to remove them first.
          
            - Similarly, you can overwrite tiles by placing a new one in its place - no need to remove them first.

src/en/space-station-14/mapping/guides/general-guide.md

    
              ### Mapping Atmospherics Components

              In order to create a life support system aboard your map you'll need to create a pipe network or two - one for **distributing** air, and one for pulling **waste** gasses out of the air. Use the following devices in your pipe networks (pipe net):

              * **Vents** - use these around your station to distrubute your fresh air.

              * **Vents** - use these around your station to distribute your fresh air.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            * **Vents** - use these around your station to distribute your fresh air.
          
            **Vents** - Use these around your station to distribute fresh air.

src/en/space-station-14/mapping/guides/general-guide.md

    
              Most maps now will use **Station Beacon**s instead of warp point as they already include the named warp point component on them. Place these in the relevant rooms of your station **instead** of warp points. This will allow them to populate station maps correctly.

              If you want to allow people to ghost warp to a location but don't want it to show up on a station map, or it's not suitable for a station beacon (planets, player griefing by moving the warp point, other reasons) then use the classic purple warp point marker. Place it, then right click, view variable, navigate to serverside components, search for the warp component, then alter the name in that component to reflect what you want in the warp menu.

              If you want to allow people to ghost warp to a location but don't want it to show up on a station map, or it's not suitable for a station beacon (planets, player griefing by moving the warp point, other reasons) then use the classic purple warp point marker. Place it, then right click, view variable, navigate to server side components, search for the warp component, then alter the name in that component to reflect what you want in the warp menu.

Contributor

RemFexxel Nov 5, 2025

Suggested change

      
            If you want to allow people to ghost warp to a location but don't want it to show up on a station map, or it's not suitable for a station beacon (planets, player griefing by moving the warp point, other reasons) then use the classic purple warp point marker. Place it, then right click, view variable, navigate to server side components, search for the warp component, then alter the name in that component to reflect what you want in the warp menu.
          
            If you want to allow people to ghost warp to a location but don't want it to show up on a station map, or it's not suitable for a station beacon (planets, player griefing by moving the warp point, or other reasons), then use the classic purple warp point marker. Place it, then right-click, view the variable, navigate to server-side components, search for the warp component, and then alter the name in that component to reflect what you want in the warp menu.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels