Skip to content

Commit

Permalink
Update MkDocs settings and design for LandOfSignals
Browse files Browse the repository at this point in the history
Related to #162

Updates MkDocs configuration and content pack documentation for LandOfSignals

- **Enhances `mkdocs.yml`**: Adds theme customization including palette colors, fonts, logo, favicon, and social links, and enables plugins for search and HTML minification.
- **Revises `docs/ContentPacksV1.md` and `docs/ContentPacksV2.md`**: Updates the guides for creating content packs for versions 1 and 2, ensuring instructions and examples are consistent with the LandOfSignals theme and introducing best practices for content pack creation.


---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/LandOfRails/LandOfSignals/issues/162?shareId=c8ca5d67-3c79-4cc5-ab23-419baacd0718).
  • Loading branch information
MarkenJaden committed Jun 25, 2024
1 parent 3e3dcfc commit d7c2aab
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 36 deletions.
62 changes: 30 additions & 32 deletions docs/ContentPacksV1.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,64 @@
# Creating Content Packs for LandOfSignals V1
# Creating and Updating 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.
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
## Content Pack Structure and Specifications

A content pack for LandOfSignals V1 consists of a directory containing the following:
A content pack for LandOfSignals V1 should include:

- `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`: Contains metadata about the content pack, including name, version, author, and description.
- `assets`: A directory with models, textures, and other necessary assets.

### pack.json
### pack.json Structure

The `pack.json` file contains metadata about your content pack. Here is an example structure:
Example `pack.json` file:

```json
{
"name": "My Custom Content Pack",
"version": "1.0",
"author": "YourName",
"description": "A description of your content pack."
"description": "A detailed description of your content pack."
}
```

### Assets Directory
### Assets Organization

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 should be organized into subdirectories within the `assets` folder:

- `assets/models`: Contains the 3D models for your signals and signs.
- `assets/textures`: Contains the textures for your models.
- `assets/models`: For 3D models of signals and signs.
- `assets/textures`: For textures applicable to the models.

## Creating a Signal

To create a signal, you need to:
To create a custom signal:

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.
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
### Signal Definition Example

A signal is defined using a JSON file. Here is an example definition:
Example JSON definition for a signal:

```json
{
"id": "custom_signal",
"name": "Custom Signal",
"model": "models/custom_signal.obj",
"id": "custom_signal_v1",
"name": "Custom Signal V1",
"model": "models/custom_signal_v1.obj",
"textures": {
"texture": "textures/custom_signal.png"
"texture": "textures/custom_signal_v1.png"
}
}
```

## Best Practices
## Best Practices for Content Pack Creation

- 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.
- 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 Your Content Pack
## Sharing and Community Support

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.
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.
8 changes: 4 additions & 4 deletions docs/ContentPacksV2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Creating Content Packs for LandOfSignals V2
# Creating and Customizing 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.
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

Expand All @@ -18,7 +18,7 @@ The `pack.json` file contains metadata about your content pack. Here is an examp
"name": "My Custom Content Pack",
"version": "2.0",
"author": "YourName",
"description": "A description of your content pack."
"description": "A description of your content pack, aligned with the LandOfSignals theme."
}
```

Expand Down Expand Up @@ -61,6 +61,6 @@ A signal is defined using a JSON file. Here is an example definition:

## 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.
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.
18 changes: 18 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
site_name: LandOfSignals Wiki
theme:
name: material
palette:
primary: 'blue'
accent: 'light blue'
font:
text: 'Roboto'
code: 'Roboto Mono'
logo: 'images/logo.png'
favicon: 'images/favicon.ico'
extra:
social:
- type: 'github'
link: 'https://github.com/LandOfRails/LandOfSignals'
- type: 'discord'
link: 'https://discord.gg/ykAqHKYjVM'
plugins:
- search
- minify:
minify_html: true

0 comments on commit d7c2aab

Please sign in to comment.