summaryrefslogtreecommitdiffstats
path: root/src/common/interface/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/interface/README')
-rw-r--r--src/common/interface/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/common/interface/README b/src/common/interface/README
new file mode 100644
index 00000000..efa19700
--- /dev/null
+++ b/src/common/interface/README
@@ -0,0 +1,13 @@
+This directory is code that could POSSIBLY be used by both the engine and
+clients.
+
+It's very, very important that nothing here gets messed up that violates
+client/engine separation. All interfaces use simple messages composed of
+serializable types, and no binary data that could break is shared. It's
+basically a functional version of a human-readable OSC interface, in both
+directions.
+
+The interface here maps directly on to the OSC interface - except it can
+happen in the same process as well, with only (virtual) function call
+overhead.
+