Initial library commit.

BONNePlayground · Sep 27, 2021 · 3070ef0 · 3070ef0
commit 3070ef0
Show file tree

Hide file tree

Showing 5 changed files with 925 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,137 @@
+### Others ###
+*.cmd
+*.sh
+*.prefs
+
+### Maven ###
+/mvn
+/target/lib
+/target/maven-archiver
+/target/classes
+/target/maven-status
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+out/
+
+
+### Java ###
+*.class
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.war
+*.ear
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+
+### Intellij ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+.idea/workspace.xml
+.idea/tasks.xml
+.idea/dictionaries
+.idea/shelf
+
+# Sensitive or high-churn files:
+.idea/dataSources.ids
+.idea/dataSources.xml
+.idea/sqlDataSources.xml
+.idea/dynamic.xml
+.idea/uiDesigner.xml
+
+# Gradle:
+.idea/gradle.xml
+.idea/libraries
+.gradle
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+
+### Eclipse ###
+*.pydevproject
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+
+# Eclipse Core
+.project
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+/target/
+checkstyle.xml
+classes/
+/.DS_Store
+
+# each moddule gitignore
+/*/target/*
diff --git a/README.md b/README.md
@@ -0,0 +1,56 @@
+# Panel Utils 
+This repository contains a frequently used methods in BentoBox addons that I create.
+
+### Main PanelUtils class contains methods:
+
+```
+/**
+ * This method sets blocks with given Material around Panel with given row count.
+ * @param panelBuilder object that builds Panel.
+ * @param rowCount in Panel.
+ * @param material that will be around Panel.
+ */
+PanelUtils#fillBorder(PanelBuilder panelBuilder, int rowCount, Material material)
+
+/**
+ * This method transforms entity into player head with skin that corresponds given
+ * entity. If entity head is not found, then it is replaced by barrier block.
+ * @param entity which head must be returned.
+ * @param amount of ItemStack elements.
+ * @return ItemStack that may be head for given entity.
+ */
+PanelUtils#getEntityHead(EntityType entity, int amount)
+
+/**
+ * This method transforms entity into egg or block that corresponds given entity.
+ * If entity egg is not found, then it is replaced by block that represents entity or
+ * barrier block.
+ * @param entity which egg must be returned.
+ * @param amount of ItemStack elements.
+ * @return ItemStack that may be egg for given entity.
+ */
+PanelUtils#getEntityEgg(EntityType entity, int amount)
+
+/**
+ * This method transforms material into item stack that can be displayed in users
+ * inventory, as not all materials can be displayed.
+ * @param material which item stack must be returned.
+ * @param amount of ItemStack elements.
+ * @return ItemStack that represents given material.
+ */
+PanelUtils#getMaterialItem(Material material, int amount)
+```
+
+### Main MobHeadContainer method:
+
+```
+/**
+ * Returns an ItemStack of the custom head.
+ *
+ * @param amount of items in the stack
+ * @param displayName the name to display. Supports "&amp;" color codes
+ * @param loreLines   optional lore lines. Supports "&amp;" color codes
+ * @return an ItemStack of the custom head.
+ */
+MobHeadContainer#toItemStack(int amount, String displayName, String... loreLines)
+```
diff --git a/pom.xml b/pom.xml
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<groupId>lv.id.bonne</groupId>
+	<version>1.0.0</version>
+	<artifactId>panelutils</artifactId>
+
+	<repositories>
+		<!-- Spigot Repo -->
+		<repository>
+			<id>spigot-repo</id>
+			<url>https://hub.spigotmc.org/nexus/content/repositories/snapshots</url>
+		</repository>
+		<!-- CodeMC Repo for BentoBox -->
+		<repository>
+			<id>codemc-repo</id>
+			<url>https://repo.codemc.io/repository/maven-public</url>
+		</repository>
+		<!-- Minecraft Lib Repo -->
+		<repository>
+			<id>minecraft-repo</id>
+			<url>https://libraries.minecraft.net/</url>
+		</repository>
+		<!-- GitHub Lib Repo -->
+		<repository>
+			<id>github</id>
+			<name>GitHub BONNe Apache Maven Packages</name>
+			<url>https://maven.pkg.github.com/BONNePlayground/PanelUtils</url>
+		</repository>
+	</repositories>
+
+	<distributionManagement>
+		<repository>
+			<id>github</id>
+			<url>https://maven.pkg.github.com/BONNePlayground/PanelUtils</url>
+		</repository>
+	</distributionManagement>
+
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+		<java.version>16</java.version>
+		<spigot.version>1.17-R0.1-SNAPSHOT</spigot.version>
+		<bentobox.version>1.17.0</bentobox.version>
+		<auth.version>1.5.21</auth.version>
+		<annotations.version>22.0.0</annotations.version>
+	</properties>
+
+	<dependencies>
+		<!-- Spigot API -->
+		<dependency>
+			<groupId>org.spigotmc</groupId>
+			<artifactId>spigot-api</artifactId>
+			<version>${spigot.version}</version>
+			<scope>provided</scope>
+		</dependency>
+		<!-- BentoBox dependencies. -->
+		<dependency>
+			<groupId>world.bentobox</groupId>
+			<artifactId>bentobox</artifactId>
+			<version>${bentobox.version}</version>
+			<scope>provided</scope>
+		</dependency>
+		<!-- Mojang Auth -->
+		<dependency>
+			<groupId>com.mojang</groupId>
+			<artifactId>authlib</artifactId>
+			<version>${auth.version}</version>
+			<scope>provided</scope>
+		</dependency>
+		<!-- Annotations -->
+		<dependency>
+			<groupId>org.jetbrains</groupId>
+			<artifactId>annotations</artifactId>
+			<version>${annotations.version}</version>
+			<scope>provided</scope>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<finalName>${project.artifactId}</finalName>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>3.7.0</version>
+				<configuration>
+					<source>${java.version}</source>
+					<target>${java.version}</target>
+				</configuration>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-deploy-plugin</artifactId>
+				<version>2.8.2</version>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-clean-plugin</artifactId>
+				<version>3.1.0</version>
+			</plugin>
+		</plugins>
+	</build>
+</project>