From 813dc539c844509fa8ee515ec4749a7cf60c2450 Mon Sep 17 00:00:00 2001
From: veclavtalica <veclavtalica@poto.cafe>
Date: Mon, 7 Oct 2024 10:44:42 +0300
Subject: [PATCH] /docs/interop.txt

---
 docs/interop.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 docs/interop.txt

diff --git a/docs/interop.txt b/docs/interop.txt
new file mode 100644
index 0000000..2048066
--- /dev/null
+++ b/docs/interop.txt
@@ -0,0 +1,9 @@
+api needs to facilitate easy interoperability with other languages and tools,
+for that certain steps are taken:
+
+* number of public api calls is kept at the minimum
+* procedure signatures can only use basic types, no aggregates, with exception of Vec/Matrix types and alike,
+  with no expectation on new additions (see /include/twn_types.h)
+* /include/twn_game_api.json file is hand-kept with a schema to aid automatic generation and other tooling
+
+one of main inspirations for that is opengl model