mirror of
https://github.com/ArchipelagoMW/Archipelago.git
synced 2026-04-11 09:38:25 -07:00
71 lines
2.1 KiB
Markdown
71 lines
2.1 KiB
Markdown
% Archipelago documentation master file, created by
|
|
% sphinx-quickstart on Wed Jul 6 20:09:51 2022.
|
|
% You can adapt this file completely to your liking, but it should at least
|
|
% contain the root `toctree` directive.
|
|
|
|
Welcome to Archipelago's Technical Documentation!
|
|
=================================================
|
|
|
|
## What is Archipelago?
|
|
Archipelago provides a generic framework for developing multiworld capability for game randomizers.
|
|
In all cases, presently, Archipelago is also the randomizer itself.
|
|
|
|
Archipelago is end-user facing software intended to facilitate randomizer and multiworld play for a variety of
|
|
supported games.
|
|
|
|
Archipelago presently supports the following games:
|
|
* 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
|
|
* Meritous
|
|
* Super Metroid/Link to the Past combo randomizer (SMZ3)
|
|
* ChecksFinder
|
|
* ArchipIDLE
|
|
* Hollow Knight
|
|
* The Witness
|
|
* Sonic Adventure 2: Battle
|
|
* Starcraft 2: Wings of Liberty
|
|
* Donkey Kong Country 3
|
|
* Dark Souls 3
|
|
|
|
For more information on the technical architecture of Archipelago,
|
|
please refer to the [Archipelago Technical Architecture](Architecture.md) document.
|
|
|
|
## Contributing to Archipelago
|
|
Contributions to the Archipelago code are welcome and dearly appreciated. Contributions may occur as changes to website
|
|
content, changes to Archipelago core code, additions of game integrations, or alterations to website functionality.
|
|
|
|
Please visit our [contributing guidelines on our GitHub README](https://github.com/ArchipelagoMW/Archipelago#contributing)
|
|
for some more information on what may be expected.
|
|
|
|
For information on contributing a game integration, check out our [document on adding games to Archipelago](./AddingGames.md).
|
|
|
|
## Table of Contents
|
|
```{toctree}
|
|
---
|
|
maxdepth: 2
|
|
caption: "Documentation contents:"
|
|
---
|
|
AddingGames
|
|
WorldAPI
|
|
NetworkProtocol
|
|
NetworkDiagram
|
|
```
|
|
|
|
## Indices and tables
|
|
* {ref}`genindex`
|
|
* {ref}`modindex`
|
|
* {ref}`search`
|