You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-2Lines changed: 28 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,9 @@ A simple yet flexible library to create ClickGUIs designed for use in Minecraft
20
20
21
21
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.
22
22
23
-
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).
23
+
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).
24
+
25
+
**Thanks to NirvanaNevermind for porting PanelStudio-MC to Fabric 1.8.9!**
24
26
25
27
## Features
26
28
* Ability to easily create new themes/skins.
@@ -75,6 +77,30 @@ shadowJar {
75
77
}
76
78
}
77
79
```
80
+
If you're planning to use PanelStudio-MC8-Fabric you have to also add this:
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):
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.
207
+
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.
182
208
183
209
## Creating custom themes
184
210
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`.
0 commit comments