2021-04-01 18:46:43 +00:00
|
|
|
# [Archipelago](https://archipelago.gg)  | [Install](https://github.com/ArchipelagoMW/Archipelago/releases)
|
2020-01-16 17:55:43 +00:00
|
|
|
|
2024-05-29 01:46:17 +00:00
|
|
|
Archipelago provides a generic framework for developing multiworld capability for game randomizers. In all cases,
|
|
|
|
presently, Archipelago is also the randomizer itself.
|
2021-02-03 00:37:05 +00:00
|
|
|
|
|
|
|
Currently, the following games are supported:
|
2024-05-29 01:46:17 +00:00
|
|
|
|
2021-02-03 00:37:05 +00:00
|
|
|
* The Legend of Zelda: A Link to the Past
|
2021-05-08 11:40:23 +00:00
|
|
|
* Factorio
|
|
|
|
* Minecraft
|
2021-07-28 02:57:45 +00:00
|
|
|
* Subnautica
|
2021-08-30 20:19:48 +00:00
|
|
|
* Slay the Spire
|
2021-08-31 12:37:01 +00:00
|
|
|
* Risk of Rain 2
|
2021-09-03 18:35:40 +00:00
|
|
|
* The Legend of Zelda: Ocarina of Time
|
2021-09-30 17:51:07 +00:00
|
|
|
* Timespinner
|
2021-11-13 15:35:24 +00:00
|
|
|
* Super Metroid
|
|
|
|
* Secret of Evermore
|
2021-12-03 04:04:35 +00:00
|
|
|
* Final Fantasy
|
2022-01-03 18:12:32 +00:00
|
|
|
* Rogue Legacy
|
2022-01-24 03:50:49 +00:00
|
|
|
* VVVVVV
|
|
|
|
* Raft
|
|
|
|
* Super Mario 64
|
2022-03-24 13:21:08 +00:00
|
|
|
* Meritous
|
|
|
|
* Super Metroid/Link to the Past combo randomizer (SMZ3)
|
2022-03-22 22:30:10 +00:00
|
|
|
* ChecksFinder
|
2022-04-03 20:30:44 +00:00
|
|
|
* ArchipIDLE
|
|
|
|
* Hollow Knight
|
2022-04-28 22:42:11 +00:00
|
|
|
* The Witness
|
2022-05-14 10:00:49 +00:00
|
|
|
* Sonic Adventure 2: Battle
|
2024-03-15 16:33:03 +00:00
|
|
|
* Starcraft 2
|
2022-07-22 05:02:25 +00:00
|
|
|
* Donkey Kong Country 3
|
|
|
|
* Dark Souls 3
|
2022-09-29 18:16:59 +00:00
|
|
|
* Super Mario World
|
2022-10-13 05:45:52 +00:00
|
|
|
* Pokémon Red and Blue
|
2022-10-14 20:53:49 +00:00
|
|
|
* Hylics 2
|
2022-10-13 17:57:50 +00:00
|
|
|
* Overcooked! 2
|
2022-10-20 17:41:11 +00:00
|
|
|
* Zillion
|
2022-12-12 01:36:18 +00:00
|
|
|
* Lufia II Ancient Cave
|
2023-02-27 14:15:00 +00:00
|
|
|
* Blasphemous
|
|
|
|
* Wargroove
|
2023-02-28 00:23:40 +00:00
|
|
|
* Stardew Valley
|
2023-03-05 12:31:31 +00:00
|
|
|
* The Legend of Zelda
|
2023-03-12 14:05:50 +00:00
|
|
|
* The Messenger
|
2023-03-20 22:43:29 +00:00
|
|
|
* Kingdom Hearts 2
|
2023-03-20 22:55:53 +00:00
|
|
|
* The Legend of Zelda: Link's Awakening DX
|
2023-03-21 20:23:45 +00:00
|
|
|
* Clique
|
2023-03-22 14:25:55 +00:00
|
|
|
* Adventure
|
2023-04-09 20:53:23 +00:00
|
|
|
* DLC Quest
|
2023-04-20 03:21:56 +00:00
|
|
|
* Noita
|
2023-06-27 02:35:41 +00:00
|
|
|
* Undertale
|
2023-06-27 20:37:17 +00:00
|
|
|
* Bumper Stickers
|
2023-06-29 20:01:37 +00:00
|
|
|
* Mega Man Battle Network 3: Blue Version
|
2023-06-30 13:10:58 +00:00
|
|
|
* Muse Dash
|
2023-07-02 21:15:27 +00:00
|
|
|
* DOOM 1993
|
2023-07-19 02:37:26 +00:00
|
|
|
* Terraria
|
2023-11-08 23:35:12 +00:00
|
|
|
* Lingo
|
2023-11-12 21:39:34 +00:00
|
|
|
* Pokémon Emerald
|
2023-11-24 17:08:02 +00:00
|
|
|
* DOOM II
|
2023-11-24 23:23:45 +00:00
|
|
|
* Shivers
|
2023-11-25 14:22:30 +00:00
|
|
|
* Heretic
|
2023-11-25 15:00:15 +00:00
|
|
|
* Landstalker: The Treasures of King Nole
|
2023-11-26 16:17:59 +00:00
|
|
|
* Final Fantasy Mystic Quest
|
2024-01-12 19:32:15 +00:00
|
|
|
* TUNIC
|
2024-03-05 15:59:55 +00:00
|
|
|
* Kirby's Dream Land 3
|
2024-03-05 23:55:56 +00:00
|
|
|
* Celeste 64
|
2024-03-15 16:35:37 +00:00
|
|
|
* Zork Grand Inquisitor
|
2024-03-20 21:03:25 +00:00
|
|
|
* Castlevania 64
|
2024-03-20 21:44:09 +00:00
|
|
|
* A Short Hike
|
2024-03-22 20:35:00 +00:00
|
|
|
* Yoshi's Island
|
2024-05-06 07:15:06 +00:00
|
|
|
* Mario & Luigi: Superstar Saga
|
2024-05-17 10:13:40 +00:00
|
|
|
* Bomb Rush Cyberfunk
|
2024-05-20 06:58:44 +00:00
|
|
|
* Aquaria
|
2024-05-17 22:09:03 +00:00
|
|
|
* Yu-Gi-Oh! Ultimate Masters: World Championship Tournament 2006
|
2024-05-20 07:04:06 +00:00
|
|
|
* A Hat in Time
|
OSRS: Implement New Game (#1976)
* MMBN3: Press program now has proper color index when received remotely
* Initial commit of OSRS untangled from MMBN3 branch
* Fixes some broken region connections
* Removes some locations
* Rearranges locations to fill in slots left by removed locations
* Adds starting area rando
* Moves Oak and Willow trees to resource regions
* Fixes various PEP8 violations
* Refactor of regions
* Fixes variable capture issue with region rules
* Partial completion of brutal grind logic
* Finishes can_reach_skill function
* Adds skill requirements to location rules, fixes regions rules
* Adds documentation for OSRS
* Removes match statement
* Updates Data Version to test mode to prevent item name caching
* Fixes starting spawn logic for east varrock
* Fixes river lum crossing logic to not assume you can phase across water
* Prevents equipping items when you haven't unlocked them
* Changes canoe logic to not require huge levels
* Skeletoning out some data I'll need for variable task system
* Adds csvs and parser for logic
* Adds Items parsing
* Fixes the spawning logic to not default to Chunksanity when you didn't pick it
* Begins adding generation rules for data-driven logic
* Moves region handling and location creating to different methods
* Adds logic limits to Options
* Begun the location generation has
* Randomly generates tasks for each skill until populated
* Mopping up improper names, adding custom logic, and fixes location rolling
* Drastically cleans up the location rolling loop
* Modifies generation to properly use local variables and pass unit tests
* Game is now generating, but rules don't seem to work
* Lambda capture, my old nemesis. We meet again
* Fixes issue with Corsair Cove item requirement causing logic loop
* Okay one more fix, another variable capture
* On second thought lets not have skull sceptre tasks. 'Tis a silly place
* Removes QP from item pool (they're events not items)
* Removes Stronghold floor tasks, no varbit to track them
* Loads CSV with pkutil so it can be used in apworld
* Fixes logic of skill tasks and adds QP requirements to long grinds
* Fixes pathing in pkgutil call
* Better handling for empty task categories, no longer throws errors
* Fixes order for progressive tasks, removes un-checkable spider task
* Fixes logic issues related to stew and the Blurite caves
* Fixes issues generating causing tests to sporadically fail
* Adds missing task that caused off-by-one error
* Updates to new Options API
* Updates generation to function properly with the Universal Tracker (Thanks Faris)
* Replaces runtime CSV parsing with pre-made python files generated from CSVs
* Switches to self.random and uses random.choice instead of doing it manually
* Fixes to typing, variable names, iterators, and continue conditions
* Replaces Name classes with Enums
* Fixes parse error on region special rules
* Skill requirements check now returns an accessrule instead of being one that checks options
* Updates documentation and setup guide
* Adjusts maximum numbers for combat and general tasks
* Fixes region names so dictionary lookup works for chunksanity
* Update worlds/osrs/docs/en_Old School Runescape.md
Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com>
* Update worlds/osrs/docs/en_Old School Runescape.md
Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com>
* Updates readme.md and codeowners doc
* Removes erroneous East Varrock -> Al Kharid connection
* Changes to canoe logic to account for woodcutting level options
* Fixes embarassing typo on 'Edgeville'
* Moves Logic CSVs to separate repository, addresses suggested changes on PR
* Fixes logic error in east/west lumbridge regions. Fixes incorrect List typing in main
* Removes task types with weight 0 from the list of rollable tasks
* Missed another place that the task type had to be removed if 0 weight
* Prevents adding an empty task weight if levels are too restrictive for tasks to be added
* Removes giant blank space in error message
* Adds player name to error for not having enough available tasks
---------
Co-authored-by: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com>
2024-08-06 21:13:11 +00:00
|
|
|
* Old School Runescape
|
2021-02-03 00:37:05 +00:00
|
|
|
|
2021-10-20 06:31:00 +00:00
|
|
|
For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
|
2021-04-01 18:46:43 +00:00
|
|
|
Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled
|
2021-01-03 13:32:32 +00:00
|
|
|
windows binaries.
|
2020-01-16 17:55:43 +00:00
|
|
|
|
2021-02-03 00:37:05 +00:00
|
|
|
## History
|
|
|
|
|
2024-05-29 01:46:17 +00:00
|
|
|
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:
|
2021-02-03 00:37:05 +00:00
|
|
|
|
|
|
|
* [bonta0's MultiWorld](https://github.com/Bonta0/ALttPEntranceRandomizer/tree/multiworld_31)
|
|
|
|
* [AmazingAmpharos' Entrance Randomizer](https://github.com/AmazingAmpharos/ALttPEntranceRandomizer)
|
|
|
|
* [VT Web Randomizer](https://github.com/sporchia/alttp_vt_randomizer)
|
|
|
|
* [Dessyreqt's alttprandomizer](https://github.com/Dessyreqt/alttprandomizer)
|
2024-05-29 01:46:17 +00:00
|
|
|
* [Zarby89's](https://github.com/Ijwu/Enemizer/commits?author=Zarby89)
|
|
|
|
and [sosuke3's](https://github.com/Ijwu/Enemizer/commits?author=sosuke3) contributions to Enemizer, which make up the
|
|
|
|
vast majority of Enemizer contributions.
|
2021-02-03 00:37:05 +00:00
|
|
|
|
2024-05-29 01:46:17 +00:00
|
|
|
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.
|
2021-02-03 00:37:05 +00:00
|
|
|
|
|
|
|
### Path to the Archipelago
|
2024-05-29 01:46:17 +00:00
|
|
|
|
|
|
|
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.
|
2021-02-03 00:37:05 +00:00
|
|
|
|
|
|
|
## Running Archipelago
|
|
|
|
|
2024-05-29 01:46:17 +00:00
|
|
|
For most people, all you need to do is head over to
|
|
|
|
the [releases page](https://github.com/ArchipelagoMW/Archipelago/releases), 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](docs/running%20from%20source.md).
|
2021-02-03 00:37:05 +00:00
|
|
|
|
|
|
|
## Related Repositories
|
2024-05-29 01:46:17 +00:00
|
|
|
|
|
|
|
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.
|
2021-02-03 00:37:05 +00:00
|
|
|
|
2021-10-02 05:01:00 +00:00
|
|
|
* [z3randomizer](https://github.com/ArchipelagoMW/z3randomizer)
|
2021-02-03 00:37:05 +00:00
|
|
|
* [Enemizer](https://github.com/Ijwu/Enemizer)
|
2021-09-03 18:35:40 +00:00
|
|
|
* [Ocarina of Time Randomizer](https://github.com/TestRunnerSRL/OoT-Randomizer)
|
2021-02-03 00:37:05 +00:00
|
|
|
|
|
|
|
## Contributing
|
2024-05-29 01:46:17 +00:00
|
|
|
|
|
|
|
To contribute to Archipelago, including the WebHost, core program, or by adding a new game, see our
|
|
|
|
[Contributing guidelines](/docs/contributing.md).
|
2022-06-20 00:39:12 +00:00
|
|
|
|
|
|
|
## FAQ
|
2024-05-29 01:46:17 +00:00
|
|
|
|
|
|
|
For Frequently asked questions, please see the website's [FAQ Page](https://archipelago.gg/faq/en/).
|
2022-03-24 13:21:08 +00:00
|
|
|
|
2021-02-03 00:37:05 +00:00
|
|
|
## Code of Conduct
|
2024-05-29 01:46:17 +00:00
|
|
|
|
|
|
|
Please refer to our [code of conduct](/docs/code_of_conduct.md).
|