[DOCS] Added loading process & glossary

muit · muit · commit 63f0fe228200 · 2020-11-30T00:30:59.000+01:00
diff --git a/Docs/README.md b/Docs/README.md
@@ -6,6 +6,10 @@ If you like our plugins, consider becoming a Patron. It will go a long way in he
 
 [![patron](assets/patron_small.png)](https://www.patreon.com/bePatron?u=16503983)
 
+## Last Version: {{ VersionName }}
+**{{ EngineVersion }}** and the previous release are supported.
+Save Extension, just like other Piperift plugins, is updated regularly for the 2 most recent unreal engine versions.
+
 ## Intended Usage
 
 Our plugins are designed to work for very different games and needs, but naturally, they are more focused towards satisfying certain needs.
diff --git a/Docs/_glossary.md b/Docs/_glossary.md
@@ -0,0 +1,3 @@
+##### Record
+Contains a block of serialized information.
+Each actor, component or level have an assotiated record containing its saved information.
diff --git a/Docs/_sidebar.md b/Docs/_sidebar.md
@@ -11,5 +11,7 @@
   - [Configuration](resources/configuration.md)
   - [Level Streaming](resources/level-streaming.md)
   - [Lifetime Components](resources/lifetime-components.md)
+  - [Saving Process](resources/saving-process.md)
+  - [Loading Process](resources/loading-process.md)
 
 - [Credits](credits.md)
diff --git a/Docs/index.html b/Docs/index.html
@@ -13,6 +13,11 @@
 <body>
   <div data-app id="main">Loading...</div>
   <div id="app"></div>
+
+  <!-- Early Plugins -->
+  <script src="//cdn.jsdelivr.net/npm/docsify-edit-on-github"></script>
+  <script src="./src/glossary.js"></script>
+  
   <script>
     window.$docsify = {
       //name: '<img src="assets/logo.png" data-origin="assets/logo.png" class="sidebar-logo" width="50%">',
@@ -45,6 +50,16 @@
         auth: ' ',
         pre: '',
         style: 'text-align: center;'
+      },
+      plugins: [
+        EditOnGithubPlugin.create(
+          "https://github.com/PipeRift/SaveExtension/blob/main/Docs/",
+          "https://github.com/PipeRift/SaveExtension/edit/main/Docs/",
+          "<img class='emoji' src='https://github.githubassets.com/images/icons/emoji/memo.png' alt='memo'> Edit"),
+        Glossary.create({})
+      ],
+      mustache: {
+        data: ['https://raw.githubusercontent.com/PipeRift/SaveExtension/main/SaveExtension.uplugin']
       }
     }
   </script>
@@ -55,11 +70,36 @@
   <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-csharp.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-cpp.min.js"></script>
 
+  <link rel="stylesheet" href="unpkg.com/@fortawesome/fontawesome-free/css/fontawesome.css" />
+  <link rel="stylesheet" href="unpkg.com/@fortawesome/fontawesome-free/css/brands.css" />
+  <link rel="stylesheet" href="unpkg.com/@fortawesome/fontawesome-free/css/regular.css" />
+  <link rel="stylesheet" href="unpkg.com/@fortawesome/fontawesome-free/css/solid.css" />
+
   <!-- Plugins -->
   <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/docsify-tabs"></script>
   <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
   <script src="//unpkg.com/docsify-footer-enh/dist/docsify-footer-enh.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/front-matter.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-mustache"></script>
+  <script src="//unpkg.com/docsify-fontawesome/dist/docsify-fontawesome.min.js"></script>
+
+  <script src="//unpkg.com/mermaid/dist/mermaid.js"></script>
+  <script src="//unpkg.com/docsify-mermaid@latest/dist/docsify-mermaid.js"></script>
+  <script>
+    mermaid.initialize({
+      startOnLoad: true,
+      securityLevel: 'loose',
+      theme: 'dark',
+      themeVariables: {
+        darkMode: true
+      },
+      flowchart:{
+          htmlLabels:true,
+          curve:'linear',
+      },
+    });
+  </script>
 </body>
 </html>
