30f97dd7de
All the types being copied are built-in types with their own `copy()` methods, so using the `copy` module was a bit overkill and also slower. This patch replaces the use of the `copy` module in `CollectionState.copy()` with using the built-in `.copy()` methods. The copying of `reachable_regions` and `blocked_connections` was also iterating the keys of each dictionary and then looking up the value in the dictionary for that key. It is faster, and I think more readable, to iterate the dictionary's `.items()` instead. For me, when generating a multiworld including the template yaml of every world with `python -O .\Generate.py --skip_output`, this patch saves about 2.1s. The overall generation duration for these yamls varies quite a lot, but averages around 160s for me, so on average this patch reduced overall generation duration (excluding output duration) by around 1.3%. Timing comparisons were made by calling time.perf_counter() at the start and end of `CollectionState.copy()`'s body, and summing the differences between the starts and ends of the method body into a global variable that was printed at the end of generation. Additional timing comparisons were made, using the `timeit` module, of the individual function calls or dictionary comprehensions used to perform the copying. The main performance cost was `copy.deepcopy()`, which gets slow as the number of keys multiplied by the number of values within the sets/Counters gets large, e.g., to deepcopy a `dict[int, Counter[str]]` with 100 keys and where each Counter contains 100 keys was 30x slower than most other tested copying methods. Increasing the number of dict keys or Counter keys only makes it slower. |
||
|---|---|---|
| .github | ||
| .run | ||
| WebHostLib | ||
| data | ||
| docs | ||
| test | ||
| typings | ||
| worlds | ||
| worlds_disabled | ||
| .coveragerc | ||
| .gitignore | ||
| AHITClient.py | ||
| AdventureClient.py | ||
| BaseClasses.py | ||
| BizHawkClient.py | ||
| ChecksFinderClient.py | ||
| CommonClient.py | ||
| FF1Client.py | ||
| FactorioClient.py | ||
| Fill.py | ||
| Generate.py | ||
| KH2Client.py | ||
| LICENSE | ||
| Launcher.py | ||
| LinksAwakeningClient.py | ||
| LttPAdjuster.py | ||
| MMBN3Client.py | ||
| Main.py | ||
| MinecraftClient.py | ||
| ModuleUpdate.py | ||
| MultiServer.py | ||
| NetUtils.py | ||
| OoTAdjuster.py | ||
| OoTClient.py | ||
| Options.py | ||
| Patch.py | ||
| README.md | ||
| SNIClient.py | ||
| Starcraft2Client.py | ||
| UndertaleClient.py | ||
| Utils.py | ||
| WargrooveClient.py | ||
| WebHost.py | ||
| Zelda1Client.py | ||
| ZillionClient.py | ||
| _speedups.pyx | ||
| _speedups.pyxbld | ||
| inno_setup.iss | ||
| intset.h | ||
| kvui.py | ||
| meta.yaml | ||
| pytest.ini | ||
| requirements.txt | ||
| settings.py | ||
| setup.py | ||
README.md
Archipelago 
| Install
Archipelago provides a generic framework for developing multiworld capability for game randomizers. In all cases, presently, Archipelago is also the randomizer itself.
Currently, the following games are supported:
- The Legend of Zelda: A Link to the Past
- Factorio
- Minecraft
- Subnautica
- Slay the Spire
- Risk of Rain 2
- The Legend of Zelda: Ocarina of Time
- Timespinner
- Super Metroid
- Secret of Evermore
- Final Fantasy
- Rogue Legacy
- VVVVVV
- Raft
- Super Mario 64
- Meritous
- Super Metroid/Link to the Past combo randomizer (SMZ3)
- ChecksFinder
- ArchipIDLE
- Hollow Knight
- The Witness
- Sonic Adventure 2: Battle
- Starcraft 2
- Donkey Kong Country 3
- Dark Souls 3
- Super Mario World
- Pokémon Red and Blue
- Hylics 2
- Overcooked! 2
- Zillion
- Lufia II Ancient Cave
- Blasphemous
- Wargroove
- Stardew Valley
- The Legend of Zelda
- The Messenger
- Kingdom Hearts 2
- The Legend of Zelda: Link's Awakening DX
- Clique
- Adventure
- DLC Quest
- Noita
- Undertale
- Bumper Stickers
- Mega Man Battle Network 3: Blue Version
- Muse Dash
- DOOM 1993
- Terraria
- Lingo
- Pokémon Emerald
- DOOM II
- Shivers
- Heretic
- Landstalker: The Treasures of King Nole
- Final Fantasy Mystic Quest
- TUNIC
- Kirby's Dream Land 3
- Celeste 64
- Zork Grand Inquisitor
- Castlevania 64
- A Short Hike
- Yoshi's Island
- Mario & Luigi: Superstar Saga
- Bomb Rush Cyberfunk
- Aquaria
- Yu-Gi-Oh! Ultimate Masters: World Championship Tournament 2006
- A Hat in Time
- Old School Runescape
For setup and instructions check out our tutorials page. Downloads can be found at Releases, including compiled windows binaries.
History
Archipelago is built upon a strong legacy of brilliant hobbyists. We want to honor that legacy by showing it here. The repositories which Archipelago is built upon, inspired by, or otherwise owes its gratitude to are:
- bonta0's MultiWorld
- AmazingAmpharos' Entrance Randomizer
- VT Web Randomizer
- Dessyreqt's alttprandomizer
- Zarby89's and sosuke3's contributions to Enemizer, which make up the vast majority of Enemizer contributions.
We recognize that there is a strong community of incredibly smart people that have come before us and helped pave the path. Just because one person's name may be in a repository title does not mean that only one person made that project happen. We can't hope to perfectly cover every single contribution that lead up to Archipelago, but we hope to honor them fairly.
Path to the Archipelago
Archipelago was directly forked from bonta0's multiworld_31 branch of ALttPEntranceRandomizer (this project has a
long legacy of its own, please check it out linked above) on January 12, 2020. The repository was then named to
MultiWorld-Utilities to better encompass its intended function. As Archipelago matured, then known as
"Berserker's MultiWorld" by some, we found it necessary to transform our repository into a root level repository
(as opposed to a 'forked repo') and change the name (which came later) to better reflect our project.
Running Archipelago
For most people, all you need to do is head over to the releases page, then download and run the appropriate installer, or AppImage for Linux-based systems.
If you are a developer or are running on a platform with no compiled releases available, please see our doc on running Archipelago from source.
Related Repositories
This project makes use of multiple other projects. We wouldn't be here without these other repositories and the contributions of their developers, past and present.
Contributing
To contribute to Archipelago, including the WebHost, core program, or by adding a new game, see our Contributing guidelines.
FAQ
For Frequently asked questions, please see the website's FAQ Page.
Code of Conduct
Please refer to our code of conduct.