summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README2
-rw-r--r--docs/architecture.txt16
2 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
index 5c273f8..84907c4 100644
--- a/README
+++ b/README
@@ -47,6 +47,8 @@ Run `make space`. Warning: This will remove source files from dump.
Check Bugzilla for things that need to be done. [3]
+See docs/ for the obvious.
+
[0] http://www.katawa-shoujo.com/
[1] https://github.com/cujojs/when/
[2] If you're on Windoze, sucks for you. Use a better OS.
diff --git a/docs/architecture.txt b/docs/architecture.txt
new file mode 100644
index 0000000..d6f7612
--- /dev/null
+++ b/docs/architecture.txt
@@ -0,0 +1,16 @@
+This is an overview of the layout of the code.
+
+unrpyc/ decompiles rpyc from the distribution to JSON so that it can be parsed
+with JSON.parse.
+
+js/html5ks.js is the main entry point; this initializes the code then calls
+the init function in the submodules. It also manages transforms to fit the
+container to the window.
+
+js/imachine.js interprets instructions from imachine.json to jump to scenes,
+play videos, select branches as appropriate based on choices.
+
+js/api.js effectively runs script.json, dispatching commands to functions
+which operate on the DOM.
+
+js/menu.js manages the main menu, context menu, and options menu.