Dev/feature - Future Feature Release

.github/contributing.md

@@ -23,6 +23,8 @@ This way the team can discuss with you whether or not we want this in HySkript.
 - Use descriptive commit messages
 - Use descriptive PR titles
 - Ensure you follow the code style of this project
+- Do make sure you add tests and run the test to make sure it works. 
+  - See the [Testing Guide](https://github.com/SkriptDev/HySkript/tree/master/src/test/README.md) for more information.
 
 ### Don't:
 - Don't commit directly to `master`
@@ -60,3 +62,6 @@ This way the team can discuss with you whether or not we want this in HySkript.
     - For expressions, please provide an example of using the getter as well as each changer you have applied.
     - For all others, please provide at least one example per pattern.
     - Please see other examples in HySkript for further inspiration.
+
+### Tests:
+See the [Testing Guide](https://github.com/SkriptDev/HySkript/tree/master/src/test/README.md) for more information.

.gitignore

@@ -43,3 +43,6 @@ bin/
 ### Mac OS ###
 .DS_Store
 **/.DS_Store
+
+### Run Folder ###
+run/

build.gradle.kts

@@ -9,12 +9,17 @@ java.sourceCompatibility = JavaVersion.VERSION_25
 
 group = "com.github.SkriptDev"
 val projectVersion = "1.0.0"
-val hytaleVersion = "2026.02.06-aa1b071c2"
+val hytaleVersion = "2026.02.17-255364b8e"
 // You can find Hytale versions on their maven repo:
 // https://maven.hytale.com/release/com/hypixel/hytale/Server/maven-metadata.xml
 // https://maven.hytale.com/pre-release/com/hypixel/hytale/Server/maven-metadata.xml
 // (Pre-releases shouldn't be used for production)
 
+// Location of the Hytale Server Assets
+// This is used in testing
+// Change this to wherever you have it on your computer
+val assetLocation = "/Users/ShaneBee/Desktop/Server/Hytale/Assets/Assets.zip"
+
 repositories {
     mavenCentral()
     mavenLocal()
@@ -26,14 +31,20 @@ repositories {
 dependencies {
     compileOnly("com.hypixel.hytale:Server:${hytaleVersion}")
     compileOnly("org.jetbrains:annotations:26.0.2")
-    implementation("com.github.SkriptDev:skript-parser:1.0.8") {
+    implementation("com.github.SkriptDev:skript-parser:dev~patch-SNAPSHOT") {
         isTransitive = false
     }
     implementation("com.github.Zoltus:TinyMessage:2.0.1") {
         isTransitive = false
     }
 }
 
+// This is used to enable Gson in the test environment via HytaleServer
+val testRunnerClasspath by configurations.creating {
+    extendsFrom(configurations.compileOnly.get())
+    isCanBeResolved = true
+}
+
 tasks {
     register("server", Copy::class) {
         dependsOn("jar")
@@ -42,6 +53,14 @@ tasks {
             destinationDir = file("/Users/ShaneBee/Desktop/Server/Hytale/Creative/mods/")
         }
     }
+    register<JavaExec>("testRunner") {
+        dependsOn("jar")
+        group = "application"
+        mainClass.set("com.github.skriptdev.skript.api.skript.testing.TestRunnerMain")
+        args(hytaleVersion, projectVersion, assetLocation)
+
+        classpath = sourceSets["main"].runtimeClasspath + testRunnerClasspath
+    }
     processResources {
         filesNotMatching("assets/**") {
             expand("pluginVersion" to projectVersion, "hytaleVersion" to hytaleVersion)
@@ -71,7 +90,8 @@ tasks {
         options.encoding = Charsets.UTF_8.name()
         exclude(
             "com/github/skriptdev/skript/plugin/elements",
-            "com/github/skriptdev/skript/plugin/command"
+            "com/github/skriptdev/skript/plugin/command",
+            "com/github/skriptdev/skript/api/skript/testing/elements"
         )
         (options as StandardJavadocDocletOptions).links(
             "https://javadoc.io/doc/org.jetbrains/annotations/latest/",

src/main/java/com/github/skriptdev/skript/api/hytale/Block.java

@@ -1,22 +1,34 @@
 package com.github.skriptdev.skript.api.hytale;
 
-import com.github.skriptdev.skript.api.utils.Utils;
+import com.github.skriptdev.skript.api.hytale.utils.StoreUtils;
+import com.hypixel.hytale.component.CommandBuffer;
 import com.hypixel.hytale.component.Ref;
 import com.hypixel.hytale.component.Store;
 import com.hypixel.hytale.math.util.ChunkUtil;
 import com.hypixel.hytale.math.vector.Location;
 import com.hypixel.hytale.math.vector.Vector3i;
 import com.hypixel.hytale.server.core.asset.type.blocktype.config.BlockType;
 import com.hypixel.hytale.server.core.asset.type.fluid.Fluid;
+import com.hypixel.hytale.server.core.entity.LivingEntity;
+import com.hypixel.hytale.server.core.inventory.ItemStack;
+import com.hypixel.hytale.server.core.modules.blockhealth.BlockHealth;
+import com.hypixel.hytale.server.core.modules.blockhealth.BlockHealthChunk;
+import com.hypixel.hytale.server.core.modules.blockhealth.BlockHealthModule;
+import com.hypixel.hytale.server.core.modules.interaction.BlockHarvestUtils;
+import com.hypixel.hytale.server.core.universe.PlayerRef;
 import com.hypixel.hytale.server.core.universe.Universe;
 import com.hypixel.hytale.server.core.universe.world.World;
 import com.hypixel.hytale.server.core.universe.world.chunk.ChunkColumn;
 import com.hypixel.hytale.server.core.universe.world.chunk.WorldChunk;
 import com.hypixel.hytale.server.core.universe.world.chunk.section.FluidSection;
 import com.hypixel.hytale.server.core.universe.world.storage.ChunkStore;
+import com.hypixel.hytale.server.core.universe.world.storage.EntityStore;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.Map;
+import java.util.function.Predicate;
+
 /**
  * Represents a block in a world.
  * Hytale doesn't appear to have a representation of a block in the world.
@@ -137,7 +149,6 @@ public void setFluid(@NotNull Fluid fluid, @Nullable Integer level) {
                     if (fluidLevel <= 0) fluidLevel = (byte) fluid.getMaxFluidLevel();
                 }
                 fluidLevel = (byte) Math.clamp((int) fluidLevel, 0, fluid.getMaxFluidLevel());
-                Utils.log("Set fluid level to %s", fluidLevel);
                 fluidSection.setFluid(this.pos.getX(), this.pos.getY(), this.pos.getZ(), fluid, fluidLevel);
             }
             return chunk;
@@ -148,6 +159,75 @@ public void breakBlock(int settings) {
         this.world.breakBlock(this.pos.getX(), this.pos.getY(), this.pos.getZ(), settings);
     }
 
+    public void damage(@Nullable LivingEntity performer, @Nullable ItemStack itemStack, float damage) {
+        WorldChunk chunk = this.world.getChunk(ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ()));
+        if (chunk == null) return;
+
+        Ref<ChunkStore> ref = chunk.getReference();
+        Store<ChunkStore> chunkStore = this.world.getChunkStore().getStore();
+        CommandBuffer<EntityStore> commandBuffer = StoreUtils.getCommandBuffer(this.world.getEntityStore().getStore());
+
+        if (performer == null) {
+            BlockHarvestUtils.performBlockDamage(
+                this.pos,
+                null,
+                null,
+                damage,
+                0,
+                ref,
+                commandBuffer,
+                chunkStore);
+        } else {
+            BlockHarvestUtils.performBlockDamage(
+                performer,
+                performer.getReference(),
+                this.pos,
+                itemStack,
+                null,
+                null, // TODO figure out how to get this
+                false,
+                damage,
+                0,
+                ref,
+                commandBuffer,
+                chunkStore);
+        }
+    }
+
+    public float getBlockHealth() {
+        WorldChunk chunk = this.world.getChunk(ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ()));
+        if (chunk == null) return 0;
+
+        Ref<ChunkStore> ref = chunk.getReference();
+        Store<ChunkStore> chunkStore = this.world.getChunkStore().getStore();
+
+        BlockHealthChunk component = chunkStore.getComponent(ref, BlockHealthModule.get().getBlockHealthChunkComponentType());
+        if (component == null) return 0;
+
+        return component.getBlockHealth(this.pos);
+    }
+
+    public void setBlockHealth(float health) {
+        WorldChunk chunk = this.world.getChunk(ChunkUtil.indexChunkFromBlock(this.pos.getX(), this.pos.getZ()));
+        if (chunk == null) return;
+
+        Ref<ChunkStore> ref = chunk.getReference();
+        Store<ChunkStore> chunkStore = this.world.getChunkStore().getStore();
+        BlockHealthChunk component = chunkStore.getComponent(ref, BlockHealthModule.get().getBlockHealthChunkComponentType());
+        if (component == null) return;
+
+        Map<Vector3i, BlockHealth> blockHealthMap = component.getBlockHealthMap();
+        BlockHealth blockHealth = blockHealthMap.getOrDefault(this.pos, new BlockHealth());
+        blockHealth.setHealth(health);
+        blockHealthMap.put(this.pos, blockHealth);
+
+        if (!blockHealth.isDestroyed()) {
+            Predicate<PlayerRef> filter = (player) -> true;
+            world.getNotificationHandler().updateBlockDamage(this.pos.getX(), this.pos.getY(),
+                this.pos.getZ(), blockHealth.getHealth(), health, filter);
+        }
+    }
+
     public @NotNull World getWorld() {
         return this.world;
     }

src/main/java/com/github/skriptdev/skript/api/hytale/utils/AssetStoreUtils.java

@@ -1,6 +1,7 @@
 package com.github.skriptdev.skript.api.hytale.utils;
 
 import com.hypixel.hytale.server.core.asset.type.blocktype.config.BlockType;
+import com.hypixel.hytale.server.core.asset.type.environment.config.Environment;
 import com.hypixel.hytale.server.core.asset.type.item.config.Item;
 import com.hypixel.hytale.server.core.inventory.ItemStack;
 import org.jetbrains.annotations.NotNull;
@@ -42,4 +43,24 @@ public class AssetStoreUtils {
         return null;
     }
 
+    /**
+     * Get the AssetStore index of an Environment
+     *
+     * @param environment Environment to get index from
+     * @return Index from Environment
+     */
+    public static int getEnvironmentIndex(Environment environment) {
+        return Environment.getAssetMap().getIndex(environment.getId());
+    }
+
+    /**
+     * Get an Environment from its AssetStore index.
+     *
+     * @param index Index to grab Environment from
+     * @return Environment from index, or null if not found
+     */
+    public static Environment getEnvironment(int index) {
+        return Environment.getAssetMap().getAsset(index);
+    }
+
 }

src/main/java/com/github/skriptdev/skript/api/hytale/utils/EntityUtils.java

@@ -1,5 +1,7 @@
 package com.github.skriptdev.skript.api.hytale.utils;
 
+import com.github.skriptdev.skript.api.skript.registration.NPCRegistry;
+import com.github.skriptdev.skript.api.utils.Utils;
 import com.hypixel.hytale.component.AddReason;
 import com.hypixel.hytale.component.Component;
 import com.hypixel.hytale.component.ComponentType;
@@ -20,6 +22,9 @@
 import com.hypixel.hytale.server.core.modules.entitystats.EntityStatsModule;
 import com.hypixel.hytale.server.core.universe.world.World;
 import com.hypixel.hytale.server.core.universe.world.storage.EntityStore;
+import com.hypixel.hytale.server.npc.entities.NPCEntity;
+import com.hypixel.hytale.server.npc.role.Role;
+import com.hypixel.hytale.server.npc.systems.RoleChangeSystem;
 import io.github.syst3ms.skriptparser.util.Pair;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -99,7 +104,7 @@ public static void setNameplateName(Entity entity, @Nullable String name) {
     }
 
     /**
-     * Get a component from an Entity
+     * Get a component from an Entity.
      *
      * @param entity     Entity to get component from
      * @param type       Component type to get
@@ -116,6 +121,26 @@ public static void setNameplateName(Entity entity, @Nullable String name) {
         return store.getComponent(reference, type);
     }
 
+    /**
+     * Get a component from an Entity or create it if not present.
+     *
+     * @param entity     Entity to get component from
+     * @param type       Component type to get
+     * @param <ECS_TYPE> EntityStore Type
+     * @param <T>        Type of returned component
+     * @return Component from entity if available otherwise will create/add a new one
+     */
+    @SuppressWarnings("unchecked")
+    public static <ECS_TYPE, T extends Component<ECS_TYPE>> @NotNull T ensureAndGetComponent(Entity entity, ComponentType<ECS_TYPE, T> type) {
+        Ref<ECS_TYPE> reference = (Ref<ECS_TYPE>) entity.getReference();
+        if (reference == null) {
+            throw new IllegalStateException("Entity '" + entity + "' does not have a reference");
+        }
+
+        Store<ECS_TYPE> store = reference.getStore();
+        return store.ensureAndGetComponent(reference, type);
+    }
+
     /**
      * Get the EntityStatMap component of an entity.
      *
@@ -173,4 +198,54 @@ public static void setNameplateName(Entity entity, @Nullable String name) {
         return new Pair<>(com.hypixel.hytale.server.core.entity.EntityUtils.getEntity(itemEntityHolder), itemComponent);
     }
 
+    public static boolean isTameable(NPCEntity npcEntity) {
+        Role role = npcEntity.getRole();
+        if (role == null) return false;
+
+        String roleName = role.getRoleName();
+        if (roleName.contains("Tamed_")) {
+            return true;
+        }
+        // I know this is hacky, but Hytale doesn't have any API for taming
+        // Maybe we'll get lucky and Hytale will create API for this
+        NPCRegistry.NPCRole parse = NPCRegistry.parse("tamed_" + roleName);
+        return parse != null;
+    }
+
+    public static boolean isTamed(NPCEntity npcEntity) {
+        Role role = npcEntity.getRole();
+        if (role == null) return false;
+
+        // I know this is hacky, but Hytale doesn't have any API for taming
+        // Maybe we'll get lucky and Hytale will create API for this
+        String roleName = role.getRoleName();
+        return roleName.startsWith("Tamed_");
+    }
+
+    public static void setTamed(NPCEntity npcEntity, boolean tamed) {
+        if (!isTameable(npcEntity)) {
+            return;
+        }
+        if ((tamed && isTamed(npcEntity)) || (!tamed && !isTamed(npcEntity))) {
+            return;
+        }
+        Ref<EntityStore> reference = npcEntity.getReference();
+        if (reference == null) return;
+
+        Store<EntityStore> store = reference.getStore();
+
+        // I know this is hacky, but Hytale doesn't have any API for taming
+        // Maybe we'll get lucky and Hytale will create API for this
+        Role currentRole = npcEntity.getRole();
+        if (currentRole == null || currentRole.isRoleChangeRequested()) return;
+
+        String roleName = currentRole.getRoleName();
+        roleName = tamed ? "Tamed_" + roleName : roleName.replace("Tamed_", "");
+
+        NPCRegistry.NPCRole parse = NPCRegistry.parse(roleName);
+
+        Utils.log("Changing role to %s", parse.name());
+        RoleChangeSystem.requestRoleChange(reference, currentRole, parse.index(), true, store);
+    }
+
 }

src/main/java/com/github/skriptdev/skript/api/hytale/utils/StoreUtils.java

@@ -6,6 +6,9 @@
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
+/**
+ * Utilities for a {@link Store Hytale Store}
+ */
 public class StoreUtils {
 
     @SuppressWarnings("unchecked")

src/main/java/com/github/skriptdev/skript/api/hytale/utils/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Utility classes for Hytale.
+ */
+package com.github.skriptdev.skript.api.hytale.utils;