Add base for xrf tools. Add section about running book locally.

README.md

@@ -11,6 +11,7 @@ Documentation for x-ray forge script engine template and tools.
 
 - Types repository: [https://github.com/xray-forge/xray-16-types](https://github.com/xray-forge/xray-16-types)
 - Engine repository: [https://github.com/xray-forge/stalker-xrf-engine](https://github.com/xray-forge/stalker-xrf-engine)
+- Tools repository: [https://github.com/xray-forge/stalker-xrf-tools](https://github.com/xray-forge/stalker-xrf-tools)
 - Binaries repository: [https://github.com/xray-forge/stalker-xrf-bin](https://github.com/xray-forge/stalker-xrf-bin)
 
 ---
@@ -20,3 +21,11 @@ Documentation for x-ray forge script engine template and tools.
 - EN locale assets: [https://gitlab.com/xray-forge/stalker-xrf-resources-locale-eng](https://gitlab.com/xray-forge/stalker-xrf-resources-locale-eng)
 - UA locale assets: [https://gitlab.com/xray-forge/stalker-xrf-resources-locale-ukr](https://gitlab.com/xray-forge/stalker-xrf-resources-locale-ukr)
 - RU locale assets: [https://gitlab.com/xray-forge/stalker-xrf-resources-locale-rus](https://gitlab.com/xray-forge/stalker-xrf-resources-locale-rus)
+
+### Working with the book locally
+
+- Make sure [rust](https://www.rust-lang.org/) is installed
+- [Install cargo mdbook](https://rust-lang.github.io/mdBook/guide/installation.html)
+  - `cargo install mdbook`
+- [Run mdbook locally](https://rust-lang.github.io/mdBook/guide/creating.html)
+  - `mdbook serve --open`

src/SUMMARY.md

@@ -4,7 +4,7 @@
 - [Changes](changes/changes.md)
 - [Installation](xrf/installation.md)
 
-- [XRF](xrf/xrf.md)
+- [XRF engine](xrf/xrf.md)
   - [Building](xrf/building/building.md)
     - [Building UI forms](xrf/building/building_forms.md)
     - [Building configs](xrf/building/building_configs.md)
@@ -27,6 +27,19 @@
   - [Switching engines](xrf/switching_engines.md)
   - [Testing](xrf/testing.md)
 
+- [XRF tools](tools/tools.md)
+  - [Application](tools/app/tools_app.md)
+    - [Archive editor](tools/app/archive_editor.md)
+    - [Dialog editor](tools/app/dialog_editor.md)
+    - [Config editor](tools/app/config_editor.md)
+    - [Exports viewer](tools/app/exports_viewer.md)
+    - [Icon editor](tools/app/icon_editor.md)
+    - [Spawn editor](tools/app/spawn_editor.md)
+  - [CLI](tools/cli/tools_cli.md)
+    - [Archive](tools/cli/archive.md)
+    - [LTX](tools/cli/ltx.md)
+    - [Spawn](tools/cli/spawn.md)
+
 - [Debugging]()
   - [AI and logics](debugging/ai_and_logics.md)
   - [Engine (C++)](debugging/engine.md)

src/changes/changes.md

@@ -86,6 +86,13 @@
 - Updated schemes abstraction for easier testing/extending/sharing/updating of game logics schemes
 - Add support for dynamic files with `marshal` lib, ability to save dynamic custom data without 16K limit
 
+## 🧪 Tools
+
+- Added spawn pack/unpack/verify in CLI
+- Added LTX files formatting and verification in CLI
+- Added spawn file inspector in tools application
+- Added spawn file utilities in tools application
+
 ## 🧪 TODO
 
 For todos check following git projects:

src/tools/app/archive_editor.md

@@ -0,0 +1,11 @@
+# 🔨 Archive editor
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 todo
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/app/config_editor.md

@@ -0,0 +1,11 @@
+# 🔨 Config editor
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 todo
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/app/dialog_editor.md

@@ -0,0 +1,11 @@
+# 🔨 Dialog editor
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 todo
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/app/exports_viewer.md

@@ -0,0 +1,11 @@
+# 🔨 Exports viewer
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 todo
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/app/icon_editor.md

@@ -0,0 +1,11 @@
+# 🔨 Icon editor
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 todo
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/app/spawn_editor.md

@@ -0,0 +1,11 @@
+# 🔨 Spawn editor
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 todo
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/app/tools_app.md

@@ -0,0 +1,11 @@
+# 🔨 Tools application
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 todo
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/cli/archive.md

@@ -0,0 +1,11 @@
+# 🔨 Archive
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 Commands
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/cli/ltx.md

@@ -0,0 +1,11 @@
+# 🔨 LTX
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 Commands
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/cli/spawn.md

@@ -0,0 +1,11 @@
+# 🔨 Spawn
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 Commands
+
+todo; <br/>
+todo; <br/>
+todo; <br/>

src/tools/cli/tools_cli.md

@@ -0,0 +1,14 @@
+# 🔨 Tools cli
+
+Command line tools to assist with xray engine development.
+
+## 🔨 Commands
+
+- help
+- repack-spawn
+- unpack-spawn
+- pack-spawn
+- verify-spawn
+- unpack-archive
+- format-ltx
+- verify-ltx

src/tools/tools.md

@@ -0,0 +1,17 @@
+# 🔨 Tools
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 Application
+
+todo; <br/>
+todo; <br/>
+todo; <br/>
+
+## 🔨 CLI
+
+todo; <br/>
+todo; <br/>
+todo; <br/>