Skip to content

Commit

Permalink
Merge pull request ArchipelagoMW#159 from ArchipelagoMW/docs_consolid…
Browse files Browse the repository at this point in the history
…ation

Docs Consolidation
  • Loading branch information
Ijwu authored Jan 17, 2022
2 parents 22b361c + 38b98a9 commit 5d356d5
Show file tree
Hide file tree
Showing 44 changed files with 1,627 additions and 1,035 deletions.
63 changes: 37 additions & 26 deletions WebHostLib/static/assets/faq/faq_en.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,63 @@
# Frequently Asked Questions

## What is a randomizer?
A randomizer is a modification of a video game which reorganizes the items required to progress through the game.
A normal play-through of a game might require you to use item A to unlock item B, then C, and so forth. In a
randomized game, you might first find item C, then A, then B.

A randomizer is a modification of a video game which reorganizes the items required to progress through the game. A
normal play-through of a game might require you to use item A to unlock item B, then C, and so forth. In a randomized
game, you might first find item C, then A, then B.

This transforms games from a linear experience into a puzzle, presenting players with a new challenge each time they
play a randomized game. Putting items in non-standard locations can require the player to think about the game world
and the items they encounter in new and interesting ways.
play a randomized game. Putting items in non-standard locations can require the player to think about the game world and
the items they encounter in new and interesting ways.

## What happens if an item is placed somewhere it is impossible to get?
The randomizer has many strict sets of rules it must follow when generating a game. One of the functions of these
rules is to ensure items necessary to complete the game will be accessible to the player. Many games also have a
subset of rules allowing certain items to be placed in normally unreachable locations, provided the player has
indicated they are comfortable exploiting certain glitches in the game.

The randomizer has many strict sets of rules it must follow when generating a game. One of the functions of these rules
is to ensure items necessary to complete the game will be accessible to the player. Many games also have a subset of
rules allowing certain items to be placed in normally unreachable locations, provided the player has indicated they are
comfortable exploiting certain glitches in the game.

## What is a multi-world?
While a randomizer shuffles a game, a multi-world randomizer shuffles that game for multiple players. For example,
in a two player multi-world, players A and B each get their own randomized version of a game, called seeds. In each
player's game, they may find items which belong to the other player. If player A finds an item which belongs to
player B, the item will be sent to player B's world over the internet.

While a randomizer shuffles a game, a multi-world randomizer shuffles that game for multiple players. For example, in a
two player multi-world, players A and B each get their own randomized version of a game, called seeds. In each player's
game, they may find items which belong to the other player. If player A finds an item which belongs to player B, the
item will be sent to player B's world over the internet.

This creates a cooperative experience during multi-world games, requiring players to rely upon each other to complete
their game.

## What happens if a person has to leave early?
If a player must leave early, they can use Archipelago's forfeit system. When a player forfeits their game, all
the items in that game which belong to other players are sent out automatically, so other players can continue to
play.

If a player must leave early, they can use Archipelago's forfeit system. When a player forfeits their game, all the
items in that game which belong to other players are sent out automatically, so other players can continue to play.

## What does multi-game mean?
While a multi-world game traditionally requires all players to be playing the same game, a multi-game multi-world
allows players to randomize any of a number of supported games, and send items between them. This allows players of
different games to interact with one another in a single multiplayer environment.

While a multi-world game traditionally requires all players to be playing the same game, a multi-game multi-world allows
players to randomize any of a number of supported games, and send items between them. This allows players of different
games to interact with one another in a single multiplayer environment.

## Can I generate a single-player game with Archipelago?

Yes. All our supported games can be generated as single-player experiences, and so long as you download the software,
the website is not required to generate them.

