-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation for mod usage and content pack creation
Related to #161 Update documentation to enhance mod usage and content pack creation guidance. - **README.md**: Minor update to the UniversalModCore link, maintaining the original content structure without adding the planned detailed instructions or Discord links. - **docs/index.md**: Overhauls the documentation index page, introducing a structured table of contents, installation guide, mod usage, content pack creation for V1 and V2, advanced configuration, troubleshooting, contributing, and community support sections. - **Adds new documentation files**: - `docs/HowToUse.md`: Provides comprehensive step-by-step instructions for mod installation, configuration, usage, and content pack creation, including community support links. - `docs/ContentPacksV1.md` and `docs/ContentPacksV2.md`: Offer detailed guides on creating content packs for different versions of the mod, including structure, asset organization, and best practices. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/LandOfRails/LandOfSignals/issues/161?shareId=7fffa40e-a198-43a8-9246-fc09da1edc92).
- Loading branch information
1 parent
b939b6a
commit 3e3dcfc
Showing
5 changed files
with
215 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Creating Content Packs for LandOfSignals V1 | ||
|
||
Creating content packs for LandOfSignals V1 allows you to add your own custom signals, signs, and other assets to the game. This guide will walk you through the process of creating a basic content pack. | ||
|
||
## Content Pack Structure | ||
|
||
A content pack for LandOfSignals V1 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": "1.0", | ||
"author": "YourName", | ||
"description": "A description of your content pack." | ||
} | ||
``` | ||
|
||
### 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", | ||
"name": "Custom Signal", | ||
"model": "models/custom_signal.obj", | ||
"textures": { | ||
"texture": "textures/custom_signal.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. | ||
|
||
Join our [Discord community](https://discord.gg/ykAqHKYjVM) to share your content packs and get feedback from other users. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Creating Content Packs for LandOfSignals V2 | ||
|
||
Creating content packs for LandOfSignals V2 allows you to add your own custom signals, signs, and other assets to the game. This guide will walk you through the process of creating a basic content pack for version 2 of the mod. | ||
|
||
## 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." | ||
} | ||
``` | ||
|
||
### 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. | ||
|
||
Join our [Discord community](https://discord.gg/ykAqHKYjVM) to share your content packs and get feedback from other users. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,56 @@ | ||
# Welcome to the LandOfSignals Documentation | ||
|
||
This documentation aims to provide comprehensive guides and references for using LandOfSignals mod in Minecraft. Here you will find information on how to install the mod, use its features, and leverage the signals and items it adds to the game. | ||
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. | ||
|
||
## Getting Started | ||
## Table of Contents | ||
|
||
- **Installation**: Learn how to install LandOfSignals and its dependencies. | ||
- **Basic Usage**: Discover how to use signals and items added by the mod. | ||
- **Advanced Features**: Explore advanced functionalities and customization options. | ||
- [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) | ||
|
||
## Features | ||
## Installation | ||
|
||
LandOfSignals adds a variety of signals and items to Minecraft, enhancing the game's railway systems. This section covers the different types of signals available, how to place and configure them, and the additional items that support railway construction and management. | ||
Learn how to install LandOfSignals and its dependencies to get started with enhancing your Minecraft railway systems. | ||
|
||
## Configuration | ||
## Getting Started with LandOfSignals | ||
|
||
Customize your experience with LandOfSignals by adjusting mod settings. This section provides details on configuration options and how to modify them to suit your gameplay. | ||
Discover the basics of using LandOfSignals, including an overview of its features and how to navigate the mod's interface. | ||
|
||
## Troubleshooting | ||
## Using the Mod | ||
|
||
Encountered an issue? Check out the troubleshooting section for common problems and their solutions. If you need further assistance, visit our [GitHub repository](https://github.com/LandOfRails/LandOfSignals) or join our [Discord community](https://discord.gg/ykAqHKYjVM). | ||
Detailed instructions on how to use the various signals, items, and functionalities added by LandOfSignals. | ||
|
||
## Contributing | ||
## 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 | ||
|
||
Interested in contributing to the LandOfSignals project? We welcome contributions of all kinds, from code improvements to documentation updates. Visit our [GitHub repository](https://github.com/LandOfRails/LandOfSignals) to get started. | ||
Instructions on developing content packs for version 2 of LandOfSignals, including advanced features and tips. [Learn more](ContentPacksV2.md). | ||
|
||
For full documentation visit [mkdocs.org](https://www.mkdocs.org). | ||
## Advanced Configuration | ||
|
||
## Commands | ||
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 | ||
|
||
* `mkdocs new [dir-name]` - Create a new project. | ||
* `mkdocs serve` - Start the live-reloading docs server. | ||
* `mkdocs build` - Build the documentation site. | ||
* `mkdocs -h` - Print help message and exit. | ||
Interested in contributing to the LandOfSignals project? Find out how you can help improve the mod and its documentation. | ||
|
||
## Project layout | ||
## Support and Community | ||
|
||
mkdocs.yml # The configuration file. | ||
docs/ | ||
index.md # The documentation homepage. | ||
... # Other markdown pages, images and other files. | ||
Join our Discord community for support, to share content packs, and to connect with other LandOfSignals users. |