Fork of Archipelago Multi-Game Randomizer and Server that runs on https://ap.hollymcfarland.com
Go to file
Fabian Dill dcce53f8c8 Merge branch 'main' into breaking_changes
# Conflicts:
#	Adjuster.py
#	Gui.py
#	MultiClient.py
#	setup.py
#	worlds/alttp/AdjusterMain.py
#	worlds/alttp/Main.py
2021-02-21 20:15:07 +01:00
.github name lint to lint 2021-01-17 06:59:46 +01:00
WebHostLib Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
data Merge branch 'main' into breaking_changes 2021-02-19 13:45:50 +01:00
test Merge branch 'main' into breaking_changes 2021-02-19 13:45:50 +01:00
worlds Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
.gitignore Add /output and /Output Logs to .gitignore 2020-12-06 11:28:20 -05:00
Adjuster.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
BaseClasses.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
ER_hint_reference.txt Replace keysanity with map/compass/key/bk shuffle 2019-12-13 22:37:52 +01:00
Fill.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
Gui.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
GuiUtils.py Split adjuster into own program 2021-02-19 19:08:11 +01:00
LICENSE Update timestamp of own rights 2021-02-02 19:07:02 -08:00
ModuleUpdate.py squashed commit of many breaking changes 2020-10-19 08:26:31 +02:00
MultiClient.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
MultiMystery.py update Archipelago 2021-01-03 14:32:32 +01:00
MultiServer.py Sample implemention of JSONtoTextParser 2021-01-31 11:33:39 +01:00
Mystery.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
NetUtils.py Sample implemention of JSONtoTextParser 2021-01-31 11:33:39 +01:00
Options.py update Options system #2 2020-10-24 19:46:13 +02:00
Patch.py handle merge conflicts after plando update 2021-01-17 06:54:38 +01:00
README.md Update README.md (#163) 2021-02-03 01:37:05 +01:00
Utils.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
WebHost.py WebHost: Move module into WebHostLib to prevent shadowing WebHost.py 2020-07-11 16:59:37 +02:00
WebUI.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +01:00
_config.yml Set theme jekyll-theme-slate 2020-06-19 03:22:27 +02:00
dumpSprites.py re-export spriteData 2020-12-06 17:12:41 +01:00
host.yaml Added hash/inverted sign message 2021-01-31 20:57:18 -06:00
icon.ico update icon 2020-12-06 14:36:14 +01:00
inno_setup_38.iss update Archipelago 2021-01-03 14:32:32 +01:00
inno_setup_39.iss update Archipelago 2021-01-03 14:32:32 +01:00
meta.yaml update meta.yaml 2020-11-14 19:56:40 +01:00
playerSettings.yaml allow ER coop 2021-02-20 02:30:55 +01:00
pytest.ini use pytest for github unittests 2020-04-29 18:44:03 +02:00
requirements.txt update prompt_toolkit 2021-02-21 13:57:00 +01:00
setup.py Merge branch 'main' into breaking_changes 2021-02-21 20:15:07 +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

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.