Add license, small readme and test mod changes

LICENSE.txt

@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -1,35 +1,34 @@
-# Regilite (Registrate at home)
-A light library helping with registration and data generation
+# Regilite
+A lightweight library helping with registration and data generation.
 
-## Content
-This library provides helper functions and wrappers around for various Objects. Below we provide a list of all
-functions provided.
+## Usage
+This library provides helper functions and wrappers around for various Holders and registries. To be able to use 
+Regilite, you firstly create and register a `Regilite`-object. This object will do the actual registring data to events 
+and doing DataGen.
 
-### Translations
-We provide automatic translations for objects where the `ResourceLocation` gives enough context. This can always 
-be changed using the `setTranslation` method.
+Below you can find a list of Holder objects Regilite supports. You can see not every Holder has a Regilite alternative, 
+and this is intentional. We've only provided our wrappers when the Holder could benefit from it in our eyes.
 
-Besides the translation of objects like blocks and items, we also provide helpers for adding automatic translations for `Components`.
-
-### com.testmod.Blocks
+### RegiliteBlock
 Besides the block itself, there are also functions to automatically register the following:
 - Loot tables
 - Blockstates and model
 - Block color (tint)
 - Block Tags
 - Translation
 - Block item 
- - See `com.testmod.Items`
+ - See `Items`
 
-### com.testmod.Items
+### RegiliteItem
 Besides the item itself, there are also functions to automatically register the following:
 - Item model
 - Item color (tint)
 - Item Tags
 - Creative tabs
 - Translation
+- Capabilities
 
-### Fluid(type)s
+### RegiliteFluid
 Besides the fluid(type) itself, there are also functions to automatically register the following:
 - Flowing fluid
 - Source fluid
@@ -40,29 +39,32 @@ Besides the fluid(type) itself, there are also functions to automatically regist
 - Bucket Item
  - See `Item`
 
-### Block Entity(type)s
+### RegiliteBlockEntity
 Besides the block entity(type) itself, it automatically registers the following:
 
-- Block entity renderer (should we?)
+- Block entity renderer
 - Block entity tags
+- Capabilities
 
-This helper meanly helps by removing a lot of (constant) generic bounds from the code, and provides a shortcut to
-create a block entity directly from the holder.
-
-### Entity(type)s
+### RegiliteEntity
 Besides the entity(type) itself, it automatically registers the following:
 
-- Entity model (should we?)
-- Model layer (should we?)
+- Entity model
 - Entity tags
 - Translation
+- Capabilities (TODO)
+- Model layer (TODO)
 
-This helper also removes a lot of (constant) generic bounds from the code.
 
-### Menu(type)s
+### RegiliteMenu
 Besides the menu(type) itself, it automatically registers the following:
 
-- Screen factory (should we?)
-- Translation (should we, as we don't use it?)
+- Screen factory
+- Translation (TODO)
+
+### Translations
+We provide automatic translations for holders where the `ResourceLocation` gives enough context. This can always
+be changed using the `setTranslation` method.
 
-This helper also removes a lot of (constant) generic bounds from the code.
+For other translations, the `Regilite`-object provides methods for registering a translation. In case a translation is 
+added multiple times, only the last one will be used.

src/test/java/com/enderio/regilite/examplemod/BlockEntities.java

@@ -6,7 +6,7 @@
 import net.neoforged.bus.api.IEventBus;
 
 public class BlockEntities {
- public static final BlockEntityRegistry BLOCK_ENTITIES = BlockEntityRegistry.create(ExampleMod.getRegilite());
+ public static final BlockEntityRegistry BLOCK_ENTITIES = ExampleMod.getRegilite().blockEntityRegistry();
 
  public static RegiliteBlockEntity<ExampleBlockentity> EXAMPLE_BLOCKENTITY = BLOCK_ENTITIES.registerBlockEntity("example", ExampleBlockentity::new, Blocks.EXAMPLE_BLOCK);
 

src/test/java/com/enderio/regilite/examplemod/Blocks.java

@@ -14,8 +14,8 @@
 import net.neoforged.bus.api.IEventBus;
 
 public class Blocks {
- public static final BlockRegistry BLOCKS = BlockRegistry.create(ExampleMod.getRegilite());
- public static final ItemRegistry ITEMS = ItemRegistry.create(ExampleMod.getRegilite());
+ public static final BlockRegistry BLOCKS =  ExampleMod.getRegilite().blockRegistry();
+ public static final ItemRegistry ITEMS =  ExampleMod.getRegilite().itemRegistry();
 
  public static final RegiliteBlock<ExampleBlock> EXAMPLE_BLOCK = BLOCKS
  .registerBlock("example_block", ExampleBlock::new, BlockBehaviour.Properties.of().mapColor(MapColor.STONE))

src/test/java/com/enderio/regilite/examplemod/Fluids.java

@@ -17,10 +17,10 @@
 import net.neoforged.neoforge.registries.DeferredRegister;
 
 public class Fluids {
- private static final FluidRegistry FLUIDTYPES = FluidRegistry.create(ExampleMod.getRegilite());
+ private static final FluidRegistry FLUIDTYPES =  ExampleMod.getRegilite().fluidRegistry();
  private static final DeferredRegister<Fluid> FLUIDS = DeferredRegister.create(BuiltInRegistries.FLUID.key(), ExampleMod.MODID);
- public static final BlockRegistry BLOCKS = BlockRegistry.create(ExampleMod.getRegilite());
- public static final ItemRegistry ITEMS = ItemRegistry.create(ExampleMod.getRegilite());
+ public static final BlockRegistry BLOCKS = ExampleMod.getRegilite().blockRegistry();
+ public static final ItemRegistry ITEMS = ExampleMod.getRegilite().itemRegistry();
 
  public static final RegiliteFluid<FluidType> EXAMPLE_FLUID = FLUIDTYPES.registerFluid("example_fluid", FluidType.Properties.create())
  .createFluid(FLUIDS)

src/test/java/com/enderio/regilite/examplemod/Items.java

@@ -9,7 +9,7 @@
 import net.neoforged.bus.api.IEventBus;
 
 public class Items {
- public static final ItemRegistry ITEMS = ItemRegistry.create(ExampleMod.getRegilite());
+ public static final ItemRegistry ITEMS = ExampleMod.getRegilite().itemRegistry();
 
  public static final RegiliteItem<Item> EXAMPLE_ITEM = ITEMS.registerItem("example_item", new Item.Properties().food(new FoodProperties.Builder()
  .alwaysEdible().nutrition(1).saturationModifier(2f).build()))

src/test/java/com/enderio/regilite/examplemod/Menus.java

@@ -8,7 +8,7 @@
 
 public class Menus {
 
- private static final MenuRegistry MENUS = MenuRegistry.create(ExampleMod.getRegilite());
+ private static final MenuRegistry MENUS = ExampleMod.getRegilite().menuRegistry();
 
  public static final RegiliteMenu<ExampleMenu> EXAMPLE_MENU = MENUS.registerMenu("example", ExampleMenu::new, () -> ExampleScreen::new);