Skip to content

Commit 36e0c6c

Browse files
authored
Merge pull request #119 from ManualForArchipelago/faqs
Reformat FAQ to use headings
2 parents 4ce6a69 + f4dfa7d commit 36e0c6c

File tree

1 file changed

+33
-35
lines changed

1 file changed

+33
-35
lines changed

docs/faq/general.md

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,65 @@
11
# FAQ
22

3-
**Q: What is Manual?**
4-
**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.
3+
## Q: What is Manual?
4+
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.
55

6-
**Q: Is the Manual apworld or this Discord server endorsed by Archipelago?**
7-
**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.
6+
## Q: Is the Manual apworld or this Discord server endorsed by Archipelago?
7+
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.
88

9-
**Q: ... But, like, how does it work? What mods do I need?**
10-
**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.
9+
## ... But, like, how does it work? What mods do I need?
10+
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.
1111

12-
**Q: What games can I make a Manual apworld from?**
13-
**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).
12+
## What games can I make a Manual apworld from?
13+
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).
1414

1515
It's also been noted that Manual may not work as well for more linear games.
1616

17-
**Q: Okay, cool! Where do I get started with making my own apworld?**
18-
**A:** Check out the "How to start making a Manual" section of our documentation to get started!
17+
## Okay, cool! Where do I get started with making my own apworld?
18+
Check out the "How to start making a Manual" section of our documentation to get started!
1919

20-
**Q: How can I get a channel for the Manual apworld that I created?**
21-
**A:** Hop into our Discord and create it in the appropriate forum under "Games in Manual"!
20+
## How can I get a channel for the Manual apworld that I created?
21+
Hop into our Discord and create it in the appropriate forum under "Games in Manual"!
2222

23-
**Q: I'm having an issue with Manual in general. Where should I post that?**
24-
**A:** Post in the #manual-support channel in our Discord!
23+
## I'm having an issue with Manual in general. Where should I post that?
24+
Post in the #manual-support channel in our Discord!
25+
26+
## My game, or my Manual apworld's locations and items, are 18+. Is that allowed?
2527

26-
**Q: My game, or my Manual apworld's locations and items, are 18+. Is that allowed?**
27-
**A:**
2828
There's only two things to avoid here:
2929
1. Game names, location names or item names of a sensitive nature
3030
2. Screenshots or descriptions of game content of a sensitive nature
3131

32-
If the game name itself is 18+, you can't include it here.
33-
If the locations/items would normally be 18+, you'll need to change those.
32+
If the game name itself is 18+, you can't include it here.
33+
If the locations/items would normally be 18+, you'll need to change those.
3434

3535
Beyond that, you can make a Manual apworld of anything, even something that's 18+.
3636

37-
**Q: What is the difference between a progression item, a useful item, and a filler item?**
38-
**A:**
37+
If your Manual can only be played on the After Dark server, we ask that you use the After Dark tag on your thread.
38+
39+
## What is the difference between a progression item, a useful item, and a filler item?
3940
- 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.
4041
- 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.
4142
- Filler items are items that can be found, but these items neither unlock location checks or meaningfully assist the player in completing the game.
4243

4344
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.
4445
** **
4546

46-
**Q: Can I share save files, patches, or mods that help with a Manual implementation?**
47-
**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.
48-
49-
**Q: Are there any requirements for game.json entries for "game" and "creator" ("player" in legacy versions)?**
50-
**A:** Yes, the "game" entry must each contain at least 5 letters or numbers, and the "creator" / "player" entry must contain at least 3.
47+
## Can I share save files, patches, or mods that help with a Manual implementation?
48+
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.
5149

52-
**Q: Is the code for Manual publicly available?**
53-
**A:** Yes! The code for Manual exists in its own repository on Github here: https://github.com/ManualForArchipelago/Manual
50+
## Is the code for Manual publicly available?
51+
Yes! The code for Manual exists in its own repository on Github here: https://github.com/ManualForArchipelago/Manual
5452

55-
**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?**
56-
**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.
53+
## 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?
54+
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.
5755

5856
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.
5957

60-
**Q: Can I make a Manual for a game that already has one?**
61-
**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!
58+
## Can I make a Manual for a game that already has one?
59+
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!
6260

63-
**Q: Someone mentioned the "unstable" build. Where can I find that?**
64-
**A:** Pins in the #manual-unstable channel in our Discord!
61+
## Someone mentioned the "unstable" build. Where can I find that?
62+
Pins in the #manual-unstable channel in our Discord!
6563

66-
**Q: When looking through the games forums, I've noticed some tags like #Fishing, #RemixItUp, etc. What are these for?**
67-
**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.
64+
## When looking through the games forums, I've noticed some tags like #Fishing, #RemixItUp, etc. What are these for?
65+
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.

0 commit comments

Comments
 (0)