Merge pull request #167 from LandOfRails/develop

Develop -> Issue-133
LandOfRails · Oct 7, 2024 · cdf2d47 · cdf2d47
2 parents d72e49c + eb45531
commit cdf2d47
Show file tree

Hide file tree

Showing 49 changed files with 353 additions and 578 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -0,0 +1,29 @@
+name: mkdocs
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - develop
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name "MarkenJaden"
+          git config user.email "jjsch1410@gmail.com"
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+### Release 1.3.3
+
+* Fixed [#159] : Mod crashed with java version 12 or higher due to "javalangnosuchfieldexception modifiers"
+* Fixed [#159] : Blocks would glitch in 1.14 - 1.16 after the GUI was opened on the signal or the signalbox. This resulted in the block not reacting to changed states and staying rendered even after the destruction of the block.
+
 ### Release 1.3.2
 
 * Fixed [#151] : Rail switch always points left from either perspective

diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ Adds many different signals in different designs, so far without a consistent re
 <br> 
 
 * Huge thanks to [cam72cam](https://github.com/cam72cam) for
-  creating [UniversalModCore](https://github.com/TeamOpenIndustry/UniversalModCore), which makes the whole thing
+  creating [UniversalModCore](https://www.github.com/TeamOpenIndustry/UniversalModCore), which makes the whole thing
   possible here
 
 </details>

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.3.2
+1.3.3
diff --git a/docs/ContentPacksV1.md b/docs/ContentPacksV1.md
@@ -0,0 +1,64 @@
+# Creating and Updating Content Packs for LandOfSignals V1
+
+This guide provides instructions for creating and updating content packs for version 1 of the LandOfSignals mod, ensuring compatibility and integration with the mod's features and theme.
+
+## Content Pack Structure and Specifications
+
+A content pack for LandOfSignals V1 should include:
+
+- `pack.json`: Contains metadata about the content pack, including name, version, author, and description.
+- `assets`: A directory with models, textures, and other necessary assets.
+
+### pack.json Structure
+
+Example `pack.json` file:
+
+```json
+{
+  "name": "My Custom Content Pack",
+  "version": "1.0",
+  "author": "YourName",
+  "description": "A detailed description of your content pack."
+}
+```
+
+### Assets Organization
+
+Assets should be organized into subdirectories within the `assets` folder:
+
+- `assets/models`: For 3D models of signals and signs.
+- `assets/textures`: For textures applicable to the models.
+
+## Creating a Signal
+
+To create a custom signal:
+
+1. Model your signal using 3D modeling software capable of exporting to the OBJ format.
+2. Create and apply textures to your model.
+3. Organize your model and textures in the `assets` directory accordingly.
+4. Define your signal in a JSON file within `assets/models`.
+
+### Signal Definition Example
+
+Example JSON definition for a signal:
+
+```json
+{
+  "id": "custom_signal_v1",
+  "name": "Custom Signal V1",
+  "model": "models/custom_signal_v1.obj",
+  "textures": {
+    "texture": "textures/custom_signal_v1.png"
+  }
+}
+```
+
+## Best Practices for Content Pack Creation
+
+- Maintain organization within your content pack for ease of management.
+- Use descriptive names for models, textures, and assets.
+- Thoroughly test your content pack for compatibility and performance.
+
+## Sharing and Community Support
+
+After creating your content pack, you can share it with the LandOfSignals community. Include a README file with installation and usage instructions. Join our [Discord community](https://discord.gg/ykAqHKYjVM) for support, feedback, and to share your content packs with other users.
diff --git a/docs/ContentPacksV2.md b/docs/ContentPacksV2.md
@@ -0,0 +1,66 @@
+# Creating and Customizing Content Packs for LandOfSignals V2
+
+Creating and customizing content packs for LandOfSignals V2 allows mod users to add their own unique signals, signs, and other assets to the game, enhancing the immersive experience with the LandOfSignals theme. This guide will walk you through the process of creating a content pack for version 2 of the mod, ensuring consistency with the LandOfSignals theme.
+
+## Content Pack Structure
+
+A content pack for LandOfSignals V2 consists of a directory containing the following:
+
+- `pack.json`: A JSON file containing metadata about the content pack.
+- `assets`: A directory containing the models, textures, and other assets for your content pack.
+
+### pack.json
+
+The `pack.json` file contains metadata about your content pack. Here is an example structure:
+
+```json
+{
+  "name": "My Custom Content Pack",
+  "version": "2.0",
+  "author": "YourName",
+  "description": "A description of your content pack, aligned with the LandOfSignals theme."
+}
+```
+
+### Assets Directory
+
+The `assets` directory should contain all the models, textures, and other assets for your content pack. Organize your assets into subdirectories for better management. For example:
+
+- `assets/models`: Contains the 3D models for your signals and signs.
+- `assets/textures`: Contains the textures for your models.
+
+## Creating a Signal
+
+To create a signal, you need to:
+
+1. Model your signal using a 3D modeling software that can export to the OBJ format.
+2. Create textures for your model.
+3. Place your model and textures in the appropriate directories within the `assets` directory.
+4. Define your signal in a JSON file within the `assets/models` directory.
+
+### Signal Definition
+
+A signal is defined using a JSON file. Here is an example definition:
+
+```json
+{
+  "id": "custom_signal_v2",
+  "name": "Custom Signal V2",
+  "model": "models/custom_signal_v2.obj",
+  "textures": {
+    "texture": "textures/custom_signal_v2.png"
+  }
+}
+```
+
+## Best Practices
+
+- Keep your content pack organized to make it easier to manage.
+- Use descriptive names for your models, textures, and other assets.
+- Test your content pack thoroughly before releasing it.
+
+## Sharing Your Content Pack
+
+Once you have created your content pack, you can share it with the community. Make sure to include a README file with instructions on how to install and use your content pack, ensuring it aligns with the LandOfSignals theme.
+
+Join our [Discord community](https://discord.gg/ykAqHKYjVM) to share your content packs and get feedback from other users.
diff --git a/docs/HowToUse.md b/docs/HowToUse.md
@@ -0,0 +1,43 @@
+# How to Use LandOfSignals
+
+Welcome to the LandOfSignals mod! This guide will walk you through the installation, configuration, and usage of the mod, as well as how to create and use content packs.
+
+## Installation
+
+1. Ensure you have Minecraft Forge installed.
+2. Download the LandOfSignals mod from the official [CurseForge page](https://www.curseforge.com/minecraft/mc-mods/landofsignals).
+3. Place the downloaded `.jar` file into your `Minecraft/mods` folder.
+4. Launch Minecraft and select the Forge profile.
+
+## Configuration
+
+LandOfSignals comes with various configuration options to tailor the mod to your liking. These can be found in the `config/landofsignals.toml` file. Here you can enable or disable specific features and adjust mod settings.
+
+## Using the Mod
+
+To use the mod, you'll need to familiarize yourself with the different types of signals and tools provided:
+
+- **Signal Selector**: Used to select the type of signal you want to place.
+- **Connector Tool**: Connects signals to signal boxes for control.
+- **Signal Box**: Controls the state of connected signals.
+
+### Placing Signals
+
+1. Select a signal using the Signal Selector.
+2. Right-click on the ground or a suitable surface to place the signal.
+3. Use the Connector Tool to link the signal to a Signal Box.
+4. Right-click the Signal Box and configure the signal state as desired.
+
+## Creating Content Packs
+
+Content packs allow you to add new signals and assets to the game. To create a content pack:
+
+1. Create a new directory in `Minecraft/config/landofsignals/contentpacks`.
+2. Inside this directory, create a `pack.json` file with your pack's metadata.
+3. Add your assets and define them in the `pack.json` file. Refer to the [Content Pack Documentation](https://github.com/LandOfRails/LandOfSignals/wiki/Content-Packs) for detailed instructions.
+
+## Community and Support
+
+Join our [Discord community](https://discord.gg/ykAqHKYjVM) for support, to share your content packs, or to connect with other users. Our community is always ready to help with any questions or issues you might encounter.
+
+Thank you for using LandOfSignals!
diff --git a/docs/assets/1.0.0/block_old_shifted_signals_after_update.png b/docs/assets/1.0.0/block_old_shifted_signals_after_update.png
diff --git a/docs/assets/1.0.0/block_old_signals_after_update.png b/docs/assets/1.0.0/block_old_signals_after_update.png
diff --git a/docs/assets/1.0.0/block_old_single_state_signals_after_update.png b/docs/assets/1.0.0/block_old_single_state_signals_after_update.png
diff --git a/docs/assets/1.0.0/block_old_ticket_machines_and_so12.png b/docs/assets/1.0.0/block_old_ticket_machines_and_so12.png
diff --git a/docs/assets/1.0.0/block_old_ticket_machines_and_so12_after_click.png b/docs/assets/1.0.0/block_old_ticket_machines_and_so12_after_click.png
diff --git a/docs/assets/1.0.0/block_signs.png b/docs/assets/1.0.0/block_signs.png
diff --git a/docs/assets/1.0.0/block_ticket_machine_hitbox.png b/docs/assets/1.0.0/block_ticket_machine_hitbox.png
diff --git a/docs/assets/1.0.0/blocks_deprecated_stellwand.png b/docs/assets/1.0.0/blocks_deprecated_stellwand.png
diff --git a/docs/assets/1.0.0/creative_inventory_assets.png b/docs/assets/1.0.0/creative_inventory_assets.png
diff --git a/docs/assets/1.0.0/creative_inventory_deprecated_stellwand.png b/docs/assets/1.0.0/creative_inventory_deprecated_stellwand.png
diff --git a/docs/assets/1.0.0/creative_inventory_signals.png b/docs/assets/1.0.0/creative_inventory_signals.png
diff --git a/docs/assets/1.0.0/creative_inventory_signs.png b/docs/assets/1.0.0/creative_inventory_signs.png
diff --git a/docs/assets/1.0.0/forge_gui_entering_world_after_update.png b/docs/assets/1.0.0/forge_gui_entering_world_after_update.png
diff --git a/docs/assets/1.0.0/item_name_and_tooltip.png b/docs/assets/1.0.0/item_name_and_tooltip.png
diff --git a/docs/assets/1.0.0/item_old_signal_after_update.png b/docs/assets/1.0.0/item_old_signal_after_update.png
diff --git a/docs/assets/1.0.0/item_old_signalbox_after_update.png b/docs/assets/1.0.0/item_old_signalbox_after_update.png
diff --git a/docs/assets/1.0.0/message_deprecated_stellwand.png b/docs/assets/1.0.0/message_deprecated_stellwand.png
diff --git a/docs/assets/1.0.0/signal_prioritization.png b/docs/assets/1.0.0/signal_prioritization.png
diff --git a/docs/assets/1.0.0/signal_prioritization_large_index.png b/docs/assets/1.0.0/signal_prioritization_large_index.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,56 @@
+# Welcome to the LandOfSignals Documentation
+
+Welcome to the official documentation for the LandOfSignals mod. This guide is designed to help you understand how to install, configure, and effectively use the mod and its content pack systems in your Minecraft world.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [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)
+- [Advanced Configuration](#advanced-configuration)
+- [Troubleshooting](#troubleshooting)
+- [Contributing](#contributing)
+- [Support and Community](#support-and-community)
+
+## Installation
+
+Learn how to install LandOfSignals and its dependencies to get started with enhancing your Minecraft railway systems.
+
+## Getting Started with LandOfSignals
+
+Discover the basics of using LandOfSignals, including an overview of its features and how to navigate the mod's interface.
+
+## Using the Mod
+
+Detailed instructions on how to use the various signals, items, and functionalities added by LandOfSignals.
+
+## Content Pack Systems
+
+Explore how to create and use content packs with LandOfSignals, enhancing the customization and variety of your railway systems.
+
+### Creating Content Packs for V1
+
+Step-by-step guide on creating content packs compatible with version 1 of the mod. [Learn more](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).
+
+## Advanced Configuration
+
+Customize your experience with LandOfSignals by adjusting mod settings and exploring advanced features.
+
+## Troubleshooting
+
+Solutions to common issues encountered while using LandOfSignals. For further assistance, visit our [GitHub repository](https://github.com/LandOfRails/LandOfSignals) or join our [Discord community](https://discord.gg/ykAqHKYjVM).
+
+## Contributing
+
+Interested in contributing to the LandOfSignals project? Find out how you can help improve the mod and its documentation.
+
+## Support and Community
+
+Join our Discord community for support, to share content packs, and to connect with other LandOfSignals users.