WIP: Seafluff Guidebook changes. #1043

Allycat · 2026-10-09T16:43:57Z

Allycat commented

2026-10-09 16:43:57 +00:00

First-time contributor

Short description

Adding Byrd section, with SOP and space law and other updates.

Why we need to add this

Seafluff's Guidebook changes, I just did coding and fixed some errors. Seafluff can answer queries about need.

Checklist

I do not require assistance to complete the PR.
I have verified that the changes work before posting/requesting review of my PR.
I have added screenshots/videos of the changes, or this PR does not change in-game mechanics.
I have read the Pull Request and Changelog Guidelines and Byrd Station's Contributor Ruleset.

Breaking changes

None

[guidelines]: https://docs.spacestation14.com/en/general-development/codebase-info/pull-request-guidelines.html [ruleset]: https://rules.byrdstation.space/#h.vigrxrnffwji ## Short description Adding Byrd section, with SOP and space law and other updates. ## Why we need to add this Seafluff's Guidebook changes, I just did coding and fixed some errors. Seafluff can answer queries about need. ## Checklist  - [X] I do not require assistance to complete the PR. - [X] I have verified that the changes work before posting/requesting review of my PR. - [X] I have added screenshots/videos of the changes, or this PR does not change in-game mechanics. - [X] I have read the [Pull Request and Changelog Guidelines][guidelines] and [Byrd Station's Contributor Ruleset][ruleset]. ## Breaking changes None

Allycat added 9 commits

2026-10-09 16:43:57 +00:00

Resources/ServerInfo/Guidebook/_Byrd 3e526b8259

Resources/ServerInfo/Guidebook/_Byrd 90637695ee

Resources/ServerInfo/Guidebook/_Byrd cf7c7a2394

Resources/ServerInfo/Guidebook/_Byrd 1f53d750fb

Resources/ServerInfo/Guidebook/_Byrd f215161c73

Resources/ServerInfo/Guidebook/_Byrd/SOP 2be4cd921d

Resources/ServerInfo/Guidebook/_Byrd/SOP c77871d9a0

Resources/Prototypes/_Byrd/Guidebook

Close PRs on master / run (pull_request_target) Has been skipped

Details

Labels: PR / labeler (pull_request_target) Successful in 5s

Details

Labels: Size / size-label (pull_request_target) Failing after 4s

Details

PR Changelogs / changelog (pull_request_target) Has been skipped

Details

CRLF Check / CRLF Check (pull_request) Has been cancelled

Details

Test Packaging / Test Packaging (pull_request) Has been cancelled

Details

RGA schema validator / YAML RGA schema validator (pull_request) Has been cancelled

Details

RSI Validator / Validate RSIs (pull_request) Has been cancelled

Details

Map file schema validator / YAML map schema validator (pull_request) Has been cancelled

Details

YAML Linter / YAML Linter (pull_request) Has been cancelled

Details

2b5b114ede

Resources/Locale/en-US/guidebook

Close PRs on master / run (pull_request_target) Has been skipped

Details

Labels: PR / labeler (pull_request_target) Successful in 5s

Details

Labels: Size / size-label (pull_request_target) Failing after 3s

Details

CRLF Check / CRLF Check (pull_request) Failing after 35s

Details

Test Packaging / Test Packaging (pull_request) Successful in 15m28s

Details

RGA schema validator / YAML RGA schema validator (pull_request) Successful in 45s

Details

RSI Validator / Validate RSIs (pull_request) Successful in 44s

Details

Map file schema validator / YAML map schema validator (pull_request) Successful in 5m44s

Details

YAML Linter / YAML Linter (pull_request) Successful in 5m34s

Details

7e2d32f4f3

byrdbot added the

Changes: No C#

label

2026-10-09 16:44:03 +00:00

EchoOfNothing reviewed

2026-10-14 20:44:41 +00:00

EchoOfNothing left a comment

The SOP is not accessible in-game.

You have to place xml and yaml files under the Resources directory/folder.
In this case, yaml files in Resources/Prototypes/_Byrd/Guidebook and xml files in Resources/ServerInfo/Guidebook/_Byrd (Additional folder can be made to make it look nicer, more organized)

The SOP is not accessible in-game. ![guidebook](/attachments/96eed5df-58aa-4394-9267-943f06e56f02) You have to place xml and yaml files under the `Resources` directory/folder. In this case, yaml files in `Resources/Prototypes/_Byrd/Guidebook` and xml files in `Resources/ServerInfo/Guidebook/_Byrd` (Additional folder can be made to make it look nicer, more organized)

