ContainrGUI

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 12 Open GitHub ↗

The best Minecraft GUI library on the market.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Containr GUI
An advanced GUI solution. Build fast, responsible, animated menus.<br>Let's imagine almost unlimited GUI possibilities.<br>

![Badge](https://img.shields.io/jitpack/version/com.github.ZorTik/ContainrGUI?style=for-the-badge) ![Badge](https://img.shields.io/github/license/ZorTik/ContainrGUI?style=for-the-badge)
</div>

## About
Creating a static GUI (Graphical User Interface) can be a tedious and time-consuming task, especially when working with complex environments like Minecraft. That's where the Containr library comes in. **Reactive**, **modular** and highly **extendable**. These are the words that describe Containr well!

## Features
- **Reusable Components**: Create reusable components for items (*Element*) and containers (*Container*) to keep even the most complex menu systems maintainable.
- **Nested Containers**: Embed containers within each other to create flexible and modular menu structures. Each container has its own indexing system based on its size.
- **Pagination Support**: Support for multi-layer pagination using containers, making it easy to handle large amounts of content.
- **High Performance**: Optimized system enables extremely fast menu creation and updates.
- **Animation Support**: Built-in support for implementing animations for single elements, or whole containers.
- **Pattern-based Layout Support**: Define menu layouts using patterns, allowing menus to be configured directly from config files.
- **YAML Serialization**: Save and load entire menu structures using Spigot YAML configuration files and allow your users to define their own easily.

## Simple Hello World
This library makes building GUIs simple and quick as 1, 2, 3. See:
```java
GUI gui = Component.gui()
    .title("GUI Title")
    .rows(3)
    .prepare((g) -> {
	Container container = Component.staticContainer()
	    .size(4, 1)
	    .init(c -> {
	    	c.setElement(2, Component.element()
                    .click(info -> {
                        Player player = info.getPlayer();
                        player.sendMessage("§7Time refreshed!");
                        
                        info.getGui().update(player);
                    })
                    // Compute an item on every render
                    .item(info -> Items.create(Material.REDSTONE_BLOCK,
                            "§cTime: " + DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalTime.now()),
                            "§7Click to refresh the time")
                    )
                    .build());
	    }).build();
    
        g.setContainer(1, container);
    })
    .build();

gui.open(player);
```
[More on new Wiki](https://github.com/ZorTik/ContainrGUI/wiki)

## Installation
You can add Containr to your build path using Maven or Gradle. ContainrGUI is **not a Minecraft plugin**! This means that you can use it's code directly in your project by shading it into your build path.

<details><summary>Gradle</summary>

Add this project to your build path using Gradle with JitPack as represented below.
```gradle
repositories {
	maven { url = 'https://jitpack.io' }
}
```
```gradle
dependencies {
	implementation 'com.github.ZorTik:ContainrGUI:0.7-pre7'
}
```
</details>

<details><summary>Maven</summary>

You can also use Maven with JitPack as seen below.
```xml
<repositories>
	<repository>
		<id>jitpack.io</id>
		<url>https://jitpack.io</url>
	</repository>
</repositories>
```
```xml
<dependency>
	<groupId>com.github.ZorTik</groupId>
		<artifactId>ContainrGUI</artifactId>
	<version>0.7-pre7</version>
</dependency>
```
</details>

ContainrGUI

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README