Skip to content

Commit

Permalink
Game-Area documentation overhaul, Work Groups and Maintainer/Review P…
Browse files Browse the repository at this point in the history
…olicy (#199)

The biggest change here is separating game (SS14) documentation into
Game Areas to better categorize mechanics/docs and make it easier to
find things.
Game Areas are separated into Global and Department areas:
- A Global Area is a part of the game that does not fit under a single
department or is specific to the individual player's experience. These
may also be high-level concepts related to the game. (For example: UI,
Art, Mapping, Species, etc.)
- A Department Area is a part of the game that fits the design/theme of
a specific in-game department. (For Example: Security, Atmospherics,
Command, etc.)

This PR also implements workgroups as a concept (Code-Owners but for
Game Design). A workgroup is an opt-in/opt-out role that is responsible
for maintaining the documentation, design, and PR Guidelines of a Game
Area. Maintainers can be a part of multiple workgroups or none if they
so choose.

Additionally, this PR will define policy for PR reviews, specifically
going over the review process and what is required to approve/merge a
PR. Along with a list of guidelines for contributors to look through to
help speed up the review process. This also includes a Maintainer policy
document that outlines the powers/expectations that the maintainer role
entails, how maintainers are chosen, and what contributors should do if
they want to become a maintainer someday.
  • Loading branch information
Jezithyr committed Apr 21, 2024
1 parent 1f220b1 commit d4d8017
Show file tree
Hide file tree
Showing 68 changed files with 366 additions and 66 deletions.
1 change: 0 additions & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@
/src/en/templates/ @moonheart08
/src/en/proposals/ @jezithyr
/src/en/templates/ @jezithyr
/src/en/space-station-14/core-design @jezithyr
/src/ru/* @ficcialfaint
86 changes: 64 additions & 22 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ General Development
- [YAML Crash Course](en/general-development/tips/yaml-crash-course.md)
- [Feature Proposals](en/general-development/feature-proposals.md)
- [Expected Team Decorum & Usage](en/general-development/feature-proposals/expected-feature-proposal-decorum.md)
- [Core Game Design](en/space-station-14/core-design.md)

- [Work Groups](en/general-development/work-groups.md)

SS14 By Example
===============
Expand Down Expand Up @@ -99,26 +98,66 @@ Space Station 14
================

----------------------
- [Core Game Design](en/space-station-14/core-design.md)
- [Design Principles](en/space-station-14/core-design/principles.md)
- [Antagonists](en/space-station-14/core-design/antagonists.md)
- [Mapping](en/space-station-14/mapping.md)
- [Mapping Checklist](en/space-station-14/mapping/mapping-checklist.md)
- [Mapping Sins](en/space-station-14/mapping/mapping-sins.md)
- [Chemistry](en/space-station-14/chemistry.md)
- [Solution Containers](en/space-station-14/chemistry/solution-containers.md)
- [Reagents](en/space-station-14/chemistry/reagents.md)
- [Metabolism](en/space-station-14/chemistry/metabolism.md)
- [Reactions](en/space-station-14/chemistry/reactions.md)
- [Construction](en/space-station-14/construction.md)
- [Destructible](en/space-station-14/destructible.md)
- [Device Network](en/space-station-14/device-network.md)
- [Pow3r](en/space-station-14/pow3r.md)
- [Cartridge Loaders](en/space-station-14/cartridge-loaders.md)
- [Node Networks](en/space-station-14/node-networks.md)
- [Dungeons](en/space-station-14/dungeons.md)
- [NPCs](en/space-station-14/npcs.md)
- [Displacement Maps](en/space-station-14/displacement-maps.md)

- [Design](en/space-station-14/design.md)
- [Design Principles](en/space-station-14/design-principles.md)
- [Game Areas]()
- [Global]()
- [Accessibility](en/space-station-14/areas/core/accessibility.md)
- [PR Guidelines](en/space-station-14/areas/core/accessibility/guidelines.md)
- [Admin Tooling](en/space-station-14/areas/core/admin-tools.md)
- [PR Guidelines](en/space-station-14/areas/core/admin-tools/guidelines.md)
- [Art](en/space-station-14/areas/core/art.md)
- [PR Guidelines](en/space-station-14/areas/core/art/guidelines.md)
- [Displacement Maps](en/space-station-14/areas/core/art/displacement-maps.md)
- [Character/Species](en/space-station-14/areas/core/characters-species.md)
- [PR Guidelines](en/space-station-14/areas/core/character-species/guidelines.md)
- [Combat](en/space-station-14/areas/core/combat.md)
- [PR Guidelines](en/space-station-14/areas/core/combat/guidelines.md)
- [Destructible](en/space-station-14/areas/core/combat/destructible.md)
- [Mapping](en/space-station-14/areas/core/mapping.md)
- [PR Guidelines](en/space-station-14/areas/core/mapping/guidelines.md)
- [Dungeons](en/space-station-14/areas/core/mapping/dungeons.md)
- [Guides]()
- [General Guide](en/space-station-14/areas/core/mapping/guides/general-guide.md)

- [Player Interaction](en/space-station-14/areas/core/player-interaction.md)
- [PR Guidelines](en/space-station-14/areas/core/player-interaction/guidelines.md)
- [Roleplay/Lore](en/space-station-14/areas/core/roleplay-lore.md)
- [PR Guidelines](en/space-station-14/areas/core/roleplay-lore/guidelines.md)
- [Roundflow](en/space-station-14/areas/core/round-flow.md)
- [PR Guidelines](en/space-station-14/areas/core/round-flow/guidelines.md)
- [Antagonists](en/space-station-14/areas/core/round-flow/antagonists.md)
- [User Interface](en/space-station-14/areas/core/user-interface.md)
- [PR Guidelines](en/space-station-14/areas/core/user-interface/guidelines.md)


- [Departments](en/space-station-14/areas/departments.md)
- [Atmos](en/space-station-14/areas/departments/atmos.md)
- [PR Guidelines](en/space-station-14/areas/departments/atmos/guidelines.md)
- [Cargo/Salvage](en/space-station-14/areas/departments/cargo-salvage.md)
- [PR Guidelines](en/space-station-14/areas/departments/cargo-salvage/guidelines.md)
- [Command](en/space-station-14/areas/departments/command.md)
- [PR Guidelines](en/space-station-14/areas/departments/command/guidelines.md)
- [Engineering](en/space-station-14/areas/departments/engineering.md)
- [PR Guidelines](en/space-station-14/areas/departments/engineering/guidelines.md)
- [Construction](en/space-station-14/areas/departments/engineering/construction.md)\
- [Node Networks](en/space-station-14/areas/departments/engineering/node-networks.md)
- [Device Network](en/space-station-14/areas/departments/engineering/device-network.md)
- [Pow3r](en/space-station-14/areas/departments/engineering/pow3r.md)
- [Medical](en/space-station-14/areas/departments/medical.md)
- [PR Guidelines](en/space-station-14/areas/departments/medical/guidelines.md)
- [Science](en/space-station-14/areas/departments/science.md)
- [PR Guidelines](en/space-station-14/areas/departments/science/guidelines.md)
- [Chemistry](en/space-station-14/areas/departments/science/chemistry.md)
- [Metabolism](en/space-station-14/areas/departments/science/chemistry/metabolism.md)
- [Reactions](en/space-station-14/areas/departments/science/chemistry/reactions.md)
- [Reagents](en/space-station-14/areas/departments/science/chemistry/reagents.md)
- [Solution Containers](en/space-station-14/areas/departments/science/chemistry/solution-containers.md)
- [Security](en/space-station-14/areas/departments/security.md)
- [PR Guidelines](en/space-station-14/areas/departments/security/guidelines.md)
- [Service](en/space-station-14/areas/departments/service.md)
- [PR Guidelines](en/space-station-14/areas/departments/service/guidelines.md)

Design Proposals
================
Expand Down Expand Up @@ -194,6 +233,9 @@ Community
- [Space Wizards Role Hierarchy](en/community/space-wizards-role-hierarchy.md)
- [Space Wizards Maintainer List](en/community/space-wizards-maintainer-list.md)
- [Discord Rich Presence Repository](en/community/discord-rich-presence-repository.md)
- [Maintainer](en/community/maintainer.md)
- [Maintainer Policy](en/community/maintainer/wizards-den-maintainer-policy.md)
- [Review Policy](en/community/maintainer/wizards-den-review-policy.md)
- [Admin](en/community/admin.md)
- [Admin Tooling](en/community/admin/admin-tooling.md)
- [Admin Command Cookbook](en/community/admin/admin-tooling/admin-command-cookbook.md)
Expand Down
3 changes: 3 additions & 0 deletions src/en/community/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Maintainer

This section contains information on Maintaier and PR-Review Policies, **as it pertains to Wizards Den servers, hosted by Space Wizards.** These policies do not apply to other servers, and may be waived in exceptional circumstances.
5 changes: 5 additions & 0 deletions src/en/community/maintainer/wizards-den-maintainer-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Wizards Den Maintainer Policy

```admonish warning "Work in Progress"
This page is a work in progress! Maintainer policy will be posted when they are ready.
```
5 changes: 5 additions & 0 deletions src/en/community/maintainer/wizards-den-review-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Wizards Den Review Policy

```admonish warning "Work in Progress"
This page is a work in progress! Review policy will be posted when they are ready.
```
4 changes: 2 additions & 2 deletions src/en/general-development/feature-proposals.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you are considering adding or reworking some major component of the game it's

1. Make a copy of the design proposal template located at `src/en/templates/proposal.md`.

3. Read through [SS14's Core Design Documentation](../space-station-14/core-design.md) (for gameplay-related proposals).
3. Read through [SS14's Core Design Documentation](../space-station-14/design.md) (for gameplay-related proposals).

4. Write your proposal (see [guide to editing docs](../meta/guide-to-editing-docs.md)).

Expand Down Expand Up @@ -46,7 +46,7 @@ A good rule of thumb if the new feature or rework you have in mind would require
No idea! What design proposals do or do not get in is determined by maintainer approval like normal PRs. If you can get at least one maint to decide that it sounds like a good idea then there's a good chance that it will get accepted. Pretty much any idea is going to need at least some critiquing before it gets merged so don't get discouraged!

``` admonish tip "Design Principles"
If you want to improve your chances, it's recommended that you read the [SS14 Core Design Documentation](/src/en/space-station-14/core-design.md) document to get a high-level overview before you start writing, as it'll provide context for why things are the way they are.
If you want to improve your chances, it's recommended that you read the [SS14 Core Design Documentation](/src/en/space-station-14/design.md) document to get a high-level overview before you start writing, as it'll provide context for why things are the way they are.
PR'd design documents should also follow the [Decorum Guidelines](./feature-proposals/expected-feature-proposal-decorum.md).
```
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

Any documents proposed:

- Should conform to the basic [Core Game Design](../../space-station-14/core-design.md) as well as this document obviously.
- Should conform to the basic [Core Game Design](../../space-station-14/design.md) as well as this document obviously.
- Should contain sufficient justification for their existence,
- Can be closed or drafted at maintainer discretion,
- Are a reflection of SS14 to others that may be interested in how the game is designed. Take note of that.
Expand Down
57 changes: 57 additions & 0 deletions src/en/general-development/work-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
Work Groups
=====================
Work-groups are effectively the design equivalent to Code-Owners. Each work group is made up from maintainers that volunteer to upkeep the documentation and guidelines related to that area of the game. If you have a question about something related to one of the department/game areas feel free to message a member of its work group to get an authoritative answer.

Each work group is responsible for maintaining corresponding design and pr guidelines documents in the docs repo that outlines the current and intended design for that game area, along with what is acceptible design/quality for a PR in that game area. Maintainers that are not part of any work groups are generalists, and while they might not be fully up to date with the design of a game-area they can still help answer questions.


## Maintainer work groups:
This list is updated less than discord/github, for a more accurate list look at the github work-group teams or discord roles.

### Game-Wide
- [Accessibility:](../space-station-14/areas/core/accessibility.md)\
 Bhijn & Myr(deathride58), AJCM
- [Admin Tooling:](../space-station-14/areas/core/admin-tools.md)\
 Jezithyr, Chief-Engineer, Vasilis, Julian, Bhijn & Myr(deathride58)
- [Art:](../space-station-14/areas/core/art.md)\
 EmoGarbage, Flareguy
- [Character/Species:](../space-station-14/areas/core/characters-species.md)\
 Jezithyr, Lank, Vasilis, KeronSHB, Bhijn & Myr(deathride58), AJCM
- [Combat:](../space-station-14/areas/core/combat.md)\
 Jezithyr, EmoGarbage, AJCM, KeronSHB, Bhijn & Myr(deathride58)
- [Player Interaction:](../space-station-14/areas/core/player-interaction.md)\

- [Mapping:](../space-station-14/areas/core/mapping.md)\
 Emmise
- [Roleplay/Lore:](../space-station-14/areas/core/roleplay-lore.md)\
 Lank, KeronSHB, Vasilis
- [Round Flow:](../space-station-14/areas/core/round-flow.md)\
 Jezithyr, EmoGarbage, Tayrthan, KeronSHB, Bhijn & Myr(deathride58), AJCM
- [User Interface:](../space-station-14/areas/core/user-interface.md)\
 Jezithyr, EmoGarbage, AJCM, Julian, Bhijn & Myr(deathride58)

### Departments
- [Atmos:](../space-station-14/areas/departments/atmos.md)\
 Jezithyr, KeronSHB, NotAFet(PartMedia)
- [Cargo/Salvage:](../space-station-14/areas/departments/cargo-salvage.md)\

- [Command:](../space-station-14/areas/departments/command.md)\
 KeronSHB, EmoGarbage, Vasilis
- [Engineering:](../space-station-14/areas/departments/engineering.md)\
 Jezithyr, Julian, AJCM, KeronSHB
- [Medical:](../space-station-14/areas/departments/medical.md)\
 Jezithyr, Vasilis, AJCM,
- [Science:](../space-station-14/areas/departments/science.md)\
 Jezithyr, EmoGarbage, AJCM, Tayrtahn
- [Security:](../space-station-14/areas/departments/security.md)\
 Lank(LankLTE), KeronSHB
- [Service:](../space-station-14/areas/departments/service.md)\
 AJCM, Tayrtahn, NotAFet(PartMedia)

## For maintainers:

Work-groups are non exclusive, you can be in as many or as few as you want, however you should expect to be able to answer questions and be involved in the design of the area's that you have selected.

If you are not in a pr's associated work-group you can still review the PR, however you should make sure to read the relevant design documentation and PR guidelines before doing a review. Ideally, you should leave associated PRs to be reviewed by their work-group members, but it's fine to merge something as long as it fits the design and meets the guidelines.

If you plan on being involved with a workgroup for a long time, please add yourself to the above list. Likewise, if you are on the list and leave the workgroup with no intention of returning to it, you should remove yourself from the list.
2 changes: 1 addition & 1 deletion src/en/proposals/notafet-atmos.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Most atmos players currently agree that atmos is not very fun to play, for some

2. Atmos can't actually rectify atmos problems in a reasonable amount of time. For example, if there actually is a plasma leak, scrubbers typically work too slowly resulting in the plasma inevitably being lit before it can be cleaned up.

3. Atmos techs don't play with the rest of the station, preferring to isolate themselves to produce a funny green gas that is only particularly useful for shuttle bombing. Mechanics like this violate the [fundamental design principles](../space-station-14/core-design.md). While these mechanics shouldn't be removed per-se, more focus should be given to mechanics that increase interactions with the station, like making sure the air is breathable and well-heated.
3. Atmos techs don't play with the rest of the station, preferring to isolate themselves to produce a funny green gas that is only particularly useful for shuttle bombing. Mechanics like this violate the [fundamental design principles](../space-station-14/design.md). While these mechanics shouldn't be removed per-se, more focus should be given to mechanics that increase interactions with the station, like making sure the air is breathable and well-heated.

## Proposal

Expand Down
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/accessibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Accessibility

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# PR Guildlines

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/admin-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Admin Tooling

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/admin-tools/guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# PR Guildlines

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/art.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Art

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/art/guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# PR Guildlines

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# PR Guildlines

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/characters-species.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Character/Species

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/combat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Combat

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
File renamed without changes.
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/combat/guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# PR Guildlines

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
5 changes: 5 additions & 0 deletions src/en/space-station-14/areas/core/mapping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Mapping

```admonish warning "Attention: Placeholder!"
This section is a placeholder, pending a design-doc being created by the related work-group
```
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Making new rooms requires a saved map file and prototypes created specifying the

There is a template that can be used below. **Note that there is no limit to size or rooms.**

[dungeon_template.yml](../assets/misc/dungeon_template.yml)
[dungeon_template.yml](../../../../assets/misc/dungeon_template.yml)

## Mapping suggestions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,42 @@
# Mapping Checklist

{{#template ../../templates/outdated.md}}
# PR Guildlines

```admonish warning
This is an old page, and hasn't been updated in over a year. It does not reflect the current state of the game and should be updated as soon as possible.
The page will be updated by the mapping work group soon (tm).
Until then, consult other mappers, people with the "Head Mapper" role, and the #cartography discord channel as for what content should be present in your map. **This should not be your sole source of information.**
```


# Mapping sins
=======
Don't do any of these. They make for bad looking/feeling maps.

## Ultra-wide hallways
So the thing about hallways is that they're empty.
![oversized-hallway.png](../../../../assets/images/mapping/oversized-hallway.png)
This looks and feels bad to play in, with a very large amount of blank space visually.

### Ways to fix

#### Convert to a parkway
Filling the visual emptiness with plantlife or other decoratives helps significantly. This shouldn't be overdone, though, and it's preferrable to simply use smaller hallways.
![parkway-example.png](../../../../assets/images/mapping/parkway-example.png)

## Abdundance of silver/gold tiles
To put it simply they look terrible, especially combined with decals, and should be used only in extremely specific situations.
![silver-tiles-hell.png](../../../../assets/images/mapping/silver-tiles-hell.png)

### Ways to fix

#### Just change the theme
If you're using them to line a "rich feeling" room, say, the HoP's office, opt for instead focusing on a home-y feeling, with woods/etc. Most of the station simply does not have this feel and it'll make them seem exceptional.
![silver-tiles-hell-except-good.png](../../../../assets/images/mapping/silver-tiles-hell-except-good.png)


# Mapping Checklist
===========

This checklist is a general guide on what items are required for typical SS14 station maps. Small maps and non-standard maps may not be able to fit all the content specified, so use this as general guidelines only.

When necessary, the entity ID will be in brackets if it differs greatly from the name of the item. In most cases, you can just search the name. Names with suffixes such as `[filled]` indicate a variant of an entity.
Expand Down
Loading

0 comments on commit d4d8017

Please sign in to comment.