Why is DMAPI Validation Failing?

[Cyberboss]

A deployment can fail to complete due to DMAPI validation issues. See potential solutions below.

[Cyberboss]

Potential Causes of DMAPI Validation

Note, as tgstation-server is primarily used by the SpaceStation 13 community, a lot of answers will be tailored to common issues seen in their codebases. If your solution is not listed here, please comment and we'll see if we can find one.

Does your codebase have the DMAPI integrated?

TGS requires an, up-to-date, DM "library" called the DreamMaker API to be included in your codebase to pass DMAPI validation. It can be recognized by the files being included somewhere in your DreamMaker code.

If the DMAPI is NOT present, you must do one of two things.

• Integrate the DMAPI into your codebase. The process is fairly simple and it works with any BYOND version above 512. See here for instructions.
• Disable DMAPI validation under TGS deployment settings.

Is your startup timeout too short for your hardware?

By default, TGS times out DMAPI validation after 1 minute. If your server cannot start your BYOND world faster than that, you may encounter this issue.

Try increasing the Startup Timeout property in the server settings page of TGS.

Are your running in the correct security level?

By default, TGS runs worlds with the Safe BYOND security level. For many SS13 codebases, this is insufficient even for DMAPI validation. Try increasing the DMAPI validation security level on the Deployments page of your TGS control panel to Trusted if this sounds like something you require.

Do you have unmet native dependencies?

Some codebases require you to build native libraries such as rust-g for your world to run. Many codebases provide scripts to build these dependencies, such as /tg/'s tgs_scripts.

Runtime errors because of this usually contain mention of librust_g.so or libbyond.so.

YOU CANNOT USE LINUX BINARIES THAT WERE NOT BUILT ON YOUR SERVER

Some very naughty codebases (cough cough PARADISE) and, by extension, their derivatives, insist on storing Linux binaries as part of their git repository. These binaries are custom built to run on the hardware operated by the official server of the codebase.

99% of the time, using these on your own server will not work you MUST use binaries built on your server machine.

Are you running auxtools/extools or some derivative (auxmos, auxlua, auxcov, etc...)?

Make sure you're running a BYOND version that matches the version the library was coded for. Newer BYOND versions generally always have issues with running older versions of these libraries.

None of these worked?

Try enabling Log DreamDaemon Output in the TGS server settings. On the next deployment, the entire output of DreamDaemon during DMAPI validation will be put in your instance's Diagnostics/DreamDaemonLogs folder with the extension .dmapi.log. These may provide a clue as to why validation is failing.

Failing all else, try asking a question on this forum.