-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add LICENSE and README Markdown files
- Loading branch information
MrBunnyDc
committed
Sep 25, 2024
1 parent
bdeafc3
commit de233d8
Showing
2 changed files
with
33 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Copyright 2024 LeoMB (WonejoMB) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
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,26 @@ | ||
![Header](./devsources/header.png) | ||
[![Curseforge](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/curseforge_vector.svg)](https://www.curseforge.com/minecraft/mc-mods/guidebookapi) [![Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/mod/guidebookapi) [![Discord](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg)](https://discord.gg/vpkYUrB2RB) | ||
|
||
WuidebookAPI, before called under the name "GuidebookAPI" ( Yes, only changed one letter- (😭) ) it's a mod API that allows the in-game creation of guides for minecraft mods. | ||
The mod previously was just an update of the mod [GuideAPI](https://modrinth.com/mod/guide-api-legacy) developed by TehNut and Tombenpotter. | ||
|
||
_Little note:_ The mod has **not** retro-compatibility with older versions of guides. | ||
|
||
This mod is under the [MIT License]() | ||
|
||
## Most relevant features | ||
|
||
- A proper configuration system that allows the addition of custom configuration definitions and serializers by developers | ||
|
||
|
||
- The creation of guides in-game | ||
|
||
|
||
- Allows the registration custom page-content for the guides development | ||
|
||
## Differences with older versions | ||
|
||
A difference of WuidebookAPI with GuidebookAPI its not only the in-game creation of guides! The development of older guides of the mod its mostly in java-code, this mod register the Book Information of these in java and then this reads other files for the creation of content! | ||
|
||
The old configuration systerm wasn't to different from the new, the principal difference it's the way the de/serializers does the de/serialization. The principal difference it's that developers can register custom serializers for their own custom configurations. | ||
|