Skip to content

Create beautiful menus in Minecraft easily. Paging support, navigation, listing, advanced UI elements and more.

Notifications You must be signed in to change notification settings

Tominous/Designer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

This library is presented by:


Logo

Create complex menu systems and beautiful GUIs in Minecraft with ease. Designer uses Remain to maintain the perfect cross-version Minecraft compatibility.

Installation

We use Maven to compile. See below for a step-by-step tutorial.

  1. Place this to your repositories:
<repository>
	<id>jitpack.io</id>
	<url>https://jitpack.io</url>
</repository>
  1. Place this to your dependencies:
<dependency>
	<groupId>com.github.kangarko</groupId>
	<artifactId>Designer</artifactId>
	<version>3.0.0</version> <!-- change to the latest version -->
	<scope>compile</scope>
</dependency>
  1. Set your plugin's instance to hook into Designer by calling Designer#setPlugin(JavaPlugin).

  2. Make sure that the library shades into your final .jar when you compile your plugin. Here is an example of a shade plugin that will do it for you:

IF YOU ALREADY HAVE A SHADE PLUGIN, ONLY USE THE RELOCATION SECTION FROM BELOW.

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-shade-plugin</artifactId>
	<version>3.1.1</version>
	<executions>
		<execution>
			<phase>package</phase>
			<goals>
				<goal>shade</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<createDependencyReducedPom>false</createDependencyReducedPom>
		<relocations>
			<relocation>
				<pattern>org.mineacademy.designer</pattern>
				<shadedPattern>your.package.yourplugin.designer</shadedPattern>
			</relocation>
		</relocations>
	</configuration>
</plugin>

Compiling

Compiling is simple and requires Maven. Download this repo as a zip, import as Maven project and run "clean install" target.

However, you also need to download Remain (it's free) or edit the following dependency:

<dependency>
	<groupId>org.mineacademy.remain</groupId> <!-- Change this to com.github.kangarko -->
	<artifactId>Remain</artifactId>
	<version>LATEST</version> <!-- Change this to the latest version -->
	<scope>compile</scope>
</dependency>

Copyright (C) 2019 | All Rights Reserved. Commercial and non-commercial use allowed as long as you provide a clear link on your (sales) page that you are using this library.

About

Create beautiful menus in Minecraft easily. Paging support, navigation, listing, advanced UI elements and more.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages