c61505baf6
* Render option documentation as reStructuredText in the WebView This means that options can use the standard Python documentation format, while producing much nicer-looking documentation in the WebView with things like emphasis, lists, and so on. * Opt existing worlds out of rich option docs This avoids breaking the rendering of existing option docs which were written with the old plain text rendering in mind, while also allowing new options to default to the rich text rendering instead. * Use reStructuredText formatting for Lingo Options docstrings * Disable raw and file insertion RST directives * Update doc comments per code review * Make rich text docs opt-in * Put rich_text_options_doc on WebWorld * Document rich text API * Code review * Update docs/options api.md Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com> * Update Options.py Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com> --------- Co-authored-by: Chris Wilson <chris@legendserver.info> Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com> |
||
|---|---|---|
| .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
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.