Files
Bubberstation/code/modules/tgs
SkyratBot e9ee32f142 [MIRROR] Automatic TGS DMAPI Update [MDB IGNORE] (#17363)
* Automatic TGS DMAPI Update (#70843)

This pull request updates the TGS DMAPI to the latest version. Please
note any breaking or unimplemented changes before merging.

Co-authored-by: tgstation-server <tgstation-server@ users.noreply.github.com>

* Automatic TGS DMAPI Update

Co-authored-by: orange man <61334995+comfyorange@users.noreply.github.com>
Co-authored-by: tgstation-server <tgstation-server@ users.noreply.github.com>
2022-11-04 14:08:15 -04:00
..

DMAPI Internals

This folder should be placed on it's own inside a codebase that wishes to use the TGS DMAPI. Warranty void if modified.

  • includes.dm is the file that should be included by DM code, it handles including the rest.
  • The core folder includes all code not directly part of any API version.
  • The other versioned folders contain code for the different DMAPI versions.
    • v3210 contains the final TGS3 API.
    • v4 is the legacy DMAPI 4 (Used in TGS 4.0.X versions).
    • v5 is the current DMAPI version used by TGS >=4.1.
  • LICENSE is the MIT license for the DMAPI.

APIs communicate with TGS in two ways. All versions implement TGS -> DM communication using /world/Topic. DM -> TGS communication, called the bridge method, is different for each version.