guidebook.png

47 KiB

EchoOfNothing commented

2026-10-14 21:46:41 +00:00

I also recommend hiding the old sop to avoid confusion

Allycat commented

2026-10-14 23:41:26 +00:00

First-time contributor

@EchoOfNothing wrote in #1043 (comment):

The SOP is not accessible in-game. You have to place xml and yaml files under the Resources directory/folder. In this case, yaml files in Resources/Prototypes/_Byrd/Guidebook and xml files in Resources/ServerInfo/Guidebook/_Byrd (Additional folder can be made to make it look nicer, more organized)

Scroll down. It's in a different section labeled Byrd.

However I cannot say why, as I was organizing it based on Seafluff's direction. If changes need to be made, they should be involved in it.

@EchoOfNothing wrote in https://git.byrdstation.space/Byrd-Station/Byrd/pulls/1043#issuecomment-9083: > The SOP is not accessible in-game. [![guidebook](/attachments/96eed5df-58aa-4394-9267-943f06e56f02)](/Byrd-Station/Byrd/attachments/96eed5df-58aa-4394-9267-943f06e56f02) You have to place xml and yaml files under the `Resources` directory/folder. In this case, yaml files in `Resources/Prototypes/_Byrd/Guidebook` and xml files in `Resources/ServerInfo/Guidebook/_Byrd` (Additional folder can be made to make it look nicer, more organized) Scroll down. It's in a different section labeled Byrd. However I cannot say why, as I was organizing it based on Seafluff's direction. If changes need to be made, they should be involved in it.

EchoOfNothing commented

2026-10-15 08:19:48 +00:00

@Allycat wrote in #1043 (comment):

Scroll down. It's in a different section labeled Byrd.

However I cannot say why, as I was organizing it based on Seafluff's direction. If changes need to be made, they should be involved in it.

There is no where left to scroll that's the screenshot of the entire guidebook. Byrd category doesn't exist because the files were not place where they belong. And also Seafluff told me that the Byrd category is supposed to replace the old sop category (if you don't know how to do this tell me, I will explain how to achieve this in more detail).

@Allycat wrote in https://git.byrdstation.space/Byrd-Station/Byrd/pulls/1043#issuecomment-9116: > Scroll down. It's in a different section labeled Byrd. > > However I cannot say why, as I was organizing it based on Seafluff's direction. If changes need to be made, they should be involved in it. There is no where left to scroll that's the screenshot of the entire guidebook. `Byrd` category doesn't exist because the files were not place where they belong. And also Seafluff told me that the `Byrd` category is supposed to replace the old sop category (if you don't know how to do this tell me, I will explain how to achieve this in more detail).

EchoOfNothing reviewed

2026-10-15 08:21:05 +00:00

Byrd.yml

					
				@ -0,0 +69,4 @@

				  name: guide-entry-byrdknowledge

				  priority: 6

				  text: "/ServerInfo/Guidebook/_Byrd/ByrdKnowledge.xml"

				#ByrdStation SOP Entries begin here

I recommend replacing #ByrdStation SOP Entries begin here with #region SOP or #region ByrdStation SOP (but I think adding ByrdStation here is quite redundant since it's already in the file called Byrd.yml) and #Byrdstation SOP entries end with #endregion. This way most IDEs will let you collapse those regions nicely, making reading and navigating the file easier.

I recommend replacing `#ByrdStation SOP Entries begin here` with `#region SOP` or `#region ByrdStation SOP` (but I think adding `ByrdStation` here is quite redundant since it's already in the file called `Byrd.yml`) and `#Byrdstation SOP entries end` with `#endregion`. This way most IDEs will let you collapse those regions nicely, making reading and navigating the file easier.

I am aware of how to do it, it seems there just was A. a miscommunication with Seafluff and myself, and B. an error when the PR was made. I'm newer to the forgejo/codeberg setup and so likely mixed up a couple things when manually making the PR (I manually uploaded the files and likely swapped guidebook and _byrd in location).

But it was all well organized, for the purposes I was aware of.

If you'd like to discuss more, I'd rather we just talk on discord if that works

I am aware of how to do it, it seems there just was A. a miscommunication with Seafluff and myself, and B. an error when the PR was made. I'm newer to the forgejo/codeberg setup and so likely mixed up a couple things when manually making the PR (I manually uploaded the files and likely swapped guidebook and _byrd in location). But it was all well organized, for the purposes I was aware of. If you'd like to discuss more, I'd rather we just talk on discord if that works