## How do I get started?
If you are ready to start randomizing games, or want to start playing your favorite randomizer with others,
please join our [Discord server](https://discord.gg/8Z65BR2). There are always people ready to answer any questions
you might have.

If you are ready to start randomizing games, or want to start playing your favorite randomizer with others, please join
our discord server at the [Archipelago Discord](https://discord.gg/archipelago). There are always people ready to answer
any questions you might have.

## I want to add a game to the Archipelago randomizer. How do I do that?
The best way to get started is to take a look at our [code on GitHub](https://github.com/ArchipelagoMW/Archipelago).
There, you will find examples of games in the [worlds](https://github.com/ArchipelagoMW/Archipelago/tree/main/worlds)
folder, as well as some [documentation](https://github.com/ArchipelagoMW/Archipelago/tree/main/docs) on our
network interfaces.

The best way to get started is to take a look at our code on GitHub
at [Archipelago GitHub Page](https://github.com/ArchipelagoMW/Archipelago).

There you will find examples of games in the worlds folder
at [/worlds Folder in Archipelago Code](https://github.com/ArchipelagoMW/Archipelago/tree/main/worlds).

You may also find developer documentation in the docs folder
at [/docs Folder in Archipelago Code](https://github.com/ArchipelagoMW/Archipelago/tree/main/docs).

If you have more questions, feel free to ask in the **#archipelago-dev** channel on our Discord.
20 changes: 13 additions & 7 deletions WebHostLib/static/assets/gameInfo/en_A Link to the Past.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
# A Link to the Past

## Where is the settings page?
The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
you need to configure and export a config file.

The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
config file.

## What does randomization do to this game?
Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game
is always able to be completed, but because of the item shuffle the player may need to access certain areas before
they would in the vanilla game.

Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game is
always able to be completed, but because of the item shuffle the player may need to access certain areas before they
would in the vanilla game.

## What items and locations get shuffled?

All main inventory items, collectables, and ammunition can be shuffled, and all locations in the game which could
contain any of those items may have their contents changed.

## Which items can be in another player's world?
Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to
limit certain items to your own world.

Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to limit
certain items to your own world.

## What does another world's item look like in LttP?

Items belonging to other worlds are represented by a Power Star from Super Mario World.

## When the player receives an item, what happens?

When the player receives an item, Link will hold the item above his head and display it to the world. It's good for
business!

25 changes: 15 additions & 10 deletions WebHostLib/static/assets/gameInfo/en_Factorio.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,34 @@
# Factorio

## Where is the settings page?
The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
you need to configure and export a config file.

The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
config file.

## What does randomization do to this game?
In Factorio, the research tree is shuffled, causing certain technologies to be obtained in a non-standard order.
Recipe costs, technology requirements, and science pack requirements may also be shuffled at the player's discretion.

In Factorio, the research tree is shuffled, causing certain technologies to be obtained in a non-standard order. Recipe
costs, technology requirements, and science pack requirements may also be shuffled at the player's discretion.

## What Factorio items can appear in other players' worlds?

Factorio's technologies are removed from its tech tree and placed into other players' worlds. When those technologies
are found, they are sent back to Factorio along with, optionally, free samples of those technologies.

## What is a free sample?

A free sample is a single or stack of items in Factorio, granted by a technology received from another world. For
example, receiving the technology
`Portable Solar Panel` may also grant the player a stack of portable solar panels,
and place them directly into the player's inventory.
example, receiving the technology `Portable Solar Panel` may also grant the player a stack of portable solar panels, and
place them directly into the player's inventory.

## What does another world's item look like in Factorio?

In Factorio, items which need to be sent to other worlds appear in the tech tree as new research items. They are
represented by the Archipelago icon, and must be researched as if it were a normal technology. Upon successful
completion of research, the item will be sent to its home world.

## When the engineer receives an item, what happens?
When the player receives a technology, it is instantly learned and able to be crafted. A message will appear in the
chat log to notify the player, and if free samples are enabled the player may also receive some items directly to
their inventory.

When the player receives a technology, it is instantly learned and able to be crafted. A message will appear in the chat
log to notify the player, and if free samples are enabled the player may also receive some items directly to their
inventory.
29 changes: 17 additions & 12 deletions WebHostLib/static/assets/gameInfo/en_Final Fantasy.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
# Final Fantasy 1 (NES)

## Where is the settings page?
Unlike most games on Archipelago.gg, Final Fantasy 1's settings are controlled entirely by the original randomzier.
You can find an exhaustive list of documented settings [here](https://finalfantasyrandomizer.com/)

Unlike most games on Archipelago.gg, Final Fantasy 1's settings are controlled entirely by the original randomzier. You
can find an exhaustive list of documented settings on the FFR
website: [FF1R Website](https://finalfantasyrandomizer.com/)

## What does randomization do to this game?
A better questions is what isn't randomized at this point. Enemies stats and spell, character spells, shop inventory
and boss stats and spells are all commonly randomized. Unlike most other randomizers it is also most standard to shuffle
progression items and non-progression items into separate pools and then redistribute them to their respective
locations. So ,for example, Princess Sarah may have the CANOE instead of the LUTE; however, she will never have a Heal
Pot or some armor. There are plenty of other things that can be randomized on our
[main randomizer site](https://finalfantasyrandomizer.com/)

A better questions is what isn't randomized at this point. Enemies stats and spell, character spells, shop inventory and
boss stats and spells are all commonly randomized. Unlike most other randomizers it is also most standard to shuffle
progression items and non-progression items into separate pools and then redistribute them to their respective
locations. So, for example, Princess Sarah may have the CANOE instead of the LUTE; however, she will never have a Heal
Pot or some armor. There are plenty of other things that can be randomized on the main randomizer
site: [FF1R Website](https://finalfantasyrandomizer.com/)

## What Final Fantasy items can appear in other players' worlds?
All items can appear in other players worlds. This includes consumables, shards, weapons, armor and, of course,
key items.

All items can appear in other players worlds. This includes consumables, shards, weapons, armor and, of course, key
items.

## What does another world's item look like in Final Fantasy
All local and remote items appear the same. It will say that you received an item and then BOTH the client log and
the emulator will display what was found external to the in-game text box.

All local and remote items appear the same. It will say that you received an item and then BOTH the client log and the
emulator will display what was found external to the in-game text box.
17 changes: 11 additions & 6 deletions WebHostLib/static/assets/gameInfo/en_Minecraft.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
# Minecraft

## Where is the settings page?
The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
you need to configure and export a config file.

The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
config file.

## What does randomization do to this game?

Recipes are removed from the crafting book and shuffled into the item pool. It can also optionally change which
structures appear in each dimension. Crafting recipes are re-learned when they are received from other players as
item checks, and occasionally when completing your own achievements.
structures appear in each dimension. Crafting recipes are re-learned when they are received from other players as item
checks, and occasionally when completing your own achievements.

## What is considered a location check in minecraft?
Location checks in are completed when the player completes various Minecraft achievements. Opening the advancements
menu in-game by pressing "L" will display outstanding achievements.

Location checks in are completed when the player completes various Minecraft achievements. Opening the advancements menu
in-game by pressing "L" will display outstanding achievements.

## When the player receives an item, what happens?

When the player receives an item in Minecraft, it either unlocks crafting recipes or puts items into the player's
inventory directly.

## What is the victory condition?

Victory is achieved when the player kills the Ender Dragon, enters the portal in The End, and completes the credits
sequence either by skipping it or watching hit play out.
22 changes: 14 additions & 8 deletions WebHostLib/static/assets/gameInfo/en_Ocarina of Time.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
# Ocarina of Time

## Where is the settings page?
The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
you need to configure and export a config file.

The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
config file.

## What does randomization do to this game?
Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game
is always able to be completed, but because of the item shuffle the player may need to access certain areas before
they would in the vanilla game.

Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game is
always able to be completed, but because of the item shuffle the player may need to access certain areas before they
would in the vanilla game.

## What items and locations get shuffled?

All main inventory items, collectables, and ammunition can be shuffled, and all locations in the game which could
contain any of those items may have their contents changed. Gold Skultulla locations may also be included as necessary
checks at the user's discretion.

## Which items can be in another player's world?
Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to
limit certain items to your own world.

Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to limit
certain items to your own world.

## What does another world's item look like in OoT?
Items belonging to other worlds are represented by an Ocarina of Time.

Items belonging to other worlds are represented by the Zelda's Letter item.

## When the player receives an item, what happens?

When the player receives an item, Link will hold the item above his head and display it to the world. It's good for
business!
29 changes: 18 additions & 11 deletions WebHostLib/static/assets/gameInfo/en_Risk of Rain 2.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# Risk of Rain 2

## Where is the settings page?
The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
you need to configure and export a config file.

The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
config file.

## What does randomization do to this game?

Risk of Rain is already a random game, by virtue of being a roguelite. The Archipelago mod implements pure multiworld
functionality in which certain chests (made clear via a location check progress bar) will send an item out to the
multiworld. The items that _would have been_ in those chests will be returned to the Risk of Rain player via grants
by other players in other worlds.
multiworld. The items that _would have been_ in those chests will be returned to the Risk of Rain player via grants by
other players in other worlds.

## What Risk of Rain items can appear in other players' worlds?

The Risk of Rain items are:

* `Common Item` (White items)
* `Uncommon Item` (Green items)
* `Boss Item` (Yellow items)
Expand All @@ -23,14 +27,17 @@ The Risk of Rain items are:
Each item grants you a random in-game item from the category it belongs to.

When an item is granted by another world to the Risk of Rain player (one of the items listed above) then a random
in-game item of that tier will appear in the Risk of Rain player's inventory. If the item grant is an `Equipment`
and the player already has an equipment item equipped then the _item that was equipped_ will be dropped on the ground
and _the new equipment_ will take it's place. (If you want the old one back, pick it up.)
in-game item of that tier will appear in the Risk of Rain player's inventory. If the item grant is an `Equipment` and
the player already has an equipment item equipped then the _item that was equipped_ will be dropped on the ground and _
the new equipment_ will take it's place. (If you want the old one back, pick it up.)

## What does another world's item look like in Risk of Rain?
When the Risk of Rain player fills up their location check bar then the next spawned item will become an item grant for another
player's world. The item in Risk of Rain will disappear in a poof of smoke and the grant will automatically go out to the multiworld.

When the Risk of Rain player fills up their location check bar then the next spawned item will become an item grant for
another player's world. The item in Risk of Rain will disappear in a poof of smoke and the grant will automatically go
out to the multiworld.

## What is the item pickup step?
The item pickup step is a YAML setting which allows you to set how many items you need to spawn before the _next_
item that is spawned disappears (in a poof of smoke) and goes out to the multiworld.

The item pickup step is a YAML setting which allows you to set how many items you need to spawn before the _next_ item
that is spawned disappears (in a poof of smoke) and goes out to the multiworld.
Loading

0 comments on commit 5d356d5

Please sign in to comment.