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 :doc:`contributing`, which cover
the requirements of not only contributing to the main project, but the requirements and expectations of a world as well.


.. toctree::
    :maxdepth: 2
    :caption: Get Started:

    contributing
    world maintainer
    style
    running from source
    adding games
    apworld specification
    world api
    options api
    settings api
    entrance randomization
    network protocol
    tests
    apworld_dev_faq
    codeowners


.. toctree::
    :maxdepth: 2
    :caption: Code Reference:

    autoworld
    baseclasses
    options
    rules
    fill
    entrance_rando
    utils
    patch
    settings
    netutils
    test
    commonclient