New guides & localization

.docsifytopdfrc.json

@@ -0,0 +1,5 @@
+{
+	"contents": [ "docs/ru/config/_sidebar.md" ],
+	"pathToPublic": "docs.pdf",
+	"emulateMedia": "screen"
+}

.github/workflows/github-pages.yml

@@ -1,36 +1,31 @@
-name: Build docs & Deploy
+name: Deploy
+
 on:
   push:
     branches:
       - master
+
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Setup Node
-        uses: actions/setup-node@v2
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
         with:
           node-version: '14'
-      - name: Cache
-        uses: actions/cache@v1
+      - uses: actions/cache@v1
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
-      - name: Setup grunt
-        run: npm install -g grunt-cli
-      - name: Setup other dependencies
-        run: npm install --safe-dev
-      - name: Build docs
-        run: grunt docs_api
-      - name: Deploy
-        uses: JamesIves/github-pages-deploy-action@4.1.6
+      - run: npm install -g grunt-cli
+      - run: npm install --safe-dev
+      - run: grunt docs_api
+      - uses: JamesIves/github-pages-deploy-action@4.1.6
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BASE_BRANCH: master
           BRANCH: gh-pages
-          FOLDER: out
-          single-commit: true
+          FOLDER: docs
+          single-commit: true

.gitignore

@@ -1,5 +1,6 @@
 /documentation/core-engine/headers/core-engine.d.ts
 /package-lock.json
-/node_modules
-/OLD
-/out
+/node_modules/
+/docs/README.md
+/docs/headers/
+/docs/api/

.vscode/settings.json

@@ -4,7 +4,8 @@
 	},
     "spellright.language": [
         "en",
-        "uk"
+        "uk",
+        "ru"
     ],
     "spellright.documentTypes": [
         "markdown",
@@ -14,4 +15,4 @@
     "markdown.extension.tableFormatter.normalizeIndentation": true,
     "markdown.extension.list.indentationSize": "inherit",
     "markdown.extension.toc.orderedList": true
-}
+}

.vscode/spellright.dict

@@ -5,3 +5,8 @@ minecraft
 Superflat
 Params
 perlin
+шейдеры
+шейдер
+Майнкрафт
+суперплоскость
+калбек

.vscode/tasks.json

@@ -6,7 +6,7 @@
         {
             "label": "Run typedoc",
             "type": "shell",
-            "command": "grunt docs_api",
+            "command": "npm run build",
             "group": {
                 "kind": "build",
                 "isDefault": true
@@ -15,14 +15,11 @@
         {
             "label": "Initialize Environment",
             "type": "shell",
-            "options": {
-                "cwd": "documentation"
-            },
-            "command": "npm install --safe-dev",
+            "command": "npm install --save-dev",
             "group": {
                 "kind": "build",
                 "isDefault": true
             }
         }
     ]
-}
+}

README.md

