Skip to content

Commit

Permalink
Added: A secondary 'About' page for Manager Backend
Browse files Browse the repository at this point in the history
  • Loading branch information
Sewer56 committed Apr 13, 2024
1 parent 9a25d97 commit 33e13f7
Show file tree
Hide file tree
Showing 7 changed files with 59 additions and 6 deletions.
9 changes: 8 additions & 1 deletion docs/Loader/About.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

!!! info "These sections cover all information related to the design of the mod loader."

Specifically, these sections focus on everything related to the actual 'mod loader' lives inside of
Specifically, these sections focus on everything related to the actual 'mod loader' lives inside of
the game process and powers your mods.

From getting it running, to how mods are booted up.
Expand All @@ -26,11 +26,18 @@ Other sections:
| [Loader Deployment][loader-deployment] | How the actual loader DLL is deployed to game folder. |
| [Breaking Changes][breaking-changes] | Things Reloaded3 fundamentally does different to Reloaded-II. |

Important Reads:

| Section | Description |
| ------------------------------ | -------------------------------------------------------------------------------- |
| [Load Ordering][load-ordering] | Rules used for deprecation & automatic reordering of mods based on dependencies. |

<!-- Links -->
[backends]: ./Backends/About.md
[breaking-changes]: ./Breaking-Changes.md
[copy-protection]: ./Copy-Protection/About.md
[core-architecture]: ./Core-Architecture.md
[loader-api]: ./Loader-API/About.md
[load-ordering]: ../Server/Load-Ordering.md
[loader-deployment]: ./Deployment.md
[platform-support]: ./Platforms/About.md
2 changes: 1 addition & 1 deletion docs/Loader/Backends/Native.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ For the following reasons:
[core-detect]: https://docs.rs/core_detect/latest/core_detect/
[microarchitecture-levels]: https://en.wikipedia.org/wiki/X86-64#Microarchitecture_levels
[mod-metadata-targets]: ../../Server/Configurations/Mod-Metadata.md#targets
[mod-publishing]: ../../Server/Mod-Publishing.md
[mod-publishing]: ../../Server/Packaging/Publishing-Packages.md
23 changes: 23 additions & 0 deletions docs/Server/About.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Server (Manager Backend)

!!! info "This section covers all information related to the design and architecture of the backend server powering the mod manager."

The server is responsible for various tasks such as mod packaging, configuration management,
diagnostics, load ordering, and more. This also covers the 'data model' of Reloaded-III.

Basically all the actual work of a 'mod manager', but as a server.

## Sections

| Section | Description |
| -------------------------------- | -------------------------------------------------------------------------------------------- |
| [Packaging][packaging] | Covers how mods are packaged and distributed, including the package structure and design. |
| [Configurations][configurations] | Stores schemas and explanations of various configuration files used. |
| [Diagnostics][diagnostics] | Explains the diagnostic system that informs the frontend about issues with the user's setup. |
| [Load Ordering][load-ordering] | Rules used for deprecation & automatic reordering of mods based on dependencies. |

<!-- Links -->
[packaging]: ./Packaging/About.md
[configurations]: ./Configurations/About.md
[diagnostics]: ./Diagnostics.md
[load-ordering]: ./Load-Ordering.md
21 changes: 21 additions & 0 deletions docs/Server/Configurations/About.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Configurations

!!! info "This section covers the various configuration files used by the server to manage mods and applications."

Configuration files play a crucial role in storing metadata, settings, and other important
information related to mods and applications.

They ensure proper functionality, compatibility, and customization options for users.

## Pages

| Page | Description |
| ---------------------------------------- | -------------------------------------------------------- |
| [App Metadata][app-metadata] | Metadata stored for games. |
| [Mod Configurations][mod-configurations] | Schema for Reloaded3 mod configurations. |
| [Mod Metadata][mod-metadata] | Schema for each Reloaded3 mod. Extending package format. |

<!-- Links -->
[app-metadata]: ./App-Metadata.md
[mod-configurations]: ./Mod-Configurations.md
[mod-metadata]: ./Mod-Metadata.md
4 changes: 2 additions & 2 deletions docs/Server/Configurations/Mod-Metadata.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Mod Metadata

!!! warning "Work in Progress"
!!! info "The format of ([package.toml][package-toml]) used to describe every mod package."

Mod Metadata extends from standard package metadata ([package.toml][package-toml]).
Mod Metadata extends from standard ([package.toml][package-toml]).

| Type | Name | Description |
| -------------------------------- | ---------------------------------- | ------------------------------------------------------------- |
Expand Down
File renamed without changes.
6 changes: 4 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ nav:
- Windows - SafeDisc: Loader/Copy-Protection/Windows-SafeDisc.md
- Windows - Steam: Loader/Copy-Protection/Windows-Steam.md
- Core Architecture: Loader/Core-Architecture.md
- Loader API:
- Loader API:
- About: Loader/Loader-API/About.md
- Platform Support:
- About: Loader/Platforms/About.md
Expand All @@ -79,16 +79,18 @@ nav:
- Other: Loader/Platforms/Other.md
- Windows: Loader/Platforms/Windows.md
- Server (Manager Backend):
- About (Overview): Server/About.md
- Configurations:
- About: Server/Configurations/About.md
- App Metadata: Server/Configurations/App-Metadata.md
- Mod Configuration: Server/Configurations/Mod-Configurations.md
- Mod Metadata: Server/Configurations/Mod-Metadata.md
- Diagnostics: Server/Diagnostics.md
- Load Ordering: Server/Load-Ordering.md
- Mod Publishing: Server/Mod-Publishing.md
- Packaging:
- About: Server/Packaging/About.md
- Package Metadata: Server/Packaging/Package-Metadata.md
- Publishing Packages: Server/Packaging/Publishing-Packages.md
- Launcher (Manager Frontend):
- Best Practices: Launcher/Best-Practices.md
- Mods:
Expand Down

0 comments on commit 33e13f7

Please sign in to comment.