- -
- +
- +
- +
[](https://jitpack.io/#MinestomPlugins/NextLib)
+
[](https://jitpack.io/#HypeJet/HypeStom)
+# HypeStom
-# NextLib
-
-~~Archived use the [new version merged with CityStom and NextPermissions](https://github.com/LabMCGames/NextLib)~~
-This repo has now been unarchived!
+Basic but useful utilities for creating Minestom extension (and other Minestom related stuff).
diff --git a/build.gradle b/build.gradle
index 8183edc..99e2256 100644
--- a/build.gradle
+++ b/build.gradle
@@ -4,20 +4,32 @@ plugins {
id 'java'
id "com.github.johnrengelman.shadow" version "7.1.2"
id 'maven-publish'
+ id 'org.jetbrains.kotlin.jvm' version '1.8.0'
+ id "org.jetbrains.kotlin.plugin.lombok" version "1.8.0"
+ id "io.freefair.lombok" version "6.6.1"
}
-group 'com.github.MinestomPlugins'
-version 'v1.0.6'
+group 'com.github.HypeJet'
+version 'v2.1.0'
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
+ maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
}
dependencies {
compileOnly 'com.github.Minestom:Minestom:-SNAPSHOT'
- implementation 'com.github.MinestomPlugins:NextPermissions:v1.1.3'
- implementation 'com.github.CityWideMC:CityStom:1.4.0'
+ implementation('net.kyori:adventure-text-minimessage:4.12.0')
+ implementation( "com.moandjiezana.toml:toml4j:0.7.2")
+ compileOnly("org.mongodb:mongo-java-driver:3.12.11")
+ compileOnly("org.projectlombok:lombok:1.18.24")
+ annotationProcessor("org.projectlombok:lombok:1.18.24")
+}
+
+kotlin {
+ jvmToolchain(17)
+ kotlinSourcesJar
}
publishing {
@@ -25,24 +37,31 @@ publishing {
release(MavenPublication) {
afterEvaluate {
var shadowJar = tasks.findByName("shadowJar")
- if (shadowJar == null) from(components["java"])
+ if (shadowJar == null) {
+ from(components["java"])
+ from(components["kotlin"])
+ }
else artifact(shadowJar)
}
- groupId = 'com.github.MinestomPlugins'
- artifactId = 'NextLib'
- version = '1.0.6'
+ groupId = 'com.github.HypeJet'
+ artifactId = 'HypeStom'
+ version = 'v2.1.0'
}
}
}
tasks.withType(ShadowJar) {
mergeServiceFiles()
+ archiveBaseName.set("HypeStom")
archiveClassifier.set("")
}
java {
withSourcesJar()
withJavadocJar()
+ toolchain {
+ languageVersion.set(JavaLanguageVersion.of(17))
+ }
}
wrapper {
diff --git a/jitpack.yml b/jitpack.yml
index 182d2d5..d6e7e16 100644
--- a/jitpack.yml
+++ b/jitpack.yml
@@ -1,5 +1,5 @@
jdk:
- - zulu18
+ - zulu17
before_install:
- - sdk install java 18.0.2-zulu
- - sdk use java 18.0.2-zulu
+ - sdk install java 17.0.5-zulu
+ - sdk use java 17.0.5-zulu
diff --git a/settings.gradle b/settings.gradle
index 59c8040..9676c2c 100644
--- a/settings.gradle
+++ b/settings.gradle
@@ -1,2 +1,2 @@
-rootProject.name = 'NextLib'
+rootProject.name = 'HypeStom'
diff --git a/src/main/java/me/window/next/command/Command.java b/src/main/java/me/window/next/command/Command.java
deleted file mode 100644
index 303604c..0000000
--- a/src/main/java/me/window/next/command/Command.java
+++ /dev/null
@@ -1,84 +0,0 @@
-package me.window.next.command;
-
-import me.window.permissions.PermissionProvider;
-import me.window.permissions.SubPermission;
-import net.kyori.adventure.text.Component;
-import net.kyori.adventure.text.format.NamedTextColor;
-import net.minestom.server.adventure.audience.Audiences;
-import net.minestom.server.command.CommandSender;
-import net.minestom.server.command.ConsoleSender;
-import net.minestom.server.entity.Player;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Objects;
-
-/**
- * Normal Command witch also uses extra permission features.
- */
-public class Command extends net.minestom.server.command.builder.Command {
-
- /**
- * The base permissions of this command
- */
- protected String permission;
-
- /**
- * The permission provider for this command
- * @see SubPermission
- */
- protected SubPermission provider;
-
- /**
- * Creates a new command.
- * Default permissions the extension's permissions with the command name as a subpermission.
- *
- * @param provider PermissionsProvider, automatically set in the Extension class.
- * @param name Name of the command SubPermission will be automatically created with this name.
- * @param aliases Nullable, aliases to the command that the CommandSenders can also run to execute the command.
- *- *
- * See also:
- * {@link Command#setPermission(String)} - */ - public Command(@NotNull PermissionProvider provider, @NotNull String name, @Nullable String... aliases) { - super(name, aliases); - this.provider = new SubPermission(provider, name); - setPermission(name); - setCondition(this::defaultCondition); - } - - /** - * Sets the subcommand permission. - * @param permission The permission to be used - */ - public void setPermission(String permission) { - this.permission = permission; - updatePermissions(); - } - - /** - * Set the required permissions level required for bypassing permissions. - * @param level The new op level - */ - public void setPermissionLevel(int level) { - provider.updatePermissions(level, permission); - } - - /** - * Updates the subpermission permissions with the new command permissions. - */ - public void updatePermissions() { - provider.updatePermissions(permission); - } - - /** - * Gives the sender access if it is either a console or if it has the command permission. - */ - protected boolean defaultCondition(CommandSender sender, String command) { - return sender instanceof ConsoleSender || provider.hasPermission((Player) sender); - } -} diff --git a/src/main/java/me/window/next/extension/Extension.java b/src/main/java/me/window/next/extension/Extension.java deleted file mode 100644 index 84227bc..0000000 --- a/src/main/java/me/window/next/extension/Extension.java +++ /dev/null @@ -1,25 +0,0 @@ -package me.window.next.extension; - -import me.window.next.command.Command; -import me.window.permissions.PermissionProvider; -import org.jetbrains.annotations.NotNull; -import org.jetbrains.annotations.Nullable; - -/** - * Normal CityStom extension that Automaticlly creates a PermissionProvider. - * @see xyz.citywide.citystom.Extension - */ -public abstract class Extension extends xyz.citywide.citystom.Extension { - - /** - * The extension PermissionProvider. - * - * @see PermissionProvider - */ - public static PermissionProvider provider; - - @Override - public void preInitialize() { - provider = new PermissionProvider(getOrigin().getName()); - } -} diff --git a/src/main/kotlin/org/hypejet/hype/command/Command.kt b/src/main/kotlin/org/hypejet/hype/command/Command.kt new file mode 100644 index 0000000..8889665 --- /dev/null +++ b/src/main/kotlin/org/hypejet/hype/command/Command.kt @@ -0,0 +1,61 @@ +package org.hypejet.hype.command + +import net.minestom.server.command.CommandSender +import net.minestom.server.command.ConsoleSender +import net.minestom.server.command.builder.Command +import net.minestom.server.command.builder.condition.CommandCondition +import net.minestom.server.entity.Player +import org.hypejet.hype.permission.PermissionProvider +import org.hypejet.hype.permission.SubPermission + +open class Command(provider: PermissionProvider, name: String, vararg aliases: String?) : Command(name, *aliases) { + /** + * The permission provider for this command + * @see SubPermission + */ + //@Getter Kotlin does not support lombok yet + protected var provider: SubPermission + + /** + * Creates a new command. + * Default permissions the extension's permissions with the command name as a subpermission. + * + * @param provider PermissionsProvider, automatically set in the Extension class. + * @param name Name of the command SubPermission will be automatically created with this name. + * @param aliases Nullable, aliases to the command that the CommandSenders can also run to execute the command. + *
+ *
+ * See also:
+ * [Command.setPermission] + */ + init { + this.provider = SubPermission(provider, name) + setPermission(name) + condition = CommandCondition { sender: CommandSender?, command: String? -> defaultCondition(sender, command) } + } + + /** + * Sets the subcommand permission. + * @param permission The permission to be used + */ + fun setPermission(permission: String?) { + if (permission != null) { + provider.updatePermissions(permission) + } + } + + /** + * Set the required permissions level required for bypassing permissions. + * @param level The new op level + */ + fun setPermissionLevel(level: Int) { + provider.setOpLevel(level) + } + + /** + * Gives the sender access if it is either a console or if it has the command permission. + */ + protected fun defaultCondition(sender: CommandSender?, command: String?): Boolean { + return sender is ConsoleSender || (sender as Player?)?.let { provider.hasPermission(it) } == true + } +} \ No newline at end of file diff --git a/src/main/kotlin/org/hypejet/hype/extension/Extension.kt b/src/main/kotlin/org/hypejet/hype/extension/Extension.kt new file mode 100644 index 0000000..4bea295 --- /dev/null +++ b/src/main/kotlin/org/hypejet/hype/extension/Extension.kt @@ -0,0 +1,128 @@ +package org.hypejet.hype.extension + +import com.moandjiezana.toml.Toml +import lombok.Getter +import net.kyori.adventure.text.Component +import net.minestom.server.MinecraftServer +import net.minestom.server.command.builder.Command +import net.minestom.server.extensions.Extension +import net.minestom.server.instance.block.BlockHandler +import net.minestom.server.timer.ExecutionType +import net.minestom.server.timer.TaskSchedule +import net.minestom.server.world.DimensionType +import org.hypejet.hype.permission.PermissionProvider +import java.io.IOException +import java.nio.file.Files +import java.nio.file.Path +import java.time.Duration + +abstract class Extension : Extension { + + /** + * The extension PermissionProvider. + * + * @see PermissionProvider + */ + @Getter + private var provider: PermissionProvider + + /** + * Create a new Extension and create PermissionProvider with custom op level requirement. + * + * @param permission The permission that this extension will use. + * @param oplevel The custom op level requirement. + * + * @see Extension.Extension + * @see Extension.Extension + */ + constructor(permission: String?, oplevel: Int) { + provider = permission?.let { PermissionProvider(oplevel, it) }!! + } + + /** + * Create a new Extension and create PermissionProvider. + * + * @param permission The permission that this extension will use. + * + * @see Extension.Extension + * @see Extension.Extension + */ + constructor(permission: String?) { + provider = permission?.let { PermissionProvider(it) }!! + } + + /** + * Create a new Extension and create PermissionProvider with the extension name from extension.json. + * + * @see Extension.Extension + * @see Extension.Extension + */ + constructor() { + provider = PermissionProvider(origin.name) + } + + fun registerCommand(command: Command) { + MinecraftServer.getCommandManager().register(command) + } + + fun unregisterCommand(command: Command) { + MinecraftServer.getCommandManager().unregister(command) + } + + fun registerDimension(type: DimensionType) { + MinecraftServer.getDimensionTypeManager().addDimension(type) + } + + fun registerBlockHandler(handler: BlockHandler) { + MinecraftServer.getBlockManager().registerHandler(handler.namespaceId) { handler } + } + + fun runAsync(runnable: Runnable) { + MinecraftServer.getSchedulerManager().scheduleTask(runnable, TaskSchedule.immediate(), + TaskSchedule.stop(), ExecutionType.ASYNC) + } + + fun runSync(runnable: Runnable) { + MinecraftServer.getSchedulerManager().scheduleTask(runnable, TaskSchedule.immediate(), + TaskSchedule.stop(), ExecutionType.SYNC) + } + + fun runDelayedAsync(runnable: Runnable, delay: Duration) { + MinecraftServer.getSchedulerManager().scheduleTask(runnable, TaskSchedule.duration(delay), + TaskSchedule.stop(), ExecutionType.ASYNC) + } + + fun runDelayedSync(runnable: Runnable, delay: Duration) { + MinecraftServer.getSchedulerManager().scheduleTask(runnable, TaskSchedule.duration(delay), + TaskSchedule.stop(), ExecutionType.SYNC) + } + + val config: Toml? + get() { + val configResource = javaClass.classLoader.getResourceAsStream("config.toml") + if (configResource == null) { + logger.error(Component.text("config.toml does not exists in resources folder")) + return null + } + val defaults = Toml() + defaults.read(configResource) + val toml = Toml(defaults) + val path = Path.of(dataDirectory.toString(), "config.toml") + return try { + if (!Files.exists(path)) { + if (!Files.exists(dataDirectory)) Files.createDirectory(path) + Files.createFile(path) + val stream = Files.newOutputStream(path) + stream.write(configResource.readAllBytes()) + configResource.close() + stream.close() + toml + } else { + configResource.close() + toml.read(Files.newInputStream(path)) + } + } catch (e: IOException) { + throw RuntimeException(e) + } + } +} diff --git a/src/main/kotlin/org/hypejet/hype/lang/LangApi.kt b/src/main/kotlin/org/hypejet/hype/lang/LangApi.kt new file mode 100644 index 0000000..f478839 --- /dev/null +++ b/src/main/kotlin/org/hypejet/hype/lang/LangApi.kt @@ -0,0 +1,39 @@ +package org.hypejet.hype.lang + +import com.mongodb.client.MongoDatabase +import lombok.SneakyThrows +import net.minestom.server.entity.Player +import net.minestom.server.event.player.PlayerDisconnectEvent +import net.minestom.server.event.player.PlayerSettingsChangeEvent +import net.minestom.server.extensions.Extension +import java.util.* + +interface LangApi { + fun getString(locale: Locale, name: String): String? + fun getLocale(player: Player): Locale? + fun setLocale(player: Player, locale: Locale): Boolean + fun setClientLocale(player: Player): Boolean + fun isClientLocale(player: Player): Boolean + fun createTable() + + companion object { + @SneakyThrows + fun create(extension: Extension, database: MongoDatabase, collection: String): LangApi? { + val coll = database.getCollection(collection) + val lang = LangApiImpl(extension, database, coll) + val settingsListener = PlayerSettingsListener() + val disconnectListener = PlayerDisconnectListener() + extension.eventNode.addListener(PlayerSettingsChangeEvent::class.java) { event: PlayerSettingsChangeEvent? -> + if (event != null) { + settingsListener.listener(event, lang) + } + } + extension.eventNode.addListener(PlayerDisconnectEvent::class.java) { event: PlayerDisconnectEvent? -> + if (event != null) { + disconnectListener.listener(event, settingsListener) + } + } + return lang + } + } +} \ No newline at end of file diff --git a/src/main/kotlin/org/hypejet/hype/lang/LangApiImpl.kt b/src/main/kotlin/org/hypejet/hype/lang/LangApiImpl.kt new file mode 100644 index 0000000..72b49d4 --- /dev/null +++ b/src/main/kotlin/org/hypejet/hype/lang/LangApiImpl.kt @@ -0,0 +1,74 @@ +package org.hypejet.hype.lang + +import com.moandjiezana.toml.Toml +import com.mongodb.client.MongoCollection +import com.mongodb.client.MongoDatabase +import com.mongodb.client.model.Filters +import com.mongodb.client.model.Updates +import lombok.SneakyThrows +import net.minestom.server.entity.Player +import net.minestom.server.extensions.Extension +import org.bson.Document +import java.util.* + +internal data class LangApiImpl(val extension: Extension, val database: MongoDatabase, val coll: MongoCollection
+ * The minimum permission level where the player bypasses permission check. + * 1-4, 5 to disable. +* + */ + //@Getter Kotlin does not support lombok yet + //@Setter Kotlin does not support lombok yet + var opLevell: Int + open fun getOpLevel(): Int { + return opLevell + } + open fun setOpLevel(lvl: Int) { + opLevell = lvl + } + + /** + * Creates a new PermissionProvider + * @param extensionPermission The permission that this that will be checked + */ + constructor(extensionPermission: String) { + this.extensionPermission = extensionPermission + opLevell = 4 + } + + /** + * Creates a new PermissionProvider + * @param opLevel The permission level where a player will be able to bypass permissions + * @param extensionPermission The permission that this that will be checked + */ + constructor(opLevel: Int, extensionPermission: String) { + this.extensionPermission = extensionPermission + this.opLevell = opLevel + } + + /** + * Replaces permission with new permissions + * @param extensionPermission The new permissions + */ + open fun updatePermissions(extensionPermission: String) { + this.extensionPermission = extensionPermission + opLevell = 4 + } + + /** + * Replaces permission with new permissions + * @param opLevel the new op level + * @param extensionPermission The new permissions + */ + open fun updatePermissions(opLevel: Int, extensionPermission: String) { + this.extensionPermission = extensionPermission + this.opLevell = opLevel + } + + /** + * Checks if the player has a subpermission + * @param player the player to check + * @param permission the permission + * @return if the player has the permission + */ + fun hasPermission(player: Player, permission: String): Boolean { + return if (player.hasPermission("*") || player.permissionLevel >= opLevell) true else player.hasPermission("$extensionPermission.*") || player.hasPermission( + "$extensionPermission.$permission" + ) + } + + /** + * Checks if the player has one of the provider permissions + * @param player the player to check + * @return if the player has permission + */ + fun hasPermission(player: Player): Boolean { + return if (player.hasPermission("*") || player.permissionLevel >= opLevell) true else player.hasPermission( + extensionPermission + ) + } + + /** + * Checks if the player has a subpermission + * @param player the player to check + * @param permission the permission + * @param opLevel override the default provider op level + * @return if the player has the permission + */ + fun hasPermission(player: Player, permission: String, opLevel: Int): Boolean { + return if (player.hasPermission("*") || player.permissionLevel >= opLevel) true else player.hasPermission("$extensionPermission.*") || player.hasPermission( + "$extensionPermission.$permission" + ) + } + + /** + * Checks if the player has one of the provider permissions + * @param player the player to check + * @param opLevel override the default provider op level + * @return if the player has permission + */ + fun hasPermission(player: Player, opLevel: Int): Boolean { + return if (player.hasPermission("*") || player.permissionLevel >= opLevel) true else player.hasPermission( + extensionPermission + ) + } +} diff --git a/src/main/kotlin/org/hypejet/hype/permission/SubPermission.kt b/src/main/kotlin/org/hypejet/hype/permission/SubPermission.kt new file mode 100644 index 0000000..5d9d59a --- /dev/null +++ b/src/main/kotlin/org/hypejet/hype/permission/SubPermission.kt @@ -0,0 +1,51 @@ +package org.hypejet.hype.permission + +class SubPermission : PermissionProvider { + /** + * The parent permission. + */ + //@Getter Kotlin does not support lombok yet + var parent: PermissionProvider + + /** + * Creates a new subpermission + * @param parent The parent permission can be either a permission provider or a SubPermission + * @param extensionPermission The permission that this that will be checked + */ + constructor( + parent: PermissionProvider, + extensionPermission: String + ) : super(parent.extensionPermission + "." + extensionPermission) { + this.parent = parent + } + + /** + * Creates a new subpermission + * @param parent The parent permission can be either a permission provider or a SubPermission + * @param opLevel The permission level where a player will be able to bypass permissions + * @param extensionPermission The permission that will be checked + */ + constructor(parent: PermissionProvider, opLevel: Int, extensionPermission: String) : super( + opLevel, + parent.extensionPermission + "." + extensionPermission + ) { + this.parent = parent + } + + /** + * Replaces permission with new permissions + * @param extensionPermission The new permission + */ + override fun updatePermissions(extensionPermission: String) { + super.updatePermissions(parent.extensionPermission + "." + extensionPermission) + } + + /** + * Replaces permission with new permissions + * @param opLevel the new op level + * @param extensionPermission The new permission + */ + override fun updatePermissions(opLevel: Int, extensionPermission: String) { + super.updatePermissions(opLevel, parent.extensionPermission + "." + extensionPermission) + } +} \ No newline at end of file diff --git a/src/main/kotlin/org/hypejet/hype/runnable/MinestomRunnable.kt b/src/main/kotlin/org/hypejet/hype/runnable/MinestomRunnable.kt new file mode 100644 index 0000000..74ae674 --- /dev/null +++ b/src/main/kotlin/org/hypejet/hype/runnable/MinestomRunnable.kt @@ -0,0 +1,52 @@ +package org.hypejet.hype.runnable + +import net.minestom.server.MinecraftServer +import net.minestom.server.timer.ExecutionType +import net.minestom.server.timer.Task +import net.minestom.server.timer.TaskSchedule +import java.time.Duration + +abstract class MinestomRunnable : Runnable { + private var task: Task? = null + private var delay = TaskSchedule.immediate() + private var repeat = TaskSchedule.stop() + private var executionType = ExecutionType.SYNC + + constructor() + constructor(delay: TaskSchedule, repeat: TaskSchedule) { + this.delay = delay + this.repeat = repeat + } + + fun delay(delay: Duration) { + if (delay === Duration.ZERO) return + this.delay = TaskSchedule.duration(delay) + } + + fun delay(delay: TaskSchedule) { + this.delay = delay + } + + fun repeat(repeat: Duration) { + if (repeat === Duration.ZERO) return + this.repeat = TaskSchedule.duration(repeat) + } + + fun repeat(repeat: TaskSchedule) { + this.repeat = repeat + } + + fun type(type: ExecutionType) { + executionType = type + } + + fun schedule(): Task { + val manager = MinecraftServer.getSchedulerManager() + task = manager.scheduleTask(this, delay, repeat, executionType) + return task as Task + } + + fun cancel() { + if (task != null) task!!.cancel() + } +} diff --git a/src/main/kotlin/org/hypejet/hype/tablist/GlobalTablist.kt b/src/main/kotlin/org/hypejet/hype/tablist/GlobalTablist.kt new file mode 100644 index 0000000..f45d801 --- /dev/null +++ b/src/main/kotlin/org/hypejet/hype/tablist/GlobalTablist.kt @@ -0,0 +1,55 @@ +package org.hypejet.hype.tablist + +import lombok.Getter +import lombok.Setter +import net.kyori.adventure.text.Component +import net.kyori.adventure.text.JoinConfiguration +import net.minestom.server.entity.Player + +class GlobalTablist : Tablist() { + override fun createPlayerList(player: Player?): Array