mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 12:11:33 -06:00
8541c87c97
* Paint: Implement New Game * Add docstring * Remove unnecessary self.multiworld references * Implement start_inventory_from_pool * Convert logic to use LogicMixin * Add location_exists_with_options function to deduplicate code * Simplify starting tool creation * Add Paint to supported games list * Increment version to 0.4.1 * Update docs to include color selection features * Fix world attribute definitions * Fix linting errors * De-duplicate lists of traps * Move LogicMixin to __init__.py * 0.5.0 features - adjustable canvas size increment, updated similarity metric * Fix OptionError formatting * Create OptionError when generating single-player game with error-prone settings * Increment version to 0.5.1 * Update CODEOWNERS * Update documentation for 0.5.2 client changes * Simplify region creation * Add comments describing logic * Remove unnecessary f-strings * Remove unused import * Refactor rules to location class * Remove unnecessary self.multiworld references * Update logic to correctly match client-side item caps --------- Co-authored-by: Fabian Dill <Berserker66@users.noreply.github.com>
145 lines
4.9 KiB
Markdown
145 lines
4.9 KiB
Markdown
# [Archipelago](https://archipelago.gg)  | [Install](https://github.com/ArchipelagoMW/Archipelago/releases)
|
|
|
|
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
|
|
* Subnautica
|
|
* Risk of Rain 2
|
|
* The Legend of Zelda: Ocarina of Time
|
|
* Timespinner
|
|
* Super Metroid
|
|
* Secret of Evermore
|
|
* Final Fantasy
|
|
* 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
|
|
* 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
|
|
* 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
|
|
* Kingdom Hearts 1
|
|
* Mega Man 2
|
|
* Yacht Dice
|
|
* Faxanadu
|
|
* Saving Princess
|
|
* Castlevania: Circle of the Moon
|
|
* Inscryption
|
|
* Civilization VI
|
|
* The Legend of Zelda: The Wind Waker
|
|
* Jak and Daxter: The Precursor Legacy
|
|
* Super Mario Land 2: 6 Golden Coins
|
|
* shapez
|
|
* Paint
|
|
|
|
For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
|
|
Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/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](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)
|
|
* [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.
|
|
|
|
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](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).
|
|
|
|
## 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.
|
|
|
|
* [z3randomizer](https://github.com/ArchipelagoMW/z3randomizer)
|
|
* [Enemizer](https://github.com/Ijwu/Enemizer)
|
|
* [Ocarina of Time Randomizer](https://github.com/TestRunnerSRL/OoT-Randomizer)
|
|
|
|
## Contributing
|
|
|
|
To contribute to Archipelago, including the WebHost, core program, or by adding a new game, see our
|
|
[Contributing guidelines](/docs/contributing.md).
|
|
|
|
## FAQ
|
|
|
|
For Frequently asked questions, please see the website's [FAQ Page](https://archipelago.gg/faq/en/).
|
|
|
|
## Code of Conduct
|
|
|
|
Please refer to our [code of conduct](/docs/code_of_conduct.md).
|