Skip to content
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.

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

Docs, Various Games: Add Unique Local Commands to Game Page #2285

Merged
merged 14 commits into from
Oct 31, 2023

Conversation

nicholassaylor
Copy link
Contributor

@nicholassaylor nicholassaylor commented Oct 9, 2023

What is this fixing or adding?

Adds the commands unique to various clients to the appropriate game page.
This PR is in response to the discussion on #2213 concerning where these client commands should be documented.

Commands were pulled from their respective client python files. If any were missed, please let me know so that I can add them.

Additionally, it might be in our interest to require that world maintainers include these commands to their game page. This is not enforced in this PR, but I figured this would be a good place to spark that discussion.

Affected Games and CodeOwners:

How was this tested?

Was not, doc change

@nicholassaylor nicholassaylor marked this pull request as ready for review October 9, 2023 00:10
Copy link
Collaborator

@t3hf1gm3nt t3hf1gm3nt left a comment

Choose a reason for hiding this comment

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

TLOZ section LGTM

Copy link
Collaborator

@beauxq beauxq left a comment

Choose a reason for hiding this comment

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

Zillion section lgtm

Copy link
Collaborator

@jtoyoda jtoyoda left a comment

Choose a reason for hiding this comment

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

FFR is approved

Copy link
Collaborator

@FlySniper FlySniper left a comment

Choose a reason for hiding this comment

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

Wargroove is approved.

@LegendaryLinux
Copy link
Member

Markdown changes in general look okay. Will wait a while for affected world maintainers to respond.

@LegendaryLinux LegendaryLinux self-assigned this Oct 11, 2023
@Bicoloursnake
Copy link
Contributor

Sorry to add more to this list, but StarCraft 2 has several unique commands missing from this list. Their implementation can be found at worlds/sc2wol/Client.py and how their current descriptions can be found in the image below.
image

@nicholassaylor
Copy link
Contributor Author

nicholassaylor commented Oct 14, 2023

Sorry to add more to this list, but StarCraft 2 has several unique commands missing from this list. Their implementation can be found at worlds/sc2wol/Client.py

Thank you for bringing this up. I recognized that I would be missing some clients since not all of them use the CommonClient. I have added these commands in 5396b56

@ThePhar ThePhar added the is: documentation Improvements or additions to documentation. label Oct 17, 2023
@LegendaryLinux
Copy link
Member

At this point, I think everyone who is going to give an approval will. I'll leave my approval here, and if nobody has any objections before I stumble through this PR again in a week or so, I'll merge.

@LegendaryLinux LegendaryLinux merged commit 560c57f into ArchipelagoMW:main Oct 31, 2023
7 checks passed
nicholassaylor added a commit to nicholassaylor/Archipelago that referenced this pull request Nov 7, 2023
@nicholassaylor nicholassaylor deleted the client-commands branch November 7, 2023 17:53
ThePhar pushed a commit that referenced this pull request Nov 7, 2023
Co-authored-by: jonloveslegos <[email protected]>
Co-authored-by: kindasneaki <[email protected]>
Co-authored-by: ScootyPuffJr1 <[email protected]>
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
…agoMW#2285)

* Add Unique Locals Commands to ChecksFinder

* Add Unique Locals Commands to MMBN3 Game Page

* Add Unique Locals Commands to Ocarina of Time Game Page

* Add Unique Locals Commands to Undertale Game Page

* Add Unique Locals Commands to Wargroove Game Page

* Add Unique Locals Commands to The Legend of Zelda Game Page

* Add Unique Locals Commands to Zillion Game Page

* Amend Unique Locals Commands on Final Fantasy 1 Game Page

* Add Unique Locals Commands to Pokemon R/B Game Page

* Grammar fix for FF1

* Corrected sections names to match

* Added commands to Starcraft 2 Wings of Liberty game page

Co-authored-by: Bicoloursnake <[email protected]>

---------

Co-authored-by: Bicoloursnake <[email protected]>
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
…ipelagoMW#2435)

Co-authored-by: jonloveslegos <[email protected]>
Co-authored-by: kindasneaki <[email protected]>
Co-authored-by: ScootyPuffJr1 <[email protected]>
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
…agoMW#2285)

* Add Unique Locals Commands to ChecksFinder

* Add Unique Locals Commands to MMBN3 Game Page

* Add Unique Locals Commands to Ocarina of Time Game Page

* Add Unique Locals Commands to Undertale Game Page

* Add Unique Locals Commands to Wargroove Game Page

* Add Unique Locals Commands to The Legend of Zelda Game Page

* Add Unique Locals Commands to Zillion Game Page

* Amend Unique Locals Commands on Final Fantasy 1 Game Page

* Add Unique Locals Commands to Pokemon R/B Game Page

* Grammar fix for FF1

* Corrected sections names to match

* Added commands to Starcraft 2 Wings of Liberty game page

Co-authored-by: Bicoloursnake <[email protected]>

---------

Co-authored-by: Bicoloursnake <[email protected]>
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
…ipelagoMW#2435)

Co-authored-by: jonloveslegos <[email protected]>
Co-authored-by: kindasneaki <[email protected]>
Co-authored-by: ScootyPuffJr1 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants