Archipelago API Reference¶
Archipelago is still under development, so the API is subject to change.
Get Started¶
The first thing you should do to get started with Archipelago is to read the Contributing Guidelines, which cover the requirements of not only contributing to the main project, but the requirements and expectations of a world as well.
Get Started:
- Contributing Guidelines
- World Maintainer
- Style Guide
- Running From Source
- Adding Games
- apworld Specification
- Archipelago API
- Archipelago Options API
- Archipelago Settings API
- Entrance Randomization
- Network Protocol
- Archipelago Unit Testing API
- APWorld Dev FAQ
- My game has a restrictive start that leads to fill errors
- I have multiple settings that change the item/location pool counts and need to balance them out
- I learned about indirect conditions in the world API document, but I want to know more. What are they and why are they necessary?
- I uploaded the generated output of my world to the webhost and webhost is erroring on corrupted multidata
- Archipelago World Code Owners / Maintainers Document
Code Reference:
- worlds.AutoWorld
- BaseClasses
- Options
AccessibilityAssembleOptionsBossMetaChoiceCommonOptionsConnectionsMetaDeathLinkDeathLinkMixinDefaultOnToggleExcludeLocationsFreeTextFreezeValidKeysItemDictItemLinksItemSetItemsAccessibilityLocalItemsLocationSetNamedRangeNonLocalItemsNumericOptionOptionOptionDictOptionErrorOptionGroupOptionListOptionSetOptionsMetaPropertyPerGameCommonOptionsPlandoBossesPlandoConnectionPlandoConnectionsPlandoTextPlandoTextsPriorityLocationsProgressionBalancingRangeRemovedStartHintsStartInventoryStartInventoryPoolStartLocationHintsTextChoiceToggleVerifyKeysVisibilitydump_player_options()generate_yaml_templates()get_option_groups()item_and_loc_options
- Rules Helpers
- Fill
- Entrance Rando
- Utils
ByValueDeprecateDictKeyedDefaultDictRepeatableChainRestrictedUnpicklerUniqueKeyLoaderVersionVersionExceptionasync_start()build_sphinx_docs()cache_argsless()cache_path()cache_self1()chaining_prefix()deprecate()format_SI_prefix()freeze_support()get_adjuster_settings()get_adjuster_settings_no_defaults()get_cert_none_ssl_context()get_default_adjuster_settings()get_file_safe_name()get_fuzzy_results()get_input_text_from_response()get_intended_text()get_options()get_public_ipv4()get_public_ipv6()get_text_after()get_text_between()get_unique_identifier()home_path()init_logging()int16_as_bytes()int32_as_bytes()is_frozen()is_iterable_except_str()is_kivy_running()load_data_package_for_checksum()local_path()messagebox()open_directory()open_file()open_filename()output_path()pc_to_snes()persistent_load()persistent_store()read_snes_rom()restricted_loads()snes_to_pc()store_data_package_for_checksum()stream_input()title_sorted()tkinter_center_window()tuplize_version()user_path()visualize_regions()
- Patch
- Settings API
- NetUtils
- Test Bases
- Common Client