diff --git a/Docs/resources/loading-process.md b/Docs/resources/loading-process.md
@@ -0,0 +1,51 @@
+# Loading
+Loading is divided in the following stages:
+
+```mermaid
+flowchart LR
+    classDef CEntry stroke:#ea9999;
+
+    A[Start]:::CEntry --> B[<b>Notify</b><br>OnLoadBegin]
+    B --> Load
+    Load --> C[<b>Notify</b><br>OnLoadFinish]
+    C --> D[Done]
+
+    subgraph Load [ ]
+        LoadB{Is at map?}:::CEntry;
+        LoadB -->|No| LoadC[Load Map];
+        LoadB -->|Yes| LoadD[Bake Filters];
+        LoadC --> LoadD;
+        LoadD --> LoadE[Prepare Levels];
+        LoadE --> LoadF[Deserialize World];
+
+        click LoadE "./?id=deserialize-world" "Deserialize World" _blank
+    end
+```
+
+## Bake filters
+In this step, all level filters and the general one are baked.
+We need this to check which actors to prepare in each level, and how to deserialize.
+
+## Prepare levels
+We must ensure actor correctness before loading the data into actors.
+That means all actors that were saved have to be restored, and actors that should not exist have to be deleted.
+
+```mermaid
+flowchart LR
+    classDef CEntry stroke:#ea9999;
+
+    Start:::CEntry --> PrepareLevel
+    PrepareLevel -->|Loop all levels| PrepareLevel
+    PrepareLevel --> Done
+
+    subgraph PrepareLevel [Prepare Level]
+      A[Remove not saved actors]:::CEntry --> B[Spawn missing saved actors];
+    end
+```
+
+## Deserialize World
+This is where the magic happens. The system goes through each actor to be loaded and deserializes its data from its record.
+```mermaid
+flowchart LR
+    A[Deserialize Game Instance] --> B[Deserialize Actors];
+```
diff --git a/Docs/resources/saving-process.md b/Docs/resources/saving-process.md
@@ -0,0 +1,12 @@
+# Saving
+
+Saving is divided in multiple stages:
+
+```mermaid
+graph LR
+    A[Start] --> B{Valid Map?};
+    B -->|Yes| D[Prepare Levels];
+    B -->|No| C[Load Map];
+    C --> D;
+    D --> E[Deserialize];
+```
diff --git a/Docs/src/glossary.js b/Docs/src/glossary.js
@@ -0,0 +1,67 @@
+let Glossary = {
+  create: (config) => {
+    this.config = config;
+
+    let loadGlossary = async () => {
+      return fetch('_glossary.md')
+      .then(function(data){
+        return data.text();
+      })
+      .then(function(text){
+        window.$docsify.terms = {};
+
+        let termTexts = text.split('#####');
+        termTexts.forEach((termText) => {
+          if (termText.length <= 5) { // If it can't possibly contain a term, skip
+            return;
+          }
+
+          // Parse the term and its content
+          let title = termText.split('\n', 1)[0].trim();
+          let id = title.toLowerCase().replace(' ','-');
+          let content = termText.substr(termText.indexOf('\n') + 1).trim();
+          content = content.replace("\r\n\r\n", "\n");
+          if (content.length > 200) {
+            content = content.substring(0, 200) + "...";
+          }
+          window.$docsify.terms[title] = {
+            id: id,
+            content: content
+          };
+        });
+      });
+    };
+
+    let addLinks = (content,next,terms) => {
+      for (let term in terms) {
+        console.log(term);
+
+        let regex = new RegExp(`\\b${term}\\b`,'ig');
+        content = content.replace(regex, (match) => {
+          let termData = terms[term];
+          return `[${match}*](/_glossary?id=${termData.id} "${termData.content}")`;
+        });
+      }
+      next(content);
+    };
+
+    return (hook, vm) => {
+      hook.beforeEach(function(content,next)
+      {
+        if(window.location.hash.match(/_glossary/g)) {
+          next(content);
+          return;
+        }
+
+        if (!window.$docsify.terms) {
+          // Glossary needs loading before creating the link
+          loadGlossary().then(() => {
+            addLinks(content, next, window.$docsify.terms);
+          })
+        } else {
+          addLinks(content, next, window.$docsify.terms);
+        }
+      });
+    };
+  }
+};

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+##### Record`
	`2`	`+Contains a block of serialized information.`
	`3`	`+Each actor, component or level have an assotiated record containing its saved information.`