From de5d54fc7acd2a3235363dd6a538ac0fdbcfb559 Mon Sep 17 00:00:00 2001 From: lukflug <47392064+lukflug@users.noreply.github.com> Date: Tue, 2 Feb 2021 20:16:08 +0100 Subject: [PATCH] Version 0.1.10 --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ae88f55..8ffc47d 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,9 @@ A simple yet flexible library to create ClickGUIs designed for use in Minecraft This repository only includes the GameSense themes, however, since Cyber didn't want me to publish the other themes. The library has no depedencies (aside from Java 8), so it can be easily used for other purposes, aside from Minecraft utility mods. Thanks to Go_Hoosiers, for suggesting the name of this library. If you use this library, some attribution would be greatly appreciated. Consider visiting the PanelStudio discord server: https://discord.gg/E3DrF4XvUE. -In addition to the core PanelStudio library, there are the PanelStudio-MC libraries. The PanelStudio-MC12 library is designed for Minecraft Forge 1.12.2 (it may or may not work for other versions and mods that use MCP only). The PanelStudio-MC16 library is designed for Fabric 1.16.5 and also works on 1.16.4 (works on anything using Fabric's Yarn mappings, it probably works on older versions, this has however not been tested). The PanelStudio core library works on any Minecraft version (and even on any non-Minecraft application). +In addition to the core PanelStudio library, there are the PanelStudio-MC libraries. The PanelStudio-MC12 library is designed for Minecraft Forge 1.12.2 (it may or may not work for other versions and mods that use MCP only). The PanelStudio-MC16 library is designed for Fabric 1.16.5 and also works on 1.16.4 (works on anything using Fabric's Yarn mappings, it probably works on older versions, this has however not been tested). The PanelStudio-MC8-Fabric library is designed for Legacy Fabric 1.8.9 (as with MC16, it only requires Yarn) and the PanelStudio-MC8-Forge library is designed for Minecraft Forge 1.8.9 (as with MC12, it may also work on MCP-only projects). The PanelStudio core library works on any Minecraft version (and even on any non-Minecraft application). + +**Thanks to NirvanaNevermind for porting PanelStudio-MC to Fabric 1.8.9!** ## Features * Ability to easily create new themes/skins. @@ -75,6 +77,30 @@ shadowJar { } } ``` +If you're planning to use PanelStudio-MC8-Fabric you have to also add this: +```groovy +dependencies { + modCompile('com.lukflug:panelstudio-mc8-fabric:0.1.10') +} + +shadowJar { + dependencies { + include(dependency('com.lukflug:panelstudio-mc8-fabric')) + } +} +``` +If you're planning to use PanelStudio-MC8-Forge you have to also add this: +```groovy +dependencies { + compile('com.lukflug:panelstudio-mc8-forge:0.1.10') +} + +shadowJar { + dependencies { + include(dependency('com.lukflug:panelstudio-mc8-forge')) + } +} +``` ### ClickGUI The precise way PanelStudio is used in an utility mod depends on the module and setting manager. However the implementation should roughly follow follwing scheme. The main ClickGUI class should extend `MinecraftGUI` (if using PanelStudio-MC): @@ -178,7 +204,7 @@ Toggleable hudToggle=new Toggleable() { ``` ## Reference -For a list of classes and methods, consult the [javadoc](https://lukflug.github.io/javadoc/panelstudio/0.1.9/overview-summary.html). For an example implementation, consult the GameSense source code. +For a list of classes and methods, consult the [javadoc](https://lukflug.github.io/javadoc/panelstudio/0.1.10/overview-summary.html). For an example implementation, consult the GameSense source code. ## Creating custom themes The components provided by PanelStudio use the methods in the `Renderer` interface to render. A `Theme` consist of three renderers: one for the single components (settings), one for the containers (modules) and one for the panels (categories). To see how themes are implemented, consult the package `com.lukflug.panelstudio.theme`.