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.

Sign up for GitHub

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

Jump to bottom

DOCS: Adding instructions about how to add external apworlds #4490

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

DOCS: Adding instructions about how to add external apworlds #4490

wants to merge 16 commits into from
+22 −0

Conversation

ReverM
Copy link
Contributor

@ReverM ReverM commented Jan 16, 2025

Please format your title with what portion of the project this pull request is
targeting and what it's changing.

ex. "MyGame4: implement new game" or "Docs: add new guide for customizing MyGame3"

What is this fixing or adding?

Adding a new paragraph to the setup guide about how to install apworlds.

How was this tested?

Proofread by Exempt.

If this makes graphical changes, please attach screenshots.

image

@github-actions github-actions bot added is: documentation Improvements or additions to documentation. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Jan 16, 2025
@ReverM @Exempt-Medic
Update worlds/generic/docs/setup_en.md
f36ccca 
Proofier-comitting

Co-authored-by: Exempt-Medic <[email protected]>
nicholassaylor
nicholassaylor approved these changes Jan 16, 2025
View reviewed changes
Copy link
Contributor

@nicholassaylor nicholassaylor left a comment

Choose a reason for hiding this comment

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

As AP becomes increasingly larger and less centralized to what is provided on the main site, I support this addition. After reading through everything, everything LGTM.

The claim that the official server only contains trustworthy apworlds seems a little suspect, so I suggest that other people weigh in if the official server is going to be asserted as only providing "legitimate" (free of malicious code) apworlds.

@ReverM
Copy link
Contributor Author

ReverM commented Jan 16, 2025

As AP becomes increasingly larger and less centralized to what is provided on the main site, I support this addition. After reading through everything, everything LGTM.

The claim that the official server only contains trustworthy apworlds seems a little suspect, so I suggest that other people weigh in if the official server is going to be asserted as only providing "legitimate" (free of malicious code) apworlds.

I can always remove that sentence if needed

@nicholassaylor
Copy link
Contributor

Yeah, I figured that I'd bring it up as food for thought.

@silasary
Copy link
Contributor

Yeah, I don't think the moderation is hands-on enough to guarantee that every apworld posted in #future-game-design is safe and trustworthy.

@github-actions github-actions bot added the affects: webhost Issues/PRs that touch webhost and may need additional validation. label Jan 16, 2025
@ReverM
Copy link
Contributor Author

ReverM commented Jan 16, 2025 •
edited
Loading

Yeah, I don't think the moderation is hands-on enough to guarantee that every apworld posted in #future-game-design is safe and trustworthy.

Removed. Slightly changed the end of the sentence too.

@Exempt-Medic Exempt-Medic added waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. and removed waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Jan 22, 2025
Exempt-Medic
Exempt-Medic requested changes Jan 23, 2025
View reviewed changes
WebHostLib/templates/supportedGames.html Outdated Show resolved Hide resolved
worlds/generic/docs/setup_en.md Outdated Show resolved Hide resolved
@Exempt-Medic Exempt-Medic removed the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label Jan 24, 2025
@Exempt-Medic Exempt-Medic added waiting-on: author Issue/PR is waiting for feedback or changes from its author. and removed waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. labels Jan 24, 2025
@ReverM ReverM requested a review from Exempt-Medic January 30, 2025 05:18
NewSoupVi
NewSoupVi requested changes Jan 30, 2025
View reviewed changes
Copy link
Member

@NewSoupVi NewSoupVi left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Other core maintainers have made Medic and I aware that double-clicking to install only works on Windows. This should be stated if possible.

Edit: Apparently, the custom_worlds folder might also have a different name on Linux. Idk though, good luck

KonoTyran
KonoTyran reviewed Jan 30, 2025
View reviewed changes
worlds/generic/docs/setup_en.md
Archipelago.

We strongly recommend that you make sure that the source of the `.apworld` is safe and trustworthy before playing with a
custom world.
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 suggest a bit more clarity here that you should make sure it's trustworthy because it can run code on your pc, the same as any executable file would.

@KonoTyran
Copy link
Contributor

Other core maintainers have made Medic and I aware that double-clicking to install only works on Windows. This should be stated if possible.

Edit: Apparently, the custom_worlds folder might also have a different name on Linux. Idk though, good luck

Yea ran into this with big when he was testing the new minecraft client on Ubuntu, it was in his home directory, and just called "worlds"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KonoTyran KonoTyran KonoTyran left review comments

@NewSoupVi NewSoupVi NewSoupVi requested changes

@nicholassaylor nicholassaylor nicholassaylor approved these changes

@silasary silasary silasary approved these changes

@Exempt-Medic Exempt-Medic Awaiting requested review from Exempt-Medic

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
affects: webhost Issues/PRs that touch webhost and may need additional validation. is: documentation Improvements or additions to documentation. waiting-on: author Issue/PR is waiting for feedback or changes from its author.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@ReverM @nicholassaylor @silasary @KonoTyran @NewSoupVi @Exempt-Medic