@@ -14,6 +14,6 @@ npm install -g grunt-cli
 
 Documentation repository is located at [GitHub](https://github.com/mineprogramming/innercore-docs).
 
-To build this repository locally, open this folder in Visual Studio Code and run (_Ctrl+Shift+B_) **Initialize Environment** task. This will install all required npm dependencies locally. To build typedoc documentation and headers, run **Run Typedoc** task.
+To build this repository locally, open this folder in Visual Studio Code and run (_Ctrl+Shift+B_) **Initialize Environment** task. This will install all required npm dependencies locally. To build typedoc documentation and headers, run **Run Typedoc** task. Use npm package manager to perform another scripts, such as `npm run build-serve` or `npm run serve`.
 
 [Goto Docs](/)

docs/config/_404.md

@@ -0,0 +1,24 @@
+# Oops... Not found!
+
+## [Diving back into documentation...](https://docs.mineprogramming.org/#/)
+
+<script>
+(function (url) {
+    var ua        = navigator.userAgent.toLowerCase(),
+        isIE      = ua.indexOf('msie') !== -1,
+        version   = parseInt(ua.substr(4, 2), 10);
+
+    // Internet Explorer 8 and lower
+    if (isIE && version < 9) {
+        var link = document.createElement('a');
+        link.href = url;
+        document.body.appendChild(link);
+        link.click();
+    }
+
+    // All other browsers can use the standard window.location.href (they don't lose HTTP_REFERER like Internet Explorer 8 & lower does)
+    else {
+        window.location.href = url;
+    }
+})("https://docs.mineprogramming.org/#/");
+</script>

documentation/static/en/config/_navbar.md → docs/config/_navbar.md

@@ -1,3 +1,3 @@
 - Language
-  - [:uk: English](/en/)
+  - [:us: English](/)
   - [:ru: Русский](/ru/)

docs/config/_sidebar.md

@@ -0,0 +1,38 @@
+- [Horizon](/page/apps/horizon/index.md)
+  - [Packs](/page/apps/horizon/pack-system.md)
+  - [What is in pack](/page/apps/horizon/packs.md)
+
+- [Inner Core](/page/apps/innercore/index.md)
+  - [Core Engine API](/api/modules.html ':ignore :target=_self')
+  - [Changelog](/page/apps/innercore/changelog.md)
+
+  Getting Started
+  - [Inner Core Mod Toolchain](/page/guides/getting-started/setup-toolchain.md)
+  - [Configure your toolchain](/page/guides/getting-started/toolchain-configuration.md)
+  - [Mod Configuration Files](/page/guides/getting-started/config.md)
+
+  Minecraft
+  - [Attributes](/page/guides/minecraft/attributes.md)
+  - [Player Containers](/page/guides/minecraft/playercontainers.md)
+
+  Mod API
+  - [Callbacks](/page/guides/mod-api/callbacks.md)
+
+  Mod Resources
+  - [Materials](/page/guides/mod-resources/materials.md)
+
+  Player
+  - [Abilities](/page/guides/player/abilities.md)
+
+  World
+  - [Biomes](/page/guides/world/biomes.md)
+  - [Dimensions](/page/guides/world/dimensions.md)
+
+- [Contributing](/page/other/contributing.md)
+  - [Creating new pages](/page/other/create-page.md)
+
+- Libraries
+  - [BackpackAPI](/page/lib/BackpackAPI.md)
+
+- Mods
+  - [IndustrialCraft](/page/mod/IndustrialCraft2.md)

docs/index.html

@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<head>
+  <meta charset="UTF-8">
+  <title>Inner Core Docs</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Horizon, Inner Core and Core Engine documentation in one place.">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <!-- Do not 'fix' non-relative src location, it will be overrided by Docsify alias to perform assignment. -->
+  <link rel="stylesheet" href="/src/themes/docsify-darklight-theme.min.css" title="docsify-darklight-theme" type="text/css" />
+  <!-- link rel="stylesheet" href="/src/themes/prism-vsc-dark-plus.css" type="text/css" /-->
+</head>
+<body>
+  <div id="app">Inner Core Docs</div>
+  <script>
+    (function (redirect, href) {
+      if (/^\/?en\//g.test(href)) {
+        return redirect('#' + href.replace('en', '').replace('//', ''));
+      }
+      if (href == 'ru' || href == '/ru') {
+        return redirect('#/ru/');
+      }
+      if (href == 'en' || href == '/en') {
+        return redirect('#/');
+      }
+    })(function (url) {
+      console.log(url);
+      var ua    = navigator.userAgent.toLowerCase(),
+        isIE    = ua.indexOf('msie') !== -1,
+        version = parseInt(ua.substr(4, 2), 10);
+
+      // Internet Explorer 8 and lower
+      if (isIE && version < 9) {
+        var link = document.createElement('a');
+        link.href = url;
+        document.body.appendChild(link);
+        link.click();
+      }
+
+      // All other browsers can use the standard window.location.href (they don't lose HTTP_REFERER like Internet Explorer 8 & lower does)
+      else {
+        window.location.href = url;
+      }
+    }, (function () {
+      var href = window.location.href;
+      var index = href.indexOf('#');
+      return index === -1 ? '' : href.slice(index + 1);
+    })());
+  </script>
+  <script>
+    window.$docsify = {
+      name: 'Inner Core Docs',
+      repo: 'mineprogramming/innercore-docs',
+      loadSidebar: 'config/_sidebar.md',
+      loadNavbar: 'config/_navbar.md',
+      notFoundPage: {
+        '/ru/': 'ru/config/_404.md',
+        '/': 'config/_404.md'
+      },
+      subMaxLevel: 4,
+      relativePath: true,
+      nameLink: {
+        '/ru': '#/ru/',
+        '/': '#/'
+      },
+      autoHeader: true,
+      executeScript: true,
+      auto2top: true,
+      basePath: '/',
+      // noCompileLinks: [
+        // 'https?://(docs.mineprogramming.org|localhost).*)'
+      // ],
+      // Just redirects page to default language without loading config
+      // fallbackLanguages: ['en', 'ru'],
+      // Reserved for debugging purposes only!
+      alias: {
+        '/ru/(.*/|)config/(.*)': '/ru/config/$2',
+        '/.*/config/(.*)': '/config/$1',
+        '/.*/src/(.*)': '/src/$1'
+      },
+      themeable: {
+        readyTransition: true, // default
+        responsiveTables: true // default
+      },
+      // https://github.com/jperasmus/docsify-copy-code
+      copyCode: {
+        buttonText: {
+          '/ru/': 'Скопировать в буфер обмена',
+          '/': 'Copy to clipboard'
+        },
+        errorText: {
+          '/ru/': 'Ошибка',
+          '/': 'Error'
+        },
+        successText: {
+          '/ru/': 'Скопировано',
+          '/': 'Copied'
+        }
+      },
+      // https://jhildenbiddle.github.io/docsify-tabs
+      tabs: {
+        persist: true,     // default
+        sync: true,        // default
+        theme: 'classic',  // default
+        tabComments: true, // default
+        tabHeadings: true  // default
+      },
+      timeUpdater: {
+        text: '> Last Modify: {docsify-updated}',
+        formatUpdated: '{DD}.{MM}.{YYYY}'
+      },
+      plugins: [
+        function (hook, vm) {
+          hook.beforeEach(function (html) {
+            var url;
+            if (/githubusercontent\.com/.test(vm.route.file)) {
+              url = vm.route.file
+                .replace('raw.githubusercontent.com', 'github.com')
+                .replace(/\/gh-pages/, '/blob/gh-pages');
+            } else if (/jsdelivr\.net/.test(vm.route.file)) {
+              url = vm.route.file.replace('cdn.jsdelivr.net/gh', 'github.com').replace('@gh-pages', '/blob/gh-pages');
+            } else {
+              url = 'https://github.com/mineprogramming/innercore-docs/blob/gh-pages/' + vm.route.file;
+            }
+            if (/ru\//.test(vm.route.file)) {
+              return html + '\n\n[:memo: Изменить документ](' + url + ')';
+            }
+            return html + '\n\n[:memo: Edit Document](' + url + ')';
+          });
+        }
+      ]
+    };
+  </script>
+  <script src="/src/docsify.min.js"></script>
+  <script src="/src/themes/docsify-darklight-theme.min.js"></script>
+  <script src="/src/syntax/prism-json.min.js"></script>
+  <script src="/src/syntax/prism-jsonp.min.js"></script>
+  <script src="/src/syntax/prism-python.min.js"></script>
+  <script src="/src/syntax/prism-markdown.min.js"></script>
+  <script src="/src/syntax/prism-bash.min.js"></script>
+  <script src="/src/syntax/prism-batch.min.js"></script>
+<script src="//localhost:35729/livereload.js?snipver=1" async="" defer=""></script></body>
+</html>

docs/page/apps/horizon/index.md

@@ -0,0 +1,30 @@
+## What is Horizon Modding Kernel (HMK)?
+
+Horizon is a universal platform for launching mobile games with mods. At the moment, it supports only Inner Core, which contains Minecraft: Bedrock Edition 1.11.4 and 1.16.201. Horizon allows you to create and store several independent Inner Core packages, which in turn allows you to divide different mod packs and worlds with these packages. Development can take place in JavaScript, Java, C++ and not only.
+
+## Structure of the HMK pack
+
+1. The game on which the launcher is based
+2. The launcher on which the user will play
+3. The browser of mods that the user can apply to the game
+
+## Native mods
+
+Mods are written in C++ and applied to game directly.
+They have full access to game and can use all its functions.
+
+## Useful links
+
+[Horizon Modding Kernel](https://play.google.com/store/apps/details?id=com.zheka.horizon)
+
+[Group in VK](https://vk.com/core_engine)
+
+[Inner Core Mod Toolchain — develop and build modifications](https://github.com/zheka2304/innercore-mod-toolchain)
+
+[Setup up Inner Core Mod Toolchain on YouTube](https://www.youtube.com/watch?v=ofwKkRYh97k)
+
+[Tools for development of mods](https://icmods.mineprogramming.org/dev)
+
+[Discussion in VK for sending messages about bugs](https://vk.com/topic-134044100_41523503)
+
+[Documentation for development of mods](https://docs.mineprogramming.org)