mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 20:21:32 -06:00
Docs: Added DS3 & DK3 to network graph
This commit is contained in:

committed by
black-sliver

parent
898fa203ad
commit
97b388747a
BIN
docs/network diagram/network diagram.jpg
Normal file
BIN
docs/network diagram/network diagram.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 526 KiB |
176
docs/network diagram/network diagram.md
Normal file
176
docs/network diagram/network diagram.md
Normal file
@@ -0,0 +1,176 @@
|
||||
```mermaid
|
||||
flowchart LR
|
||||
%% Diagram arranged specifically so output generates no terrible crossing lines.
|
||||
%% AP Server
|
||||
AS{Archipelago Server}
|
||||
|
||||
%% CommonClient.py
|
||||
CC[CommonClient.py]
|
||||
AS <-- WebSockets --> CC
|
||||
|
||||
subgraph "Starcraft 2"
|
||||
SC2[Starcraft 2 Game Client]
|
||||
SC2C[Starcraft2Client.py]
|
||||
SC2AI[apsc2 Python Package]
|
||||
|
||||
SC2C <--> SC2AI <-- WebSockets --> SC2
|
||||
end
|
||||
CC <-- Integrated --> SC2C
|
||||
|
||||
%% ChecksFinder
|
||||
subgraph ChecksFinder
|
||||
CFC[ChecksFinderClient]
|
||||
CF[ChecksFinder]
|
||||
CFC <--> CF
|
||||
end
|
||||
CC <-- Integrated --> CFC
|
||||
|
||||
%% A Link to the Past
|
||||
subgraph A Link to the Past
|
||||
LTTP[SNES]
|
||||
end
|
||||
SNI <-- Various, depending on SNES device --> LTTP
|
||||
|
||||
%% Final Fantasy
|
||||
subgraph Final Fantasy 1
|
||||
FF1[FF1Client]
|
||||
FFLUA[Lua Connector]
|
||||
BZFF[BizHawk with Final Fantasy Loaded]
|
||||
FF1 <-- LuaSockets --> FFLUA
|
||||
FFLUA <--> BZFF
|
||||
end
|
||||
CC <-- Integrated --> FF1
|
||||
|
||||
%% Ocarina of Time
|
||||
subgraph Ocarina of Time
|
||||
OC[OoTClient]
|
||||
LC[Lua Connector]
|
||||
OCB[BizHawk with Ocarina of Time Loaded]
|
||||
OC <-- LuaSockets --> LC
|
||||
LC <--> OCB
|
||||
end
|
||||
CC <-- Integrated --> OC
|
||||
|
||||
%% SNI Connectors
|
||||
SC[SNIClient]
|
||||
SNI["Super Nintendo Interface (SNI)"]
|
||||
CC <-- Integrated --> SC
|
||||
SC <-- WebSockets --> SNI
|
||||
|
||||
%% Super Metroid
|
||||
subgraph Super Metroid
|
||||
SM[SNES]
|
||||
end
|
||||
SNI <-- Various, depending on SNES device --> SM
|
||||
|
||||
%% Super Metroid/A Link to the Past Combo Randomizer
|
||||
subgraph "SMZ3"
|
||||
SMZ[SNES]
|
||||
end
|
||||
SNI <-- Various, depending on SNES device --> SMZ
|
||||
|
||||
%% Donkey Kong Country 3
|
||||
subgraph Donkey Kong Country 3
|
||||
DK3[SNES]
|
||||
end
|
||||
SNI <-- Various, depending on SNES device --> DK3
|
||||
|
||||
%% Native Clients or Games
|
||||
%% Games or clients which compile to native or which the client is integrated in the game.
|
||||
subgraph "Native"
|
||||
APCLIENTPP[Game using apclientpp Client Library]
|
||||
APCPP[Game using Apcpp Client Library]
|
||||
subgraph Secret of Evermore
|
||||
SOE[ap-soeclient]
|
||||
end
|
||||
SM64[Super Mario 64 Ex]
|
||||
V6[VVVVVV]
|
||||
MT[Meritous]
|
||||
TW[The Witness]
|
||||
SA2B[Sonic Adventure 2: Battle]
|
||||
DS3[Dark Souls 3]
|
||||
|
||||
APCLIENTPP <--> SOE
|
||||
APCLIENTPP <--> MT
|
||||
APCLIENTPP <-- The Witness Randomizer --> TW
|
||||
APCLIENTPP <--> DS3
|
||||
APCPP <--> SM64
|
||||
APCPP <--> V6
|
||||
APCPP <--> SA2B
|
||||
end
|
||||
SOE <--> SNI <-- Various, depending on SNES device --> SOESNES
|
||||
AS <-- WebSockets --> APCLIENTPP
|
||||
AS <-- WebSockets --> APCPP
|
||||
|
||||
%% Java Based Games
|
||||
subgraph Java
|
||||
JM[Mod with Archipelago.MultiClient.Java]
|
||||
STS[Slay the Spire]
|
||||
JM <-- Mod the Spire --> STS
|
||||
subgraph Minecraft
|
||||
MCS[Minecraft Forge Server]
|
||||
JMC[Any Java Minecraft Clients]
|
||||
MCS <-- TCP --> JMC
|
||||
end
|
||||
JM <-- Forge Mod Loader --> MCS
|
||||
end
|
||||
AS <-- WebSockets --> JM
|
||||
|
||||
%% .NET Based Games
|
||||
subgraph .NET
|
||||
NM[Mod with Archipelago.MultiClient.Net]
|
||||
subgraph FNA/XNA
|
||||
TS[Timespinner]
|
||||
RL[Rogue Legacy]
|
||||
end
|
||||
NM <-- TsRandomizer --> TS
|
||||
NM <-- RogueLegacyRandomizer --> RL
|
||||
subgraph Unity
|
||||
ROR[Risk of Rain 2]
|
||||
SN[Subnautica]
|
||||
HK[Hollow Knight]
|
||||
R[Raft]
|
||||
end
|
||||
NM <-- BepInEx --> ROR
|
||||
NM <-- "QModLoader (BepInEx)" --> SN
|
||||
NM <-- HK Modding API --> HK
|
||||
NM <--> R
|
||||
end
|
||||
AS <-- WebSockets --> NM
|
||||
|
||||
%% Archipelago WebHost
|
||||
subgraph "WebHost (archipelago.gg)"
|
||||
WHNOTE(["Configurable (waitress, gunicorn, flask)"])
|
||||
AH[AutoHoster]
|
||||
PDB[(PonyORM DB)]
|
||||
WH[WebHost]
|
||||
FWC[Flask WebContent]
|
||||
AG[AutoGenerator]
|
||||
|
||||
AH <-- SQL --> PDB
|
||||
WH -- Subprocesses --> AH
|
||||
FWC <-- SQL --> PDB
|
||||
WH --> FWC
|
||||
AG -- Deposit Generated Worlds --> PDB
|
||||
PDB -- Provide Generation Instructions --> AG
|
||||
WH -- Subprocesses --> AG
|
||||
end
|
||||
AH -- Subprocesses --> AS
|
||||
|
||||
%% Special subgraph for SoE for its SNES connection
|
||||
subgraph Secret of Evermore
|
||||
SOESNES[SNES]
|
||||
end
|
||||
|
||||
%% Factorio
|
||||
subgraph Factorio
|
||||
FC[FactorioClient] <-- RCON --> FS[Factorio Server]
|
||||
FS <-- UDP --> FG[Factorio Games]
|
||||
FMOD[Factorio Mod Generated by AP]
|
||||
FMAPI[Factorio Modding API]
|
||||
FMAPI <--> FS
|
||||
FMAPI <--> FG
|
||||
FMOD <--> FMAPI
|
||||
end
|
||||
CC <-- Integrated --> FC
|
||||
```
|
1
docs/network diagram/network diagram.svg
Normal file
1
docs/network diagram/network diagram.svg
Normal file
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 92 KiB |
Reference in New Issue
Block a user