-
Notifications
You must be signed in to change notification settings - Fork 16
Reformat FAQ to use headings #119
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,65 @@ | ||
| # FAQ | ||
|
|
||
| **Q: What is Manual?** | ||
| **A:** Manual is a customizable apworld for Archipelago that can be applied to any game. You tell it what locations you want to be able to check and what items you want randomized, and it gets rolled into a multiworld as normal. Using the ManualClient program, you can manually check off locations that you've checked, and the client will tell you what items you now have access to use. Limiting what items you use is done manually by you until you see the item in the list. The victory condition is also up to you and, once you've completed it, there's a "Victory!" location at the bottom of the location list that you can click to end your seed. | ||
| ## Q: What is Manual? | ||
| Manual is a customizable apworld for Archipelago that can be applied to any game. You tell it what locations you want to be able to check and what items you want randomized, and it gets rolled into a multiworld as normal. Using the ManualClient program, you can manually check off locations that you've checked, and the client will tell you what items you now have access to use. Limiting what items you use is done manually by you until you see the item in the list. The victory condition is also up to you and, once you've completed it, there's a "Victory!" location at the bottom of the location list that you can click to end your seed. | ||
|
|
||
| **Q: Is the Manual apworld or this Discord server endorsed by Archipelago?** | ||
| **A:** No. Archipelago does not endorse or maintain any portion of Manual. Manual exists as an apworld because Archipelago allows non-endorsed game implementations to do so. This Discord server primarily exists because the main Archipelago server does not want to have a dedicated Manual section at this time. | ||
| ## Q: Is the Manual apworld or this Discord server endorsed by Archipelago? | ||
| No. Archipelago does not endorse or maintain any portion of Manual. Manual exists as an apworld because Archipelago allows non-endorsed game implementations to do so. This Discord server primarily exists because the main Archipelago server does not want to have a dedicated Manual section at this time. | ||
|
|
||
| **Q: ... But, like, how does it work? What mods do I need?** | ||
| **A:** There are no mods. You're the engine that makes it work! You manually perform the checks with the client, and you manually limit the items you can use in-game using the item list in the client. | ||
| ## ... But, like, how does it work? What mods do I need? | ||
| There are no mods. You're the engine that makes it work! You manually perform the checks with the client, and you manually limit the items you can use in-game using the item list in the client. | ||
|
|
||
| **Q: What games can I make a Manual apworld from?** | ||
| **A:** Literally anything. Since you are manually performing checks and manually limiting your items, you just do it alongside whatever game you're playing. It was originally built to help with AP integrations for games that either disallow modding or that are difficult to mod (like some console games). | ||
| ## What games can I make a Manual apworld from? | ||
| Literally anything. Since you are manually performing checks and manually limiting your items, you just do it alongside whatever game you're playing. It was originally built to help with AP integrations for games that either disallow modding or that are difficult to mod (like some console games). | ||
|
|
||
| It's also been noted that Manual may not work as well for more linear games. | ||
|
|
||
| **Q: Okay, cool! Where do I get started with making my own apworld?** | ||
| **A:** Check out the "How to start making a Manual" section of our documentation to get started! | ||
| ## Okay, cool! Where do I get started with making my own apworld? | ||
| Check out the "How to start making a Manual" section of our documentation to get started! | ||
|
|
||
| **Q: How can I get a channel for the Manual apworld that I created?** | ||
| **A:** Hop into our Discord and create it in the appropriate forum under "Games in Manual"! | ||
| ## How can I get a channel for the Manual apworld that I created? | ||
| Hop into our Discord and create it in the appropriate forum under "Games in Manual"! | ||
|
|
||
| **Q: I'm having an issue with Manual in general. Where should I post that?** | ||
| **A:** Post in the #manual-support channel in our Discord! | ||
| ## I'm having an issue with Manual in general. Where should I post that? | ||
| Post in the #manual-support channel in our Discord! | ||
|
|
||
| ## My game, or my Manual apworld's locations and items, are 18+. Is that allowed? | ||
|
|
||
| **Q: My game, or my Manual apworld's locations and items, are 18+. Is that allowed?** | ||
| **A:** | ||
| There's only two things to avoid here: | ||
| 1. Game names, location names or item names of a sensitive nature | ||
| 2. Screenshots or descriptions of game content of a sensitive nature | ||
|
|
||
| If the game name itself is 18+, you can't include it here. | ||
| If the locations/items would normally be 18+, you'll need to change those. | ||
| If the game name itself is 18+, you can't include it here. | ||
| If the locations/items would normally be 18+, you'll need to change those. | ||
|
|
||
| Beyond that, you can make a Manual apworld of anything, even something that's 18+. | ||
|
|
||
| **Q: What is the difference between a progression item, a useful item, and a filler item?** | ||
| **A:** | ||
| If your Manual can only be played on the After Dark server, we ask that you use the After Dark tag on your thread. | ||
|
|
||
| ## What is the difference between a progression item, a useful item, and a filler item? | ||
| - Progression items unlock or help to unlock a location check. Any location can have an important item, so these unlocking items need to be marked as progression. | ||
| - Useful items are items that you would prefer to get in the game, but that don't unlock any location checks. Stronger armor and weapons would be examples of things in this category. | ||
| - Filler items are items that can be found, but these items neither unlock location checks or meaningfully assist the player in completing the game. | ||
|
|
||
| In terms of generation, the world generation will prioritize progression items to make a beatable world, and progression items + useful items to make a properly seeded world for a normal playthrough. Filler items may or may not be excluded when the world runs out of locations to place items in. | ||
| ** ** | ||
|
|
||
| **Q: Can I share save files, patches, or mods that help with a Manual implementation?** | ||
| **A:** Yes! All three of those are fine, as long as the patches or mods do not contain material that is not allowed in our Discord rules. The patches or mods also cannot be a solution for game piracy, which is also disallowed by our rules. | ||
|
|
||
| **Q: Are there any requirements for game.json entries for "game" and "creator" ("player" in legacy versions)?** | ||
| **A:** Yes, the "game" entry must each contain at least 5 letters or numbers, and the "creator" / "player" entry must contain at least 3. | ||
| ## Can I share save files, patches, or mods that help with a Manual implementation? | ||
| Yes! All three of those are fine, as long as the patches or mods do not contain material that is not allowed in our Discord rules. The patches or mods also cannot be a solution for game piracy, which is also disallowed by our rules. | ||
|
|
||
| **Q: Is the code for Manual publicly available?** | ||
| **A:** Yes! The code for Manual exists in its own repository on Github here: https://github.com/ManualForArchipelago/Manual | ||
| ## Is the code for Manual publicly available? | ||
| Yes! The code for Manual exists in its own repository on Github here: https://github.com/ManualForArchipelago/Manual | ||
|
|
||
| **Q: I found a Manual apworld that I want to play. The game name for that apworld has someone else's name in it. Do I need to change that to my name?** | ||
| **A:** Nope! The only part of the process that's unique to you is your YAML file. Just set your player name in there like you would with any other game, and you're good to go. | ||
| ## I found a Manual apworld that I want to play. The game name for that apworld has someone else's name in it. Do I need to change that to my name? | ||
| Nope! The only part of the process that's unique to you is your YAML file. Just set your player name in there like you would with any other game, and you're good to go. | ||
|
|
||
| For reference, the user's name in the game name of an apworld is the person that *created* the apworld. This is only so that multiple people can have their own fundamentally different approaches to making a randomizer for their favorite game. You should only ever need to change this if you're creating an apworld from scratch, not when you play one. | ||
|
|
||
| **Q: Can I make a Manual for a game that already has one?** | ||
| **A:** Absolutely! That's the purpose of the creator name at the end of the apworld. You can put your own twist on any of them! | ||
| ## Can I make a Manual for a game that already has one? | ||
| Absolutely! That's the purpose of the creator name at the end of the apworld. You can put your own twist on any of them! | ||
|
|
||
| **Q: Someone mentioned the "unstable" build. Where can I find that?** | ||
| **A:** Pins in the #manual-unstable channel in our Discord! | ||
| ## Someone mentioned the "unstable" build. Where can I find that? | ||
| Pins in the #manual-unstable channel in our Discord! | ||
|
|
||
| **Q: When looking through the games forums, I've noticed some tags like #Fishing, #RemixItUp, etc. What are these for?** | ||
| **A:** From time to time, our event staff likes to run official Manual asyncs based on a theme. These events encourage people to make fun themed versions of their favorite games! Since these worlds are often different from the normal game/rando, we tag them for the event so people know they're themed. | ||
| ## When looking through the games forums, I've noticed some tags like #Fishing, #RemixItUp, etc. What are these for? | ||
| From time to time, our event staff likes to run official Manual asyncs based on a theme. These events encourage people to make fun themed versions of their favorite games! Since these worlds are often different from the normal game/rando, we tag them for the event so people know they're themed. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.