Skip to content

docs(yardmap): Some refactoring #2421

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(yardmap): Some refactoring #2421

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c059fbc
docs(yardmap): Some refactoring
badosu Jul 1, 2025
80d1969
Update doc/site/content/docs/guides/yardmaps/_index.md
badosu Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 36 additions & 6 deletions doc/site/content/docs/guides/yardmaps/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,44 @@ Basic characters:
| u | ❌ | ✅ | ❌ | ✅ | ❌ | ❌ |
| e | ❌ | ⚠️ exit only | ❌ | ⚠️ exit only | ❌ | ❌ |

Others:

- `h` has a special meaning - it **has to be the first letter and means a high resolution yardmap**,
i.e. there have to be 4x more characters and each will correspond to a "regular" 8x8 elmo game square instead of the larger 16x16 elmo footprint square.
- `w`, `x`, `f`: deprecated, same as `o`.
- **whitespace is ignored**, which you can use to neatly **arrange the rectangle visually**.
<dl>
<dt>Active/Inactive</dt>
<dd>
Whether <code>YARD_OPEN</code> is true or false (controlled by animation,
default false)
</dd>
<dt>Needs geo</dt>
<dd>
Whether the unit can only be built on top of terrain marked as geothermal.
Note that this applies to the _whole_ unit, i.e. the geothermal doesn't
need to be specifically under that tile! Also, it's sufficient to have a
a single geothermal underneath for the unit to be buildable regardless of
how many needs-geo tiles there are beyond the first.
</dd>
</dl>

A few remarks:

- **whitespace is ignored**, which you can use to neatly **arrange the
rectangle visually**.
- anything else is ignored as well but may be used in the future.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be confusing to say "anything else" before all options were mentioned (h was previously above this line but is now below and in a different section).


#### Additional characters

##### High definition

The character `h` is a special character that, when passed as (and **only valid**
when) the first letter on a yardmap (e.g. `hyyy..`), marks the yardmap
definition as high resolution: requires 4x more characters and each will
correspond to a "regular" 8x8 elmo game square instead of the larger 16x16 elmo
footprint square.

Does not count as a square.

##### Deprecated

- `w`, `x`, `f`: same as `o`.

### Typemaps and speed mod classes

One of the metadata associated with game squares is terrain type. A map can define (and a game can in theory later tweak) up to 256 types of terrain with their own traits. The first built-in terrain trait is hardness, which is a multiplier on weapon terrain deformation (cratering). The other is speed multipliers for unit movement classes. There are four movement classes: "kbot", "tank", "hover" and "ship". Here are their characteristics:
Expand Down