A command DSL, built on top of Brigadier - the idea of this DSL is to bring the Kotlin builder style to Brigadier. This DSL does not hide vanilla Brigadier from you.
modImplementation("net.axay:fabrikmc-commands:1.8.0")You first have to create a command instance using the command or clientCommand function.
Have a look at the commands package below for more information.
After that, you can register that command instance.
Have a look at the commands.registration package below to see if you have to do it manually, and if yes, how.
A command DSL, built on top of Brigadier - the idea of this DSL is to bring the Kotlin builder style to Brigadier. This DSL does not hide vanilla Brigadier from you.
modImplementation("net.axay:fabrikmc-commands:1.8.1")You first have to create a command instance using the command or clientCommand function.
Have a look at the commands package below for more information.
After that, you can register that command instance.
Have a look at the commands.registration package below to see if you have to do it manually, and if yes, how.
Set up a callback which automatically registers this command on server startup.
Set up a callback which automatically registers this command on server startup.
Register this command (client-side).
Register this command (client-side).
Set up a callback which automatically registers this command on server startup.
Set up a callback which automatically registers this command on server startup.
Register this command (client-side).
Adds custom suspending suggestion logic for an argument.
the CoroutineScope where the suggestions should be built in - an async scope by default, but you can change this to a synchronous scope using net.axay.fabrik.core.task.mcCoroutineScope
Suggest the entries of the iterable which is the result of the suggestionsBuilder.
the CoroutineScope where the suggestions should be built in - an async scope by default, but you can change this to a synchronous scope using net.axay.fabrik.core.task.mcCoroutineScope
Suggest the entries of the iterable which is the result of the suggestionsBuilder. Additionaly, a separate tooltip associated with each suggestion will be shown as well.
the CoroutineScope where the suggestions should be built in - an async scope by default, but you can change this to a synchronous scope using net.axay.fabrik.core.task.mcCoroutineScope
Suggest the entries of the iterable which is the result of the suggestionsBuilder. Additionaly, a separate tooltip associated with each suggestion will be shown as well.
Suggest the entries of the iterable which is the result of the suggestionsBuilder.
Suggest the value which is the result of the suggestionBuilder.
the CoroutineScope where the suggestion should be built in - an async scope by default, but you can change this to a synchronous scope using net.axay.fabrik.core.task.mcCoroutineScope
Suggest the value which is the result of the suggestionBuilder. Additionaly, a separate tooltip associated with the suggestion will be shown as well.
the CoroutineScope where the suggestion should be built in - an async scope by default, but you can change this to a synchronous scope using net.axay.fabrik.core.task.mcCoroutineScope
Suggest the value which is the result of the suggestionBuilder. Additionaly, a separate tooltip associated with the suggestion will be shown as well.
Suggest the value which is the result of the suggestionBuilder.
Adds a new argument to this command. This variant of the argument function allows you to specify the ArgumentType in the classical Brigadier way.
the name of the argument - This will be displayed to the player, if there is enough room for the tooltip.
the type of the argument - There are predefined types like StringArgumentType.string() or IdentifierArgumentType.identifier(). You can also pass a lambda, as ArgumentType is a functional interface. For simple types, consider using the inline reified version of this function instead.
Adds a new argument to this command. This variant of the argument function allows you to pass and argument which depends on the CommandBuildContext.
the name of the argument - This will be displayed to the player, if there is enough room for the tooltip.
the provider for the ArgumentType - there are predefined types like BlockStateArgument.block(context) and ItemArgument.item(context) or you can pass your own
Adds a new argument to this command. This variant of the argument function you to specifiy the argument parse logic using a Kotlin lambda function (parser).
the name of the argument - This will be displayed to the player, if there is enough room for the tooltip.
gives you a StringReader, which allows you to parse the input of the user - you should return a value of the given type T, which will be the argument value
Adds a new argument to this command. The ArgumentType will be resolved using the reified type T. For a list of supported types, have a look at ArgumentTypeUtils.fromReifiedType, as it is the function used by this builder function.
the name of the argument - This will be displayed to the player, if there is enough room for the tooltip.
Adds a new subcommand / literal to this command.
possible usage:
command("mycommand") {
literal("subcommand") {
// the body of the subcommand
}
}the name of the subcommand
Specifies that the given permission level is required to execute this part of the command tree. A shortcut delegating to requires.
Specifies that the PermissionLevel given as level is required to execute this part of the command tree. A shortcut delegating to requires.
Specifies that the given predicate must return true for the Source in order for it to be able to execute this part of the command tree. Use this function on the root command node to secure the whole command.
Adds execution logic to this command. The place where this function is called matters, as this defines for which path in the command tree this executor should be called.
possible usage:
command("mycommand") {
// defining runs in the body:
runs { }
// calling runs as an infix function directly after literal or argument:
literal("subcommand") runs { }
}Note that this function will always return 1 as the exit code.
Adds custom execution logic to this command. DEPRECATED Use runs instead.
Register this command (client-side).
Set up a callback which automatically registers this command on server startup.
Set up a callback which automatically registers this command on server startup.
Register this command (client-side).
Creates a new client command. Opens a LiteralCommandBuilder. This command will work on the client, even if the player is connected to a third party server.
the name of the root command
if true, the command will automatically be registered
Creates a new client command. Opens a LiteralCommandBuilder. This command will work on the client, even if the player is connected to a third party server.
the name of the root command
if true, the command will automatically be registered
Creates a new command. Opens a LiteralCommandBuilder.
the name of the root command
if true, the command will automatically be registered
Creates a new client command. Opens a LiteralCommandBuilder. This command will work on the client, even if the player is connected to a third party server.
Creates a new client command. Opens a LiteralCommandBuilder. This command will work on the client, even if the player is connected to a third party server.
The core module contains simple, stable and lightweight extensions for some Minecraft classes. It does not use any unstable mixins.
Here you will find an ItemStack builder, position and math utilities, a Text builder and coroutine task functions.
modImplementation("net.axay:fabrikmc-core:1.8.0")The core module contains simple, stable and lightweight extensions for some Minecraft classes. It does not use any unstable mixins.
Here you will find an ItemStack builder, position and math utilities, a Text builder and coroutine task functions.
modImplementation("net.axay:fabrikmc-core:1.8.1")Returns an instance of BlockInfo of the block the entity is currently standing on or swimming in, else it will be the BlockInfo of air - use touchedBlockNoAir if you don't need any info about air.
Returns an instance of BlockInfo of the block the entity is currently standing on or swimming in, else it will be the BlockInfo of air - use touchedBlockNoAir if you don't need any info about air.
Does the same as touchedBlock, but returns null if the block is air.
Does the same as touchedBlock, but returns null if the block is air.
Schedules all necessary updates. Packets will be sent to the players to inform them about the new velocity.
Schedules all necessary updates. Packets will be sent to the players to inform them about the new velocity.
Changes the velocity of this Entity and calls markVelocityDirty.
Whether the velocity should be added to the current one or not. Set this to false if you want to overwrite the previous velocity.
Changes the velocity of this Entity using the given mutation logic in block. After that, markVelocityDirty is called.
Sets the Entitys velocity to vec and calls markVelocityDirty.
Changes the velocity of this Entity and calls markVelocityDirty.
Whether the velocity should be added to the current one or not. Set this to false if you want to overwrite the previous velocity.
Changes the velocity of this Entity using the given mutation logic in block. After that, markVelocityDirty is called.
Sets the Entitys velocity to vec and calls markVelocityDirty.
Does the same as touchedBlock, but returns null if the block is air.
Does the same as touchedBlock, but returns null if the block is air.
Returns an instance of BlockInfo of the block the entity is currently standing on or swimming in, else it will be the BlockInfo of air - use touchedBlockNoAir if you don't need any info about air.
Returns an instance of BlockInfo of the block the entity is currently standing on or swimming in, else it will be the BlockInfo of air - use touchedBlockNoAir if you don't need any info about air.
Opens a LiteralTextBuilder to change the custom name of the item stack.
Opens a LiteralTextBuilder to change the custom name of the item stack. See literalText.
Sets the item lore, which is displayed below the display name of the item stack.
Sets the item lore, which is displayed below the display name of the item stack. Each element of the text collection represents one line.
Configures the SkullOwner nbt tag to represent the given player (specified via uuid). The name can be anything, but it should match the actual player name.
A utility function for building complex item stacks with the given amount.
itemStack(Items.FEATHER, amount = 64) {
setCustomName("Cool Feather")
enchant(Enchantments.FIRE_ASPECT, 1)
}Opens a LiteralTextBuilder to change the custom name of the item stack.
Opens a LiteralTextBuilder to change the custom name of the item stack. See literalText.
Sets the item lore, which is displayed below the display name of the item stack.
Sets the item lore, which is displayed below the display name of the item stack. Each element of the text collection represents one line.
Sets the given potion for this ItemStack.
If you want to pass a custom potion, make sure to register it in the potion registry first.
Example usage:
itemStack(Items.POTION) {
setPotion(Potions.HEALING)
}Configures the SkullOwner nbt tag to represent the given player (specified via uuid). The name can be anything, but it should match the actual player name.
skullStack.setSkullPlayer(server.playerList.getPlayerByName("Notch"))Configures the SkullOwner nbt tag to have the given texture. The texture has to be base64 encoded.
You can find a lot of heads with the associated base64 values on minecraft-heads.com.
Optional, you can specify a uuid. This is not necessary if this head is just used because of its texture, but you should specify one if the head is associated with an actual player.
skullStack.setSkullTexture(
texture = "eyJ0ZXh0dXJlcyI6ey...", // base64 encoded texture json (this example is truncated)
uuid = UUID.fromString("069a79f4-44e9-4726-a5be-fca90e38aaf5") // this is optional
)Returns a Deferred<T> which will be completed as soon as the server is starting.
Returns a Deferred<T> which will be completed as soon as the server is starting.
Returns a Deferred<T> which will be completed as soon as the server is starting.
Returns a Deferred<T> which will be completed as soon as the server is starting.
A CoroutineDispatcher which executes code synchronously to the net.minecraft.server.MinecraftServer main server thread.
A CoroutineDispatcher which executes code synchronously to the net.minecraft.server.MinecraftServer main server thread.
A CoroutineScope using the current net.minecraft.server.MinecraftServer as the CoroutineDispatcher.
A CoroutineScope using the current net.minecraft.server.MinecraftServer as the CoroutineDispatcher.
Returns a Deferred<T> which will be completed as soon as the server is starting.
Returns a Deferred<T> which will be completed as soon as the server is starting.
Returns a Deferred<T> which will be completed as soon as the server is starting.
Returns a Deferred<T> which will be completed as soon as the server is starting.
A CoroutineDispatcher which executes code synchronously to the net.minecraft.server.MinecraftServer main server thread.
A CoroutineDispatcher which executes code synchronously to the net.minecraft.server.MinecraftServer main server thread.
A CoroutineScope using the current net.minecraft.server.MinecraftServer as the CoroutineDispatcher.
A CoroutineScope using the current net.minecraft.server.MinecraftServer as the CoroutineDispatcher.
Adds an empty line.
Adds a line break.
Append text to the parent.
the raw text (without formatting)
if true, this text will inherit the style from its parent
the builder which can be used to set the style and add child text components
Append text to the parent.
the text instance
if true, this text will inherit the style from its parent
the builder which can be used to set the style and add child text components
Opens a LiteralTextBuilder and sends the resulting TextComponent to each player on the server.
Opens a LiteralTextBuilder and sends the resulting TextComponent to each player on the server.
Opens a LiteralTextBuilder and sends the resulting TextComponent to each player on the server.
Opens a LiteralTextBuilder and sends the resulting TextComponent to each player on the server.
Sends the given Component to each player on the server.
Sends the given Component to the player.
Opens a LiteralTextBuilder and sends the resulting TextComponent to the player.
Sends the given Component to each player on the server.
Sends the given Component to the player.
Opens a LiteralTextBuilder and sends the resulting TextComponent to the player.
Sends the given Component to the player.
Opens a LiteralTextBuilder and sends the resulting TextComponent to the player.
Sends the given Component to each player on the server.
Sends the given Component to the player.
Opens a LiteralTextBuilder and sends the resulting TextComponent to the player.
Sends the given Component to each player on the server.
The current MinecraftServer server instance.
The current MinecraftServer server instance.
The current MinecraftServer server instance.
The current MinecraftServer server instance.
Several utilities not fitting for the core module. They can be useful for mini-games, challenges and more - most likely on the server-side.
modImplementation("net.axay:fabrikmc-game:1.8.0")Several utilities not fitting for the core module. They can be useful for mini-games, challenges and more - most likely on the server-side.
modImplementation("net.axay:fabrikmc-game:1.8.1")Executes the given blockif the entity currently does not have this cooldown. If the block is executed, this function will call applyCooldown. After the given delay, the cooldown will be removed automatically.
Executes the given blockif the entity currently does not have this cooldown. If the block is executed, this function will call applyCooldown. After the given delay, the cooldown will be removed automatically.
The Inventory GUI (igui in short) provides a high level server-side GUI API. You build the GUI using a custom and easy-to-use builder DSL.
The GUI rerenders automatically if the state changes, it provides animations and "compounds" which are an easy-to-use abstraction for listing a lot of elements of the same type.
modImplementation("net.axay:fabrikmc-igui:1.8.0")The igui function opens up a new gui builder. Use the page function to add a new page to this gui, you can that function as often as you want.
igui(GuiType.NINE_BY_SIX, "My cool gui".literal, defaultPageKey = 1) {
page(1) {
// access to the page builder inside here
}
}The page builder is the most important part of the gui dsl. Inside this builder, you have access all functions adding elements to the gui.
The Inventory GUI (igui in short) provides a high level server-side GUI API. You build the GUI using a custom and easy-to-use builder DSL.
The GUI rerenders automatically if the state changes, it provides animations and "compounds" which are an easy-to-use abstraction for listing a lot of elements of the same type.
modImplementation("net.axay:fabrikmc-igui:1.8.1")The igui function opens up a new gui builder. Use the page function to add a new page to this gui, you can that function as often as you want.
igui(GuiType.NINE_BY_SIX, "My cool gui".literal, defaultPageKey = 1) {
page(1) {
// access to the page builder inside here
}
}The page builder is the most important part of the gui dsl. Inside this builder, you have access all functions adding elements to the gui.
Provides NBT serialization and deserialization using kotlinx.serialization. Additionally, this module contains some NBT utilities, like simple conversion extensions.
modImplementation("net.axay:fabrikmc-nbt:1.8.0")You can serialize any class annotated with @Serializable to an net.minecraft.nbt.NbtElement.
Nbt.encodeToNbtElement(value)In the same way it is possible deserialize any net.minecraft.nbt.NbtElement containing the correct entries to a serializable class.
Nbt.decodeFromNbtElement(nbtElement)You can configure the Nbt instance in the following way:
val nbt = Nbt {
encodeDefaults = true // false by default
ignoreUnknownKeys = false // true by default
}An NBT DSL is also available. The DSL supports normal key value pairs, compounds and nbt lists.
nbtCompound {
put("x", 6)
put("y", 21)
put("name", "Peter")
list("stringList", listOf("jo", "yes"))
longArray("longSet", setOf(3L, 8L))
compound("inner") {
put("test", true)
}
}Extension functions to convert Kotlin basic types to net.minecraft.nbt.NbtElements are available as well
1.toNbt(); true.toNbt(); IntArray(3) { it }.toNbt()
// etcYou can modify an net.minecraft.nbt.NbtCompound using the provided operator functions
nbtCompound["myint"] = 3
nbtCompound["coolboolean"] = falseProvides NBT serialization and deserialization using kotlinx.serialization. Additionally, this module contains some NBT utilities, like simple conversion extensions.
modImplementation("net.axay:fabrikmc-nbt:1.8.1")You can serialize any class annotated with @Serializable to an net.minecraft.nbt.NbtElement.
Nbt.encodeToNbtElement(value)In the same way it is possible deserialize any net.minecraft.nbt.NbtElement containing the correct entries to a serializable class.
Nbt.decodeFromNbtElement(nbtElement)You can configure the Nbt instance in the following way:
val nbt = Nbt {
encodeDefaults = true // false by default
ignoreUnknownKeys = false // true by default
}An NBT DSL is also available. The DSL supports normal key value pairs, compounds and nbt lists.
nbtCompound {
put("x", 6)
put("y", 21)
put("name", "Peter")
list("stringList", listOf("jo", "yes"))
longArray("longSet", setOf(3L, 8L))
compound("inner") {
put("test", true)
}
}Extension functions to convert Kotlin basic types to net.minecraft.nbt.NbtElements are available as well
1.toNbt(); true.toNbt(); IntArray(3) { it }.toNbt()
// etcYou can modify an net.minecraft.nbt.NbtCompound using the provided operator functions
nbtCompound["myint"] = 3
nbtCompound["coolboolean"] = falseBuilder class for an NBT list.
ListTag determines its type from the first element added, all following elements are required to have the same type, otherwise an UnsupportedOperationException is thrown.
Builder class for an NBT list.
ListTag determines its type from the first element added, all following elements are required to have the same type, otherwise an UnsupportedOperationException is thrown.
Build an NBT compound.
Build an NBT compound.
Build an NBT list.
Build an NBT list.
Build an NBT compound.
Build an NBT compound.
Build an NBT list.
Build an NBT list.
Encodes the given value to an Tag. If the given value of the type T can be represented by a primitive NbtElement, such an element will be the result of this function. Otherwise, an net.minecraft.nbt.CompoundTag will be created.
Encodes the given value to an Tag. If the given value of the type T can be represented by a primitive NbtElement, such an element will be the result of this function. Otherwise, an net.minecraft.nbt.CompoundTag will be created.
Encodes the given value to an Tag. If the given value of the type T can be represented by a primitive NbtElement, such an element will be the result of this function. Otherwise, an net.minecraft.nbt.CompoundTag will be created.
Encodes the given value to an Tag. If the given value of the type T can be represented by a primitive NbtElement, such an element will be the result of this function. Otherwise, an net.minecraft.nbt.CompoundTag will be created.
Encodes the given value to an Tag. If the given value of the type T can be represented by a primitive NbtElement, such an element will be the result of this function. Otherwise, an net.minecraft.nbt.CompoundTag will be created.
Encodes the given value to an Tag. If the given value of the type T can be represented by a primitive NbtElement, such an element will be the result of this function. Otherwise, an net.minecraft.nbt.CompoundTag will be created.
Send any serializable class as a packet - using kotlinx.serialization. Provides utilities for sending and receiving packets.
modImplementation("net.axay:fabrikmc-network:1.8.0")You have to create a serializable class representing your packet first.
@Serializable
data class Person(val name: String, val age: Int)Create a packet definition instance, this class holds information about the packet type and the packet id, and provides you with functions for sending and receiving packets.
Use the s2cPacket function.
val personPacket = s2cPacket<Person>(Identifier("mymod", "personpacket"))Use the c2sPacket function.
val personPacket = c2sPacket<Person>(Identifier("mymod", "personpacket"))Once you have packet definition instance, you can send packets.
Send to a specific player:
personPacket.send(Person("John", 21), player)Send to all players:
personPacket.sendToAll(Person("Maria", 21))personPacket.send(Person("Holger", 52))Using the packet instance, you can also register a packet receiver.
This can be done using the receiveOnClient or receiveOnServer function.
personPacket.receiveOnClient { packet, context ->
println(packet)
}personPacket.receiveOnServer { packet, context ->
println(packet)
}Send any serializable class as a packet - using kotlinx.serialization. Provides utilities for sending and receiving packets.
modImplementation("net.axay:fabrikmc-network:1.8.1")You have to create a serializable class representing your packet first.
@Serializable
data class Person(val name: String, val age: Int)Create a packet definition instance, this class holds information about the packet type and the packet id, and provides you with functions for sending and receiving packets.
Use the s2cPacket function.
val personPacket = s2cPacket<Person>(Identifier("mymod", "personpacket"))Use the c2sPacket function.
val personPacket = c2sPacket<Person>(Identifier("mymod", "personpacket"))Once you have packet definition instance, you can send packets.
Send to a specific player:
personPacket.send(Person("John", 21), player)Send to all players:
personPacket.sendToAll(Person("Maria", 21))personPacket.send(Person("Holger", 52))Using the packet instance, you can also register a packet receiver.
This can be done using the receiveOnClient or receiveOnServer function.
personPacket.receiveOnClient { packet, context ->
println(packet)
}personPacket.receiveOnServer { packet, context ->
println(packet)
}Allows you to persistently store any (serializable) data on chunks, entities (including players), worlds and more.
If the component is currently loaded, the data is kept in memory as well for faster access.
modImplementation("net.axay:fabrikmc-persistence:1.8.0")A compound key is required to write and write values to a persistent compound. These read and write operations can then happen type-safe thanks to the compound key.
Such a key can be created in the following way:
val personKey = compoundKey<Person>(identifier)Note: Person must be serializable here
There are other compound key types:
nbtElementCompoundKey for storing NbtElements, as they don't have to (and cannot) be serialized
customCompoundKey for defining custom serialization logic (object to net.minecraft.nbt.NbtElement), for example if the class you are storing is not serializable, or if it is significantly faster than the built in NBT serialization of fabrikmc-nbt
A compound can be retrieved from any compound provider, currently these are net.minecraft.world.chunk.Chunk, net.minecraft.entity.Entity and net.minecraft.world.World.
For easy access, use the provider.persistentCompound extension value:
chunk.persistentCompound
entity.persistentCompound
world.persistentCompoundCurrently, persistent compounds are not thread safe, you should only modify them on the main game / server thread.
You can write to a compound using the index operator.
with(chunk.persistentCompound) {
it[personKey] = Person("John", 32, "France")
}You can read from a compound using the index operator.
with(chunk.persistentCompound) {
val person = it[personKey]
// and then do something with it
log.info(person.toString())
}Compounds offer more functions for more specific operations, see PersistentCompound for a list of these functions.
Allows you to persistently store any (serializable) data on chunks, entities (including players), worlds and more.
If the component is currently loaded, the data is kept in memory as well for faster access.
modImplementation("net.axay:fabrikmc-persistence:1.8.1")A compound key is required to write and write values to a persistent compound. These read and write operations can then happen type-safe thanks to the compound key.
Such a key can be created in the following way:
val personKey = compoundKey<Person>(identifier)Note: Person must be serializable here
There are other compound key types:
nbtElementCompoundKey for storing NbtElements, as they don't have to (and cannot) be serialized
customCompoundKey for defining custom serialization logic (object to net.minecraft.nbt.NbtElement), for example if the class you are storing is not serializable, or if it is significantly faster than the built in NBT serialization of fabrikmc-nbt
A compound can be retrieved from any compound provider, currently these are net.minecraft.world.chunk.Chunk, net.minecraft.entity.Entity and net.minecraft.world.World.
For easy access, use the provider.persistentCompound extension value:
chunk.persistentCompound
entity.persistentCompound
world.persistentCompoundCurrently, persistent compounds are not thread safe, you should only modify them on the main game / server thread.
You can write to a compound using the index operator.
with(chunk.persistentCompound) {
it[personKey] = Person("John", 32, "France")
}You can read from a compound using the index operator.
with(chunk.persistentCompound) {
val person = it[personKey]
// and then do something with it
log.info(person.toString())
}Compounds offer more functions for more specific operations, see PersistentCompound for a list of these functions.
Creates a CompoundKey which can be used to read and write data to a PersistentCompound in a typesafe way.
Creates a CompoundKey which can be used to read and write data to a PersistentCompound in a typesafe way.
Returns a persistent PersistentCompound.
Returns a persistent PersistentCompound.
Returns a persistent PersistentCompound.
Returns a persistent PersistentCompound.
Returns a persistent PersistentCompound.
Returns a persistent PersistentCompound.
Creates a CompoundKey which can be used to read and write data to a PersistentCompound in a typesafe way.
This compound key is meant specifically for values of the type Tag. These can be treated differently, as they don't have to be converted or serialized.
the unique identifier for this key, this should contain your mod id
Creates a CompoundKey which can be used to read and write data to a PersistentCompound in a typesafe way.
This compound key is meant specifically for values of the type Tag. These can be treated differently, as they don't have to be converted or serialized.
the unique identifier for this key, this should contain your mod id
Returns a persistent PersistentCompound.
Returns a persistent PersistentCompound.