[#133] Added Header.md documentation

LandOfRails · Jan 5, 2025 · aa948da · aa948da
1 parent deaa8f0
commit aa948da
Show file tree

Hide file tree

Showing 23 changed files with 147 additions and 20 deletions.
diff --git a/docs/.pages b/docs/.pages
@@ -0,0 +1,4 @@
+nav:
+    - index.md
+    - HowToUse.md
+    - ...
diff --git a/docs/ContentPacksV1.md → docs/ContentPackV1/ContentPacksV1.md b/docs/ContentPacksV1.md → docs/ContentPackV1/ContentPacksV1.md
diff --git a/docs/ContentPackV2/Content/.pages b/docs/ContentPackV2/Content/.pages
@@ -0,0 +1,9 @@
+nav:
+    - Header.md
+    - Signal.md
+    - ComplexSignal.md
+    - Asset.md
+    - Sign.md
+    - Signalbox.md
+    - Lever.md
+    - ...
diff --git a/docs/ContentPackV2_Asset.md → docs/ContentPackV2/Content/Asset.md b/docs/ContentPackV2_Asset.md → docs/ContentPackV2/Content/Asset.md
diff --git a/docs/ContentPackV2_Header.md → docs/ContentPackV2/Content/ComplexSignal.md b/docs/ContentPackV2_Header.md → docs/ContentPackV2/Content/ComplexSignal.md
diff --git a/docs/ContentPackV2/Content/Header.md b/docs/ContentPackV2/Content/Header.md
@@ -0,0 +1,79 @@
+---
+hide:
+  - toc
+---
+
+# Header (landofsignals.json)
+
+## Description
+
+The first thing you'll need to create a contentpack is the `landofsignals.json`.<br />
+It contains all the vitale information needed for LandOfSignals to add your content to the game.<br />
+It contains the name, author, packversion and addonversion of your pack as well as the links to the blocks.
+
+!!! info "The first entries in your ZIP file should be `/landofsignals.json` (file) and `/assets/` (directory).<br />There can't be a folder above."
+
+## Structure
+
+``` json linenums="1" title="landofsignals.json"
+{
+    "name": "My contentpack (1)", // (1)!
+    "packversion": "1.0", // (2)!
+    "author" : "John Doe", // (3)!
+    "addonversion": "2", // (4)!
+    "content": { // (5)!
+        "assets/landofsignals/folder1/complexsignal.json": "BLOCKCOMPLEXSIGNAL", // (6)!
+        "assets/landofsignals/folder2/signal.json": "BLOCKSIGNAL",
+        "assets/landofsignals/folder3/deco.json": "BLOCKDECO",
+        "assets/landofsignals/folder4/sign.json": "BLOCKSIGN",
+        "assets/landofsignals/folder5/signalbox.json": "BLOCKSIGNALBOX",
+        "assets/landofsignals/folder6/lever.json": "BLOCKLEVER"
+    }
+}
+```
+
+1.  
+
+    !!! info "The name you want your contentpack to have.<br />Preferably something meaningful and descriptive."
+
+    !!! warning "Needs to be unique!<br />If more than one pack has the same name, only one will be loaded."
+
+    !!! danger "Should not be changed!<br />Changing the name will break existing blocks."
+
+2.  
+
+    !!! info "The version of your pack.<br />Choose a format of your liking.<br />There is no validation."
+
+3.  
+
+    !!! info "The author(s) of the pack. You?<br />No validation as well."
+
+4.  
+
+    !!! info "The addon-version used.<br />Should be "2" (latest)"
+
+5.  
+
+    !!! info "This contains all yours blocks. Can be 1+ entries."
+
+    !!! note "The first folders always have to be `assets/landofsignals/`<br />After that you can choose folders and filenames freely."
+
+6.  
+
+    !!! info "Each entry (block) consists of the file path and type of block."
+
+    !!! abstract "Available types:<br />BLOCKCOMPLEXSIGNAL, BLOCKSIGNAL, BLOCKDECO, BLOCKSIGN, BLOCKSIGNALBOX and BLOCKLEVER<br /><br />Overview and further information<br / >[:octicons-arrow-right-24: ContentPacksV2](../ContentPacksV2.md)"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/ContentPackV2_Lever.md → docs/ContentPackV2/Content/Lever.md b/docs/ContentPackV2_Lever.md → docs/ContentPackV2/Content/Lever.md
diff --git a/docs/ContentPackV2_Sign.md → docs/ContentPackV2/Content/Sign.md b/docs/ContentPackV2_Sign.md → docs/ContentPackV2/Content/Sign.md
diff --git a/docs/ContentPackV2_Signal.md → docs/ContentPackV2/Content/Signal.md b/docs/ContentPackV2_Signal.md → docs/ContentPackV2/Content/Signal.md
diff --git a/docs/ContentPackV2/Content/Signalbox.md b/docs/ContentPackV2/Content/Signalbox.md
diff --git a/docs/ContentPacksV2.md → docs/ContentPackV2/ContentPacksV2.md b/docs/ContentPacksV2.md → docs/ContentPackV2/ContentPacksV2.md
@@ -11,7 +11,7 @@ Your contentpacks is made up from multiple parts, you can find a short descripti
     This file contains the name, author, version of your contentpack.<br />
     It also contains links to your blocks or contentsets.
 
-    [:octicons-arrow-right-24: Header documentation](#)
+    [:octicons-arrow-right-24: Header documentation](./Content/Header.md)
 
 </div>
 
@@ -23,7 +23,7 @@ Your contentpacks is made up from multiple parts, you can find a short descripti
     ---
 
     ![](signal.png){ width="300" }
-- 
+
     This is a simple signal, it has a more strict and simpler structure.<br />
     It is more performance-friendly and requires fewer lines.<br />
     It has only one controllable group and the model can only be changed via its texture.<br />
@@ -45,28 +45,39 @@ Your contentpacks is made up from multiple parts, you can find a short descripti
 
     [:octicons-arrow-right-24: Complex signal documentation](#)
 
+-   :material-traffic-cone:{ .lg .middle } __Asset/Deco__
+
+    ---
+
+    ![](deco.png){ width="300" }
+
+    Blocks that are not supposed to have any functionality can be added as a DECO block.<br />
+    They have their own creative tab.
+
+    [:octicons-arrow-right-24: Asset/Deco documentation](#)
+
 -   :material-sign-caution:{ .lg .middle } __Sign__
 
     ---
 
     ![](sign.png){ width="300" }
-- 
-- 
+
     Signs are similar to assets/deco blocks, they have their own creative tab.<br />
     They are supposed to support text-input in the future. *(TBD see #120)*
-
+    
     [:octicons-arrow-right-24: Sign documentation](#)
 
--   :material-traffic-cone:{ .lg .middle } __Asset/Deco__
+-   :material-door-sliding:{ .lg .middle } __Signalbox__
 
     ---
 
-    ![](deco.png){ width="300" }
-- 
-    Blocks that are not supposed to have any functionality can be added as a DECO block.<br />
-    They have their own creative tab.
+    ![](signalbox.png){ width="300" }
+-
 
-    [:octicons-arrow-right-24: Asset/Deco documentation](#)
+    Signalboxes are similar to assets/deco blocks.<br />
+    They can be connected to (complex) signals to control them.
+
+    [:octicons-arrow-right-24: Sign documentation](#)
 
 -   :material-electric-switch:{ .lg .middle } __Lever__
 
@@ -88,7 +99,8 @@ Your contentpacks is made up from multiple parts, you can find a short descripti
 
     ---
 
-    ![](flares.png){ width="300" }
+    ![](flares_day.png){ width="300" }
+    ![](flares_night.png){ width="300" }
 
     If your model contains lamps or other parts that are supposed to glow, this is the right place.<br />
     Flares are oriented to your models and light up when the right state is set.<br />
@@ -100,13 +112,13 @@ Your contentpacks is made up from multiple parts, you can find a short descripti
 
 <div class="grid cards" markdown>
 
--   :material-file:{ .lg .middle } __Contentsets__ *(optional)*
+-   :material-format-list-group:{ .lg .middle } __Contentsets__ *(optional)*
 
     ---
 
     This is its own file containing more blocks.<br />
     It does not contain any logic, the only advantage is that you can group different blocks in your contentpack that belong together.<br />
-    It can help with keeping an overview, depending on the amount of blocks your want to add.
+    It can help with keeping an overview, depending on the amount of blocks you want to add.
 
     [:octicons-arrow-right-24: Contentset documentation](#)
 

diff --git a/docs/complex_signal.png → docs/ContentPackV2/complex_signal.png b/docs/complex_signal.png → docs/ContentPackV2/complex_signal.png
diff --git a/docs/deco.png → docs/ContentPackV2/deco.png b/docs/deco.png → docs/ContentPackV2/deco.png
diff --git a/docs/ContentPackV2/flares_day.png b/docs/ContentPackV2/flares_day.png
diff --git a/docs/ContentPackV2/flares_night.png b/docs/ContentPackV2/flares_night.png
diff --git a/docs/lever.png → docs/ContentPackV2/lever.png b/docs/lever.png → docs/ContentPackV2/lever.png
diff --git a/docs/sign.png → docs/ContentPackV2/sign.png b/docs/sign.png → docs/ContentPackV2/sign.png
diff --git a/docs/signal.png → docs/ContentPackV2/signal.png b/docs/signal.png → docs/ContentPackV2/signal.png
diff --git a/docs/ContentPackV2/signalbox.png b/docs/ContentPackV2/signalbox.png
diff --git a/docs/ContentPackV2_ComplexSignal.md b/docs/ContentPackV2_ComplexSignal.md
diff --git a/docs/flares.png b/docs/flares.png
diff --git a/docs/index.md b/docs/index.md
@@ -8,8 +8,8 @@ Welcome to the official documentation for the LandOfSignals mod. This guide is d
 - [Getting Started with LandOfSignals](#getting-started-with-landofsignals)
 - [Using the Mod](#using-the-mod)
 - [Content Pack Systems](#content-pack-systems)
-  - [Creating Content Packs for V1](ContentPacksV1.md)
-  - [Creating Content Packs for V2](ContentPacksV2.md)
+  - [Creating Content Packs for V1](ContentPackV1/ContentPacksV1.md)
+  - [Creating Content Packs for V2](ContentPackV2/ContentPacksV2.md)
 - [Advanced Configuration](#advanced-configuration)
 - [Troubleshooting](#troubleshooting)
 - [Contributing](#contributing)
@@ -33,11 +33,11 @@ Explore how to create and use content packs with LandOfSignals, enhancing the cu
 
 ### Creating Content Packs for V1
 
-Step-by-step guide on creating content packs compatible with version 1 of the mod. [Learn more](ContentPacksV1.md).
+Step-by-step guide on creating content packs compatible with version 1 of the mod. [Learn more](ContentPackV1/ContentPacksV1.md).
 
 ### Creating Content Packs for V2
 
-Instructions on developing content packs for version 2 of LandOfSignals, including advanced features and tips. [Learn more](ContentPacksV2.md).
+Instructions on developing content packs for version 2 of LandOfSignals, including advanced features and tips. [Learn more](ContentPackV2/ContentPacksV2.md).
 
 ## Advanced Configuration
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,9 +2,18 @@ site_name: LandOfSignals Wiki
 theme:
   name: material
   features:
+    - navigation.sections
+    - navigation.path
+    - navigation.top
+    - navigation.expand
+    - navigation.footer
+    - toc.follow
     - content.tabs.link
+    - content.code.copy
+    - content.code.annotate
 plugins:
   - search
+  - awesome-pages
 markdown_extensions:
   - toc:
       permalink: true
@@ -20,4 +29,19 @@ markdown_extensions:
           case: lower
   - pymdownx.emoji:
       emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+extra:
+  annotate:
+    json: [.s2]
+  social:
+    - icon: fontawesome/brands/discord
+      link: https://discord.gg/ykAqHKYjVM
+    - icon: fontawesome/brands/github
+      link: https://github.com/LandOfRails/LandOfSignals
+