Skip to content

Commit de5d54f

Browse files
authored
Version 0.1.10
1 parent 0b5bf88 commit de5d54f

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ A simple yet flexible library to create ClickGUIs designed for use in Minecraft
2020

2121
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.
2222

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!**
2426

2527
## Features
2628
* Ability to easily create new themes/skins.
@@ -75,6 +77,30 @@ shadowJar {
7577
}
7678
}
7779
```
80+
If you're planning to use PanelStudio-MC8-Fabric you have to also add this:
81+
```groovy
82+
dependencies {
83+
modCompile('com.lukflug:panelstudio-mc8-fabric:0.1.10')
84+
}
85+
86+
shadowJar {
87+
dependencies {
88+
include(dependency('com.lukflug:panelstudio-mc8-fabric'))
89+
}
90+
}
91+
```
92+
If you're planning to use PanelStudio-MC8-Forge you have to also add this:
93+
```groovy
94+
dependencies {
95+
compile('com.lukflug:panelstudio-mc8-forge:0.1.10')
96+
}
97+
98+
shadowJar {
99+
dependencies {
100+
include(dependency('com.lukflug:panelstudio-mc8-forge'))
101+
}
102+
}
103+
```
78104

79105
### ClickGUI
80106
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() {
178204
```
179205

180206
## Reference
181-
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.
182208

183209
## Creating custom themes
184210
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

Comments
 (0)