From 2ee1f6550b37185798209e8863924c7323bb81c0 Mon Sep 17 00:00:00 2001
From: chylex <info@chylex.com>
Date: Sun, 23 Oct 2016 19:25:26 +0200
Subject: [PATCH] Add savefile.js with the database format specifications

---
 src/tracker/savefile.js | 66 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 src/tracker/savefile.js

diff --git a/src/tracker/savefile.js b/src/tracker/savefile.js
new file mode 100644
index 0000000..4bbca68
--- /dev/null
+++ b/src/tracker/savefile.js
@@ -0,0 +1,66 @@
+/*
+ * SAVEFILE STRUCTURE
+ * ==================
+ *
+ * {
+ *   meta: {
+ *     users: {
+ *       <discord user id>: {
+ *         name: <user name>
+ *       }, ...
+ *     },
+ *
+ *     // the user index is an array of discord user ids,
+ *     // these indexes are used in the message objects to save space
+ *     userindex: [
+ *       <discord user id>, ...
+ *     ],
+ *
+ *     server: [
+ *       {
+ *         name: <server name>,
+ *         type: <"SERVER"|"DM">
+ *       }, ...
+ *     ],
+ *
+ *     channels: {
+ *       <discord channel id>: {
+ *         server: <server index in the metadata.server array>,
+ *         name: <channel name>
+ *       }, ...
+ *     }
+ *   },
+ *
+ *   data: {
+ *     <discord channel id>: {
+ *       <discord message id>: {
+ *         u: <user index of the sender>,
+ *         t: <message timestamp>,
+ *         m: <message content>,
+ *         f: <message flags>, // bit 1 = edited, bit 2 = has user mentions (omit for no flags),
+ *         e: [ // omit for no embeds
+ *           {
+ *             url: <embed url>,
+ *             type: <embed type>
+ *           }, ...
+ *         ],
+ *         a: [ // omit for no attachments
+ *           {
+ *             url: <attachment url>
+ *           }, ...
+ *         ]
+ *       }, ...
+ *     }, ...
+ *   }
+ * }
+ */
+
+var SAVEFILE = function(){
+  this.db = {};
+  this.db.meta = {};
+  this.db.data = {};
+};
+
+SAVEFILE.prototype.toJson = function(){
+  return JSON.stringify(this.db);
+};