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: Update regarding new launcher #2627

Merged
merged 24 commits into from
Jan 5, 2024

Conversation

ReverM
Copy link
Contributor

@ReverM ReverM commented Dec 25, 2023

What is this fixing or adding?

Updating world docs wr/ to the launcher changes introduced in 0.4.4
More precisely, clients are automatically installed with AP (you don't need to tick them during installation) and thus, you do not need to provide the roms on installation, only during patching/generation.

How was this tested?

Reading

Here is a tasklist to keep track of which games need to be reviewed

  • Archipelago Install guide
  • Adventure
  • ALTTP
  • Checksfinder
  • DKC3
  • FFMQ
  • LaDX
  • Lufia 2
  • Minecraft
  • MMBN3
  • OOT
  • Super Metroid
  • Super Mario World
  • SMZ3
  • Undertale
  • Zillion

@ReverM ReverM changed the title Launcher setup cleanup Docs: Update regarding new launcher Dec 25, 2023
@ReverM ReverM marked this pull request as ready for review December 25, 2023 18:39
worlds/smw/docs/setup_en.md Outdated Show resolved Hide resolved
@jonloveslegos
Copy link
Contributor

Checksfinder and Undertale look fine.

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.

I know I'm not the maintainer for any of these games, but looked over at least the games I'm familiar with (ALTTP, DKC3, LADX, OOT, and SMW) and the changes for those games look good to me.

Copy link
Contributor

@Alchav Alchav left a comment

Choose a reason for hiding this comment

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

Approve FFMQ section

Updated the main AP guide about AP installation to reflect launcher changes
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

@ScipioWright ScipioWright added the is: documentation Improvements or additions to documentation. label Dec 27, 2023
a legally obtained ROM for that game as well.
- The `Clients` are what are used to connect your game to the multiworld. Some games use a client that is automatically
installed with an Archipelago installation. You can access those clients via the launcher or by navigating
to your Archipelago installation.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would add a note that if they don't see a client, they will need to check the game page to learn how to set up the necessary connection to the multiworld

Copy link
Contributor Author

@ReverM ReverM Jan 3, 2024

Choose a reason for hiding this comment

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

I chose not to because I believe every player should check the respective setup guide.
i.e some games have a preinstalled client but still need a particular setup.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe just a note directing them to always look at the game setup? most people seem to check those first anyway but it might be good to direct them here too. I guess I just don't trust people to look in the right spots. But it's not a point of contention. just a thought

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe a link could be added in the connecting section

@BootsinSoots
Copy link
Contributor

Adventure Minecraft and SMZ3 look fine - most of the changes are just removing the bit about checking the box, which is really all that needs to be done here, I think

The update to actual generation feels good

Copy link
Contributor

@lordlou lordlou left a comment

Choose a reason for hiding this comment

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

I approve SM and SMZ3 changes.

@ThePhar
Copy link
Member

ThePhar commented Jan 4, 2024

I'm just going to take the executive decision to merge this so the website can get these updates since we're needing to update anyway.

Edit: nevermind, i was too slow lol. still approving though.

@ThePhar ThePhar merged commit 064a7bf into ArchipelagoMW:main Jan 5, 2024
7 checks passed
@ReverM ReverM deleted the launcher-setup-cleanup branch January 5, 2024 04:33
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
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.