Fork of Archipelago Multi-Game Randomizer and Server that runs on https://ap.hollymcfarland.com
Go to file
Fabian Dill e94b99da65 SNIClient: make address optional for multi-snes 2022-02-20 04:17:27 +01:00
.github Run tests in Python 3.8 and 3.9 2022-01-21 23:12:42 +01:00
WebHostLib Tutorials: remove `/api` 2022-02-15 14:17:17 -06:00
data WebHost: allow switching out "/tracker/" for "/generic_tracker/" in a tracker url to get the generic tracker for that slot. 2021-12-03 02:41:56 +01:00
docs update docs with NetworkSlot and create_as_hint 2022-02-18 18:54:26 +01:00
test Core: provide a way to add to CollectionState init and copy 2022-02-17 07:07:34 +01:00
worlds Super Metroid: fix start_inventory 2022-02-19 17:43:16 +01:00
.gitignore git: cleanup gitignore, as a bunch of files/folders no longer exist in AP 2022-01-29 15:39:14 +01:00
BaseClasses.py Super Metroid: fix start_inventory 2022-02-19 17:43:16 +01:00
CommonClient.py git: cleanup gitignore, as a bunch of files/folders no longer exist in AP 2022-01-29 15:39:14 +01:00
FF1Client.py Move remote_items and _start_inventory from world to client (#227) 2022-01-23 06:38:46 +01:00
FactorioClient.py Move remote_items and _start_inventory from world to client (#227) 2022-01-23 06:38:46 +01:00
Fill.py ItemLinks: move item links to events, mess up their logic in doing so and lock them behind plando option "item_links" until they're fixed. 2022-02-17 06:07:20 +01:00
Generate.py ItemLinks: move item links to events, mess up their logic in doing so and lock them behind plando option "item_links" until they're fixed. 2022-02-17 06:07:20 +01:00
LICENSE update Copyright 2022-02-17 19:03:11 -08:00
LttPAdjuster.py Adjuster fixes and added GUI prompt for applying last settings (#173) 2022-01-20 04:19:58 +01:00
Main.py Add entrance info to start hints. 2022-02-19 10:52:05 -08:00
MinecraftClient.py Minecraft client: more general search for mod name 2021-12-19 19:15:09 +00:00
ModuleUpdate.py Setup: add setup specific requirements 2022-01-22 20:35:30 +01:00
MultiServer.py Multiserver: provide compat for 0.2.3 and somewhat older multidata 2022-02-19 17:50:56 +01:00
NetUtils.py Core: implement first version of ItemLinks 2022-02-05 15:49:19 +01:00
OoTAdjuster.py Options: change displayname to display_name 2022-02-02 16:29:29 +01:00
Options.py ItemLink; correct validation to allow for None replacement item 2022-02-13 20:19:17 +01:00
Patch.py Adjuster fixes and added GUI prompt for applying last settings (#173) 2022-01-20 04:19:58 +01:00
README.md Fill: remove warning loggers that confused people 2022-01-24 04:50:49 +01:00
SNIClient.py SNIClient: make address optional for multi-snes 2022-02-20 04:17:27 +01:00
Utils.py update docs with NetworkSlot and create_as_hint 2022-02-18 18:54:26 +01:00
WebHost.py WebHost: split autolaunch and autogen services 2021-12-13 05:48:33 +01:00
host.yaml Generate: allow meta to log-fail as opposed to exception-fail if category is missing in target 2022-01-06 22:01:18 +01:00
inno_setup.iss Setup: pass used python version into windows installer automatically 2022-01-21 08:39:42 +01:00
kvui.py Add an autofill !hint_location for clicking on a Missing: line, when user uses !missing. 2022-02-08 14:29:24 -08:00
meta.yaml Generate: return of the meta mystery 2021-11-21 18:09:06 +01:00
playerSettings.yaml LTTP: update playerSettings.yaml 2022-01-26 10:02:40 +01:00
pytest.ini use pytest for github unittests 2020-04-29 18:44:03 +02:00
requirements.txt Requirements: let's keep whitespace style consistent 2022-01-19 06:15:07 +01:00
setup.py Setup: add setup specific requirements 2022-01-22 20:35:30 +01:00

README.md

Archipelago Discord Shield | 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

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:

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. The installers function on Windows only.

If you are running Archipelago from a non-Windows system then the likely scenario is that you are comfortable running source code directly. Please see our wiki page on running Archipelago from source.

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

Contributions are welcome. We have a few asks of any new contributors.

  • Ensure that all changes which affect logic are covered by unit tests.
  • Do not introduce any unit test failures/regressions.

Otherwise, we tend to judge code on a case to case basis. It is a generally good idea to stick to PEP-8 guidelines to ensure consistency with existing code. (And to make the linter happy.)

Code of Conduct

We conduct ourselves openly and inclusively here. Please do not contribute to an environment which makes other people uncomfortable. This means that we expect all contributors or participants here to:

  • Be welcoming and inclusive in tone and language.
  • Be respectful of others and their abilities.
  • Show empathy when speaking with others.
  • Be gracious and accept feedback and constructive criticism.

These guidelines apply to all channels of communication within this GitHub repository. Please be respectful in both public channels, such as issues, and private, such as private messaging or emails.

Any incidents of abuse may be reported directly to Ijwu at hmfarran@gmail.com.