From de233d8a60627b43a2247478796e0de190a2110d Mon Sep 17 00:00:00 2001 From: MrBunnyDc Date: Wed, 25 Sep 2024 08:36:36 -0400 Subject: [PATCH] Add LICENSE and README Markdown files --- LICENSE.MD | 7 +++++++ README.MD | 26 ++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 LICENSE.MD create mode 100644 README.MD diff --git a/LICENSE.MD b/LICENSE.MD new file mode 100644 index 0000000..d6bf06b --- /dev/null +++ b/LICENSE.MD @@ -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. \ No newline at end of file diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..967ab27 --- /dev/null +++ b/README.MD @@ -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. +