Skip to content

Commit

Permalink
PanelStudio 0.1.8
Browse files Browse the repository at this point in the history
  • Loading branch information
lukflug committed Jan 19, 2021
1 parent 1e97045 commit a0158b0
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ 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.4 and also works on 1.16.5 (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 core library works on any Minecraft version (and even on any non-Minecraft application).

## Features
* Ability to easily create new themes/skins.
Expand All @@ -42,7 +42,7 @@ repositories {
}
dependencies {
compile("com.lukflug:panelstudio:0.1.7")
compile("com.lukflug:panelstudio:0.1.8")
}
shadowJar {
Expand All @@ -54,7 +54,7 @@ shadowJar {
If you're planning to use PanelStudio-MC you have to also add this (replace `mc12` by `mc16`, if using PanelStudio-MC16):
```groovy
dependencies {
compile("com.lukflug:panelstudio-mc12:0.1.7")
compile("com.lukflug:panelstudio-mc12:0.1.8")
}
shadowJar {
Expand Down Expand Up @@ -166,7 +166,7 @@ Toggleable hudToggle=new Toggleable() {
```

## Reference
For a list of classes and methods, consult the [javadoc](https://lukflug.github.io/javadoc/panelstudio/0.1.7/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.8/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`.

0 comments on commit a0158b0

Please sign in to comment.