mirror of
https://github.com/ArchipelagoMW/Archipelago.git
synced 2026-03-27 20:23:25 -07:00
Update docs
This commit is contained in:
Carter Hesterman
@@ -1,15 +0,0 @@
|
||||
## Boostsanity
|
||||
Boostsanity takes all of the Eureka & Inspiration events and makes them location checks. This feature is the one to changeup the way Civilization is played in an AP multiworld/randomizer to date. What normally are mundane tasks that are passively collected now become a novel and interesting bucket list that you need to pay attention to in order to unlock items for yourself and others!
|
||||
Boosts have logic associated with them in order to verify you can always reach the ones you need to, when you need to. One side effect of this is that when boostsanity is enabled, previously some "Useful" items are now flagged as "Progression" (Urbanization, Pottery, The Wheel, to name a few).
|
||||
|
||||
### FAQs
|
||||
- Someone sent me a tech/civic and I'm worried I won't be able to boost it anymore!
|
||||
- Fear not! The mod has been updated, and through a lot of wizardry 🧙♂️ you will be able to boost civics/techs that have already been received. Additionally the UI has been updated to show you whether they have been boosted or not after receiving them still.
|
||||
- I need to kill a unit with a slinger/archer/musketman or some other obsolete unit I can't build anymore, how can I do this??
|
||||
- Don't forget you can go into the Tech Tree and click on a Vanilla tech you've received in order to toggle it on/off. This is necessary in order to pursue some of the boosts if you receive techs in certain orders.
|
||||
- Something happened and I'm not able to unlock the boost due to game rules!
|
||||
- A few scenarios you may worry about: "Found a religion", "Make an alliance with another player", "Develop an alliance to level 2", "Build a wonder from X Era", to name a few. Any boost that is "miss-able" has been flagged as an "Excluded" location and will not ever receive a progression item. For a list of how each boost is flagged, take a look [here](../data/boosts.json).
|
||||
- I'm worried that my `PROGRESSIVE_ERA` item is going to be stuck in a boost I won't have time to complete before my maximum unlocked era ends!
|
||||
- I, too, have shared this fear. Due to the unpredictable timing of boosts and unlocking them, this could lead to a hard lock in certain scenarios. As a result, `PROGRESSIVE_ERA` items will never be located at a boost check.
|
||||
- There's too many boosts, how will I know which one's I should focus on?!
|
||||
- In order to give a little more focus to all the boosts rather than just arbitrarily picking them at random, items in both of the vanilla trees will now have an advisor icon on them if it's associated boost contains a progression item.
|
||||
@@ -1,11 +1,8 @@
|
||||
# Civlization 6 Archipelago
|
||||
|
||||
## Setup Guide
|
||||
For setup instructions go [here](./docs/setup_en.md).
|
||||
|
||||
## What does randomization do to this game?
|
||||
|
||||
In Civilization VI, the tech and civic trees are both shuffled. This presents some interesting ways to play the game in a non-standard way. If you are feeling adventurous, you can enable the `boostsanity` option in order to really change up the way you normally would play a Civ game. Details on the option can be found [here](./docs/boostsanity.md)
|
||||
In Civilization VI, the tech and civic trees are both shuffled. This presents some interesting ways to play the game in a non-standard way. If you are feeling adventurous, you can enable the `boostsanity` option in order to really change up the way you normally would play a Civ game. Details on the option can be found in the "Boostsanity" section below.
|
||||
|
||||
There are a few changes that the Archipelago mod introduces in order to make this playable/fun. These are detailed in the __FAQ__ section below.
|
||||
|
||||
@@ -23,31 +20,40 @@ A short period after receiving an item, you will get a notification indicating y
|
||||
|
||||
## FAQs
|
||||
- Do I need the DLC to play this?
|
||||
- Yes, you need both Rise & Fall and Gathering Storm. If there is enough interest then I can eventually add support for Archipellago runs that don't require both expansions.
|
||||
|
||||
- Yes, you need both Rise & Fall and Gathering Storm. If there is enough interest then I can eventually add support for Archipellago runs that don't require both expansions.
|
||||
- Does this work with Multiplayer?
|
||||
- It does not and, despite my best efforts, probably won't until there's a new way for external programs to be able to interact with the game.
|
||||
|
||||
- It does not and, despite my best efforts, probably won't until there's a new way for external programs to be able to interact with the game.
|
||||
- Does my mod that reskins Barbarians as various Pro Wrestlers work with this??
|
||||
- Only one way to find out! Any mods that modify techs/civics will most likely cause issues, though.
|
||||
|
||||
- Only one way to find out! Any mods that modify techs/civics will most likely cause issues, though.
|
||||
- "Help! I can't see any of the items that have been sent to me!"
|
||||
- Both trees by default will show you the researchable Archipelago locations. To view the normal tree, you can click "Toggle Archipelago Tree" on the top left corner of the tree view.
|
||||
|
||||
- Both trees by default will show you the researchable Archipelago locations. To view the normal tree, you can click "Toggle Archipelago Tree" on the top left corner of the tree view.
|
||||
- "Oh no! I received the Machinery tech and now instead of getting an Archer next turn, I have to wait an additional 10 turns to get a Crossbowman!"
|
||||
- Vanilla prevents you from building units of the same class from an earlier tech level after you have researched a later variant. For example, this could be problematic if someone unlocks Crossbowmen for you right out the gate since you won't be able to make Archers (which have a much lower production cost).
|
||||
|
||||
- Solution: You can now go in to the tech tree, click "Toggle Archipelago Tree" to view your unlocked techs, and then can click any tech you have unlocked to toggle whether it is currently active or not. __NOTE__: This is an experimental feature and may yield some unexpected behaviors. Please DM `@Hesto2` on Discord if you run into any issues.
|
||||
- Vanilla prevents you from building units of the same class from an earlier tech level after you have researched a later variant. For example, this could be problematic if someone unlocks Crossbowmen for you right out the gate since you won't be able to make Archers (which have a much lower production cost).
|
||||
Solution: You can now go in to the tech tree, click "Toggle Archipelago Tree" to view your unlocked techs, and then can click any tech you have unlocked to toggle whether it is currently active or not.
|
||||
- "How does DeathLink work? Am I going to have to start a new game every time one of my friends dies??"
|
||||
- Heavens no, my fellow Archipelago appreciator. When configuring your Archipelago options for Civilization on the options page, there are several choices available for you to fine tune the way you'd like to be punished for the follies of your friends. These include: Having a random unit destroyed, losing a percentage of gold or faith, or even losing a point on your era score. If you can't make up your mind, you can elect to have any of them be selected every time a death link is sent your way.
|
||||
In the event you lose one of your units in combat (this means captured units don't count), then you will send a death link event to the rest of your friends.
|
||||
|
||||
- I enabled `progressive districts` but I have no idea techs/civics what items are locked behind progression now!
|
||||
- Any technology or civic that grants you a new building in a district (or grants you the district itself) is now locked behind a progressive item. For example, `PROGRESSIVE_CAMPUS` would give you these items in the following order:
|
||||
1. `TECH_WRITING`
|
||||
2. `TECH_EDUCATION`
|
||||
3. `TECH_CHEMISTRY`
|
||||
- If you want to see the details around each item, you can review [this file](./data/progressive_districts.json)
|
||||
- Any technology or civic that grants you a new building in a district (or grants you the district itself) is now locked behind a progressive item. For example, `PROGRESSIVE_CAMPUS` would give you these items in the following order:
|
||||
1. `TECH_WRITING`
|
||||
2. `TECH_EDUCATION`
|
||||
3. `TECH_CHEMISTRY`
|
||||
- If you want to see the details around each item, you can review [this file](https://github.com/hesto2/civilization_vi_apworld/blob/main/data/progressive_districts.json)
|
||||
|
||||
- "How does DeathLink work? Am I going to have to start a new game every time one of my friends dies??"
|
||||
- Heavens no, my fellow Archipelago appreciator. When configuring your Archipelago options for Civilization on the options page, there are several choices available for you to fine tune the way you'd like to be punished for the follies of your friends. These include: Having a random unit destroyed, losing a percentage of gold or faith, or even losing a point on your era score. If you can't make up your mind, you can elect to have any of them be selected every time a death link is sent your way.
|
||||
## Boostsanity
|
||||
Boostsanity takes all of the Eureka & Inspiration events and makes them location checks. This feature is the one to changeup the way Civilization is played in an AP multiworld/randomizer to date. What normally are mundane tasks that are passively collected now become a novel and interesting bucket list that you need to pay attention to in order to unlock items for yourself and others!
|
||||
Boosts have logic associated with them in order to verify you can always reach the ones you need to, when you need to. One side effect of this is that when boostsanity is enabled, previously some "Useful" items are now flagged as "Progression" (Urbanization, Pottery, The Wheel, to name a few).
|
||||
|
||||
- In the event you lose one of your units in combat (this means captured units don't count), then you will send a death link event to the rest of your friends.
|
||||
### Boostsanity FAQs
|
||||
- Someone sent me a tech/civic and I'm worried I won't be able to boost it anymore!
|
||||
- Fear not! The mod has been updated, and through a lot of wizardry 🧙♂️ you will be able to boost civics/techs that have already been received. Additionally the UI has been updated to show you whether they have been boosted or not after receiving them still.
|
||||
- I need to kill a unit with a slinger/archer/musketman or some other obsolete unit I can't build anymore, how can I do this??
|
||||
- Don't forget you can go into the Tech Tree and click on a Vanilla tech you've received in order to toggle it on/off. This is necessary in order to pursue some of the boosts if you receive techs in certain orders.
|
||||
- Something happened and I'm not able to unlock the boost due to game rules!
|
||||
- A few scenarios you may worry about: "Found a religion", "Make an alliance with another player", "Develop an alliance to level 2", "Build a wonder from X Era", to name a few. Any boost that is "miss-able" has been flagged as an "Excluded" location and will not ever receive a progression item. For a list of how each boost is flagged, take a look [here](https://github.com/hesto2/civilization_vi_apworld/blob/main/data/boosts.json).
|
||||
- I'm worried that my `PROGRESSIVE_ERA` item is going to be stuck in a boost I won't have time to complete before my maximum unlocked era ends!
|
||||
- Due to the unpredictable timing of boosts and unlocking them, this could lead to a hard lock in certain scenarios. As a result, `PROGRESSIVE_ERA` items will never be located at a boost check.
|
||||
- There's too many boosts, how will I know which one's I should focus on?!
|
||||
- In order to give a little more focus to all the boosts rather than just arbitrarily picking them at random, items in both of the vanilla trees will now have an advisor icon on them if it's associated boost contains a progression item.
|
||||
|
||||
|
||||
@@ -10,7 +10,6 @@ The following are required in order to play Civ VI in Archipelago
|
||||
|
||||
- Installed [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases) v0.4.5 or higher.\
|
||||
**Make sure to install the Generator if you intend to generate multiworlds.**
|
||||
- The latest version of the [Civ VI apworld](https://github.com/hesto2/civilization_vi_apworld/releases/latest).
|
||||
|
||||
- The latest version of the [Civ VI AP Mod](https://github.com/hesto2/civilization_archipelago_mod).
|
||||
|
||||
@@ -39,73 +38,12 @@ Once you have located your `AppOptions.txt`, do a search for `Enable FireTuner`.
|
||||
- Archipelago.modinfo
|
||||
- All the other mod files, etc.
|
||||
|
||||
## AP World Installation
|
||||
|
||||
1. Unzip the downloaded Civ VI apworld zip file
|
||||
2. Place the `civ6.apworld` file in your Archipelago installation's `lib/worlds` folder (Windows default to:
|
||||
`%programdata%/Archipelago`).
|
||||
|
||||
- If you have a `civ6.apworld` file from a previous version of the apworld, you **must** delete it, as it is no longer
|
||||
supported. Additionally, if there is a `civ6` folder in that folder, you **must** also delete it. Keeping
|
||||
these around will cause issues, even if multiworlds are successfully generated.
|
||||
|
||||
## Setting Up a YAML
|
||||
|
||||
All players playing Civ VI must provide the room host with a YAML file containing the settings for their world.
|
||||
A sample YAML file for Civ VI is supplied in the Civ VI apworld download. Refer to the comments in that file for
|
||||
details about what each setting does.
|
||||
|
||||
Once complete, provide the room host with your YAML file.
|
||||
|
||||
## Generating a Multiworld
|
||||
|
||||
If you're generating a multiworld game that includes Civ VI, you'll need to run it locally since the online
|
||||
generator does not yet support it. Follow these steps to generate a multiworld:
|
||||
|
||||
1. Gather all player's YAMLs. Place these YAMLs into the `Players` folder of your Archipelago installation. If the
|
||||
folder does not exist, then it must be created manually. The files here should not be compressed.
|
||||
2. Modify any local host settings for generation, as desired.
|
||||
3. Run `ArchipelagoGenerate.exe` (without `.exe` on Linux) or click `Generate` in the launcher. The generation output
|
||||
is placed in the `output` folder (usually named something like `AP_XXXXX.zip`). \* Please note that if any player in the game you want to generate plays a game that needs a ROM file to generate,
|
||||
you will need the corresponding ROM files.
|
||||
4. Unzip the `AP_XXXXX.zip` file. It should include a zip file for each player in the room playing Civ VI. Distribute each file to the appropriate player.
|
||||
5. **Delete the distributed zip files and re-zip the remaining files**. In the next section, use this archive file to
|
||||
host a room or provide it to the room host. \* If you plan to host the room on a local machine, skip this step and use the original zip file (`AP_XXXX.zip`) instead.
|
||||
|
||||
## Hosting a Room
|
||||
|
||||
If you're generating the multiworld, follow the instructions in the previous section. Once you have the zip file
|
||||
corresponding to your multiworld, follow
|
||||
[these steps](https://archipelago.gg/tutorial/Archipelago/setup/en#hosting-an-archipelago-server) to host a room. Follow
|
||||
the instructions for hosting on the website from a locally generated game or on a local machine.
|
||||
|
||||
## Connecting to a Room
|
||||
|
||||
You should have the zip file provided to you by the multiworld generator. You should also have the room's server
|
||||
name and port number from the room's host.
|
||||
|
||||
Once you do, follow these steps to connect to the room:
|
||||
|
||||
1. Unzip the folder given to you and copy its contents (should include `NewItems.xml` an `archipelago.json`, and more) into the installed mod folder.
|
||||
2. Start `ArchipelagoLauncher.exe` and choose `Civ6 Client`, which will open the text client.
|
||||
3. Connect to the room by entering the server name and port number at the top and pressing `Connect`. For rooms hosted
|
||||
on the website, this will be `archipelago.gg:<port>`, where `<port>` is the port number. If a game is hosted from the
|
||||
`ArchipelagoServer.exe` (without `.exe` on Linux), this will default to `38281` but may be changed in the `host.yaml`.
|
||||
4. Once you successfully configure and launch a game, the client should let you know it is connected and you will be ready to play!
|
||||
|
||||
## Configuring your game
|
||||
|
||||
When configuring your game, make sure to start the game in the Ancient Era and leave all settings related to starting technologies and civics as the defaults. Other than that, configure difficulty, AI, etc. as you normally would.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- If you do not see the client in the launcher, ensure you have placed the `civ6.apworld` in the correct folder (the
|
||||
`lib/worlds` folder of your Archipelago installation).
|
||||
|
||||
- If you are getting an error: `The remote computer refused the network connection`, or something else related to the client (or tuner) not being able to connect, it likely indicates the tuner is not actually enabled. One simple way to verify that it is enabled is, after completing the setup steps, to go Main Menu -> Options -> Look for an option named "Tuner" and verify it is set to "Enabled"
|
||||
|
||||
- If your game gets in a state where someone has sent you items or you have sent locations but these are not correctly replicated to the multiworld, you can run `/resync` from the Civ 6 client. This may take up to a minute depending on how many items there are.
|
||||
|
||||
|
||||
## Feedback
|
||||
In the offical [Archipelago Discord](https://discord.com/invite/8Z65BR2) under the `future-game-design` channel there is a `civilization-vi` [thread](https://discord.com/channels/731205301247803413/1235473969487024189/1235473969487024189). Feel free to ping `@hesto2` with any bugs/thoughts/complaints/wishes/jokes you may have!
|
||||
- If your game gets in a state where someone has sent you items or you have sent locations but these are not correctly replicated to the multiworld, you can run `/resync` from the Civ 6 client. This may take up to a minute depending on how many items there are.
|
||||
Reference in New Issue
Block a user