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: rework main ap setup guide #1853

Merged
merged 5 commits into from
Jun 29, 2023

Conversation

alwaysintreble
Copy link
Collaborator

What is this fixing or adding?

Reverts using the website and the local software for using Archipelago back into a single guide, instead of assuming the user knows how to do things already. Renames it to "Getting Started" to help incentivize reading it before referring to the game specific guides. Adds a section detailing the website room layout and information, as well as describing all of the connection info fields for games that use it.

How was this tested?

📖

If this makes graphical changes, please attach screenshots.

Screenshot_1

@ThePhar ThePhar added the is: documentation Improvements or additions to documentation. label Jun 2, 2023
Copy link
Member

@Exempt-Medic Exempt-Medic left a comment

Choose a reason for hiding this comment

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

General wording changes for grammar and clarity

worlds/generic/docs/example_room.png Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Show resolved Hide resolved
@ThePhar ThePhar self-requested a review June 27, 2023 21:48
Copy link
Member

@ThePhar ThePhar left a comment

Choose a reason for hiding this comment

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

Couple points, but otherwise it's fine. Most of it does only apply to Windows however, so a note should be added somewhere about that.

worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Show resolved Hide resolved
@ThePhar ThePhar self-assigned this Jun 27, 2023
@alwaysintreble alwaysintreble requested a review from ThePhar June 27, 2023 22:24
Copy link
Collaborator

@PoryGone PoryGone left a comment

Choose a reason for hiding this comment

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

Suggested a few grammatical/wording adjustments

worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved

For connecting from the game to the server, the connection info is needed for any of the game clients. Games that use
data files will usually contain the connection info within these files, when hosted on the Archipelago website. If the
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this true? I know LttP does this, but do most/any others? I don't believe DKC3 or SMW do.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Factorio, OoT, SM, and Minecraft do. Not sure on some of the others, but I think a significant enough amount to use the term "usually".

Copy link
Member

@ThePhar ThePhar left a comment

Choose a reason for hiding this comment

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

This looks good to me, only thing that needs to be done needs to change the references to using_website_en resource which will now all be dead links (including site map in footer)

worlds/overcooked2/docs/setup_en.md
worlds/soe/docs/multiworld_en.md
WebHostLib/templates/siteMap.html

Also you never added that Windows disclaimer I mentioned. :sadcat:
image

@ThePhar ThePhar mentioned this pull request Jun 28, 2023
@ThePhar ThePhar merged commit 122d404 into ArchipelagoMW:main Jun 29, 2023
@alwaysintreble alwaysintreble deleted the ap_setup_revamp branch July 26, 2023 22:19
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
* rework main ap setup guide

* review updates

* add blurb about re-opening rooms and user-content

* more review suggestions

* remove dead links. Windows blurb
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
* rework main ap setup guide

* review updates

* add blurb about re-opening rooms and user-content

* more review suggestions

* remove dead links. Windows blurb
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.

4 participants