Forge Community Wiki

https://forge.gemwire.uk/wiki
Admin
The Forge Community Wiki is a community-driven resource hub for Minecraft Forge.
Tokens:241,256
Snippets:3,732
Trust Score:6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Create Page (Getting Started Category)

Source: https://forge.gemwire.uk/wiki/Special%3ALog/Curle

Logs the creation of a category page for beginners.

```text
For absolute beginners who need an introduction to the whole system. Important information is split up across the subcategories for those who need help with the less commonly...
```

--------------------------------

### Example mods.toml Configuration

Source: https://forge.gemwire.uk/wiki/Mods.toml

This is a complete example of a mods.toml file, demonstrating the structure for mod-specific properties and dependencies.

```toml
modLoader="javafml"
# Forge for 1.19 is version 41
loaderVersion="[41,)"
license="All rights reserved"
issueTrackerURL="github.com/MinecraftForge/MinecraftForge/issues"
showAsResourcePack=false

[[mods]]
    modId="examplemod"
    version="1.0.0.0"
    displayName="Example Mod"
    updateJSONURL="minecraftforge.net/versions.json"
    displayURL="minecraftforge.net"
    logoFile="logo.png"
    credits="I'd like to thank my mother and father."
    authors="Author"
    description='''
Lets you craft dirt into diamonds. This is a traditional mod that has existed for eons. It is ancient. The holy Notch created it. Jeb rainbowfied it. Dinnerbone made it upside down. Etc.
    '''
    displayTest="MATCH_VERSION"

[[dependencies.examplemod]]
    modId="forge"
    mandatory=true
    versionRange="[41,)"
    ordering="NONE"
    side="BOTH"

[[dependencies.examplemod]]
    modId="minecraft"
    mandatory=true
    versionRange="[1.19,1.20)"
    ordering="NONE"
    side="BOTH"

```

--------------------------------

### Comprehensive Config Entry Example

Source: https://forge.gemwire.uk/wiki/Config/1.18

This extensive example showcases various config entry types including integers, doubles, longs, booleans, strings, and lists. It also demonstrates using comments and nested categories for organization.

```java
public static ForgeConfigSpec.IntValue exampleIntConfigEntry;
public static ForgeConfigSpec.DoubleValue exampleDoubleConfigEntry;
public static ForgeConfigSpec.ConfigValue<Double> exampleUnboundedDoubleConfigEntry;
public static ForgeConfigSpec.LongValue exampleLongConfigEntry;
public static ForgeConfigSpec.BooleanValue exampleBooleanConfigEntry;
public static ForgeConfigSpec.ConfigValue<String> exampleStringConfigEntry;
public static ForgeConfigSpec.ConfigValue<List<? extends String>> exampleStringListConfigEntry;

private static void setupConfig(ForgeConfigSpec.Builder builder) {
    builder.comment(" This category holds configs that uses numbers.")
    builder.push("Numeric Config Options");

      exampleIntConfigEntry = builder.defineInRange("example_int_config_entry", 5, 2, 50);
      exampleDoubleConfigEntry = builder.defineInRange("example_double_config_entry", 10D, 0D, 100D);

      exampleUnboundedDoubleConfigEntry = builder
         .comment("This comment will be attached to example_unbounded_double_config_entry in the config file.")
         .define("example_unbounded_double_config_entry", 1000D);

      exampleLongConfigEntry = builder.defineInRange("example_long_config_entry", 4L, -900L, 900L);

    builder.pop();


    builder.comment(" This category holds configs that uses numbers.")
    builder.push("String Config Options");

      exampleStringConfigEntry = builder
         .comment("This config holds a single string.")
         .define("example_string_config_entry", "player444");

      builder.comment(" This category will be nested inside the String Config Options category.")
      builder.push("Nested Category");

        exampleStringListConfigEntry = builder
          .comment("This config entry will hold a list of strings.")

```

--------------------------------

### MCPConfig Mergetool Step Example

Source: https://forge.gemwire.uk/wiki/Toolchain/1.18

Example configuration for the Mergetool step within MCPConfig. It defines the version and arguments required to merge client and server JARs.

```json
{
  "merge": {
    "version": "net.minecraftforge:mergetool:1.1.3:fatjar",
    "args": "--client {client} --server {server} --ann {version} --output {output} --inject false"
  }
}
```

--------------------------------

### Build Project for Visual Studio Code Setup

Source: https://forge.gemwire.uk/wiki/Getting_Started

This command is part of the Visual Studio Code setup process. It should be run before generating VS Code-specific run configurations.

```bash
./gradlew buildNeeded
```

--------------------------------

### Declare Public Method Access (Partial Example)

Source: https://forge.gemwire.uk/wiki/Access_Transformer

Partial example for declaring public method access. The full signature is not provided in the source.

```java
# Makes public the 'leastMostToIntArray' method in UUIDUtil,
```

--------------------------------

### Executing MCPConfig Steps

Source: https://forge.gemwire.uk/wiki/Toolchain/Retro/2.1

Example command for executing a step within MCPConfig. This demonstrates the general format for running tools with their arguments and JVM options.

```bash
java -jar <version> <args> <jvmArgs>
```

--------------------------------

### Example First-Person Item Animation Implementation

Source: https://forge.gemwire.uk/wiki/Custom_Item_Animations

A practical example of implementing first-person item animation using `#applyForgeHandTransform`. This snippet demonstrates translation based on the player's arm and item usage.

```java
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
    consumer.accept(new IClientItemExtensions() {
        @Override
         public boolean applyForgeHandTransform(PoseStack poseStack, LocalPlayer player, HumanoidArm arm, ItemStack itemInHand, float partialTick, float equipProcess, float swingProcess) {
            int i = arm == HumanoidArm.RIGHT ? 1 : -1;
            poseStack.translate(i * 0.56F, -0.52F, -0.72F);
             if (player.getUseItem() == itemInHand && player.isUsingItem()) {
                poseStack.translate(0.0, -0.05, 0.0);
            }
            return true;
        }
    });
}
```

--------------------------------

### MCPConfig Fernflower Step Example

Source: https://forge.gemwire.uk/wiki/Toolchain/1.18

Example configuration for the Fernflower decompiler step within MCPConfig. It specifies the version, arguments, and JVM arguments for the decompiler.

```json
{
  "fernflower": {
    "version": "net.minecraftforge:forgeflower:1.5.498.12",
    "args": "-din=1 -rbr=1 -dgs=1 -asc=1 -rsy=1 -iec=1 -jvn=1 -isl=0 -iib=1 -log=TRACE -cfg {libraries} {input} {output}",
    "jvmargs": "-Xmx4G"
  }
}
```

--------------------------------

### Declare Public Method (Partial Example)

Source: https://forge.gemwire.uk/wiki/ATs

Partial example of declaring a public method. The '#' character denotes comments.

```java
# Makes public the 'leastMostToIntArray' method in UUIDUtil,

```

--------------------------------

### Example Log Entry: User Account Creation

Source: https://forge.gemwire.uk/wiki/Special%3ALog/KnightMiner

Shows a log entry detailing the creation of a user account, including the username and the date of creation.

```text
03:54, 23 February 2021 User account KnightMiner talk contribs was created
```

--------------------------------

### MCPConfig Rename Step Example

Source: https://forge.gemwire.uk/wiki/Toolchain/1.18

Example configuration for the Rename step within MCPConfig. This snippet details the arguments for processing JAR files with specific mapping formats and decompiler configurations.

```json
{
  "rename": {
    "version": "net.minecraftforge.lex:vignette:0.2.0.10",
    "args": "--jar-in {input} --jar-out {output} --mapping-format tsrg2 --mappings {mappings} --fernflower-meta --cfg {libraries} --create-inits --fix-param-annotations"
  }
}
```

--------------------------------

### Example mods.toml Configuration

Source: https://forge.gemwire.uk/wiki/User%3ASciWhiz12/sandbox/structure

This is a basic configuration for a mods.toml file, essential for mod identification and loader information.

```toml
modLoader="javafml"

```

--------------------------------

### Batch Setup and Teardown Methods

Source: https://forge.gemwire.uk/wiki/Game_Tests/1.18

Methods annotated with @BeforeBatch or @AfterBatch to perform setup or teardown for a specific test batch. The batch name must match the GameTest's batch attribute.

```java
public class ExampleGameTests {
  @BeforeBatch(batch = "firstBatch")
  public static void beforeTest(ServerLevel level) {
    // Perform setup
  }

  @GameTest(batch = "firstBatch")
  public static void exampleTest2(GameTestHelper helper) {
    // Do stuff
  }
}
```

--------------------------------

### Building a Loot Pool and Loot Table

Source: https://forge.gemwire.uk/wiki/Datageneration/Loot_Tables

Example demonstrating how to construct a LootPool with multiple entries and functions, and then incorporate it into a LootTable.

```java
LootPool.Builder poolBuilder = LootPool.lootPool()
    .name(...)
    .setRolls(...)
    .add(LootItem.lootTableItem(...)
        .apply(function1)
        .apply(function2)
            .when(condition1)
            .when(condition2))
    );
LootTable.Builder tableBuilder = LootTable.lootTable().withPool(poolBuilder);
```

--------------------------------

### Executing the Extract Action

Source: https://forge.gemwire.uk/wiki/User_talk%3APaint_Ninja/Installer

This demonstrates how to execute the action obtained from the Actions enum, passing the install profile and monitor. The result indicates success or failure.

```java
action.getAction(installProfile, monitor).run(target, a -> true)
```

--------------------------------

### New Page Creation Example

Source: https://forge.gemwire.uk/wiki/Special%3AContributions/CrynesSs

This snippet shows the initial HTML content for a newly created page titled 'Saplings', including a header and introductory text for a tutorial.

```html
<div class="header"> <h1>Saplings</h1> <p>How to create Saplings in Forge 1.16.4</p> </div> Let's start with a basic example by extending SaplingBlock.First create a class...
```

--------------------------------

### MCInjector Command Example

Source: https://forge.gemwire.uk/wiki/Toolchain/Retro/2.1/1.17

This command demonstrates how MCInjector is executed with specific arguments to process input files, apply logging levels, and handle exceptions.

```bash
java -jar de.oceanlabs.mcp:mcinjector:3.8.0:fatjar --in {input} --out {output} --log {log} --level=INFO --lvt=LVT --exc {exceptions} --acc {access} --ctr {constructors}
```

--------------------------------

### MergeTool Command Example

Source: https://forge.gemwire.uk/wiki/Toolchain/Retro/2.1/1.17

This command illustrates the usage of MergeTool to combine client and server code with version annotations, specifying the output path and injection behavior.

```bash
java -jar net.minecraftforge:mergetool:1.1.1:fatjar --client {client} --server {server} --ann {version} --output {output} --inject false
```

--------------------------------

### Example mods.toml File Structure

Source: https://forge.gemwire.uk/wiki/Mods.toml/1.18

This TOML file configures mod loader, versioning, license, and displays mod information. It includes sections for mod-specific properties and dependencies.

```toml
modLoader="javafml"
# Forge for 1.18.2 is version 40
loaderVersion="[40,)"
license="All rights reserved"
issueTrackerURL="github.com/MinecraftForge/MinecraftForge/issues"
showAsResourcePack=false

[[mods/1.18|mods]]
    modId="examplemod"
    version="1.0.0.0"
    displayName="Example Mod"
    updateJSONURL="minecraftforge.net/versions.json"
    displayURL="minecraftforge.net"
    logoFile="logo.png"
    credits="I'd like to thank my mother and father."
    authors="Author"
    description='''
Lets you craft dirt into diamonds. This is a traditional mod that has existed for eons. It is ancient. The holy Notch created it. Jeb rainbowfied it. Dinnerbone made it upside down. Etc.
    '''

[[dependencies.examplemod/1.18|dependencies.examplemod]]
    modId="forge"
    mandatory=true
    versionRange="[40,)"
    ordering="NONE"
    side="BOTH"

[[dependencies.examplemod/1.18|dependencies.examplemod]]
    modId="minecraft"
    mandatory=true
    versionRange="[1.18.2,1.19)"
    ordering="NONE"
    side="BOTH"

```

--------------------------------

### SpecialSource Command Example

Source: https://forge.gemwire.uk/wiki/Toolchain/Retro/2.1/1.17

This command demonstrates how SpecialSource is used to rename input JARs to output JARs using provided mappings, specifying the input and output files.

```bash
java -jar net.md-5:SpecialSource:1.8.3:shaded --in-jar {input} --out-jar {output} --srg-in {mappings}
```

--------------------------------

### Fence Connection Variant Example

Source: https://forge.gemwire.uk/wiki/BlockState_JSONs

An example of a single variant string for a fence connection, specifying model and rotation.

```json
"east=true,north=false,south=false,west=false": { "model": "oak_fence_n", "y": 90, "uvlock": true }
```

--------------------------------

### Example JSON for Registry Dispatch

Source: https://forge.gemwire.uk/wiki/Codecs/1.18

This JSON structure demonstrates how a 'type' field is used to identify the specific codec for a 'Thing' object within a registry dispatch system. It shows an example of an 'ExampleCodecClass' instance.

```json
"some_thing":
{
	"type": "ourmod:exampleclass",
	"some_int": 42,
	"item": "minecraft:gold_ingot",
	"block_positions":
	[
		[0,0,0],
		[10,20,-100]
	]
}
```

--------------------------------

### Example Log Entry: Page Creation

Source: https://forge.gemwire.uk/wiki/Special%3ALog/KnightMiner

Illustrates a typical log entry for a page creation event, showing the performer, action, and the content of the created page.

```text
18:09, 10 May 2021 KnightMiner talk contribs created page User:KnightMiner (Created page with "== Subpages == {{Special:PrefixIndex/User:KnightMiner/|stripprefix=1}}")
```

```text
00:53, 9 March 2021 KnightMiner talk contribs created page User:KnightMiner/Tag Standards/common (Created page with "| <code>{{{id|{{#replace: {{lc:Hello World}} || _ }}}}}</code> | {{{1}}} | {{{2|}}} |- ")
```

```text
00:50, 9 March 2021 KnightMiner talk contribs created page User:KnightMiner/Sandbox (Created page with "This page is just a convenient way for me to test wiki syntax. __NEWSECTIONLINK__")
```

```text
03:57, 8 March 2021 KnightMiner talk contribs created page User:KnightMiner/Tag Standards (Created page with "This page details standardized tag names for compatibility among modders. The following subsections give specific information on where the tags are used. == Materials == Mat...")
```

--------------------------------

### Subclassing BlockTagsProvider

Source: https://forge.gemwire.uk/wiki/Datageneration/Tags

Example of how to create a custom block tag provider by extending BlockTagsProvider and implementing the addTags method.

```Java
public class ExampleBlockTagsProvider extends BlockTagsProvider {
    
    public ExampleBlockTagsProvider(DataGenerator gen, String modId, ExistingFileHelper efh) {
        // ...
    }

    @Override
    public void addTags() {
        // Add block tags here
    }
}
```

--------------------------------

### Using FriendlyByteBuf Code Example

Source: https://forge.gemwire.uk/wiki/Special%3ALog/Unbekannt

This snippet demonstrates the basic concept of PacketBuffers, which are used for network synchronization. It highlights their byte array nature and queue-like operation.

```html
<code>PacketBuffer</code>s are essentially a byte array of zero or more bytes to sync information across a network. It works similarly to a queue: the information is written i...
```

--------------------------------

### Java Tab Example

Source: https://forge.gemwire.uk/wiki/User%3ASciWhiz12/sandbox/codetabs/test

This is a placeholder comment for a Java code snippet within a tab.

```java
// Testing the Java tab
```

--------------------------------

### Groovy Tab Example

Source: https://forge.gemwire.uk/wiki/User%3ASciWhiz12/sandbox/codetabs/test

This is a placeholder comment for a Groovy code snippet within a tab.

```groovy
// Testing the Groovy tab
```

--------------------------------

### Fernflower Command Example

Source: https://forge.gemwire.uk/wiki/Toolchain/Retro/2.1/1.17

This command shows the execution of Fernflower for decompilation, with arguments controlling various aspects of the process, including input and output paths.

```bash
java -jar net.minecraftforge:forgeflower:1.5.478.16 -din=1 -rbr=1 -dgs=1 -asc=1 -rsy=1 -iec=1 -jvn=1 -isl=0 -iib=1 -log=TRACE -cfg {libraries} {input} {output}
```

--------------------------------

### Example JSON Structure for a Class Instance

Source: https://forge.gemwire.uk/wiki/Codec

This JSON represents an instance of ExampleCodecClass, showing how the fields are structured.

```json
{
	"some_int": 42,
	"item": "minecraft:gold_ingot",
	"block_positions":
	[
		[0,0,0],
		[10,20,-100]
	]
}
```

--------------------------------

### Instantiating ExtractAction

Source: https://forge.gemwire.uk/wiki/User_talk%3APaint_Ninja/Installer

This shows how to get an instance of the EXTRACT action from the Actions enum.

```java
final Actions action = Actions.EXTRACT;
```

--------------------------------

### Direct HolderSet Examples

Source: https://forge.gemwire.uk/wiki/HolderSet

Defines Direct HolderSets using single elements or lists of elements in JSON.

```json
{
  "a_biome": "desert", // single element holderset
  "some_biomes": ["plains", "forest"], // list holderset
}
```

--------------------------------

### Shaped Crafting Recipe Example

Source: https://forge.gemwire.uk/wiki/Recipes/1.18

A basic shaped crafting recipe using a pattern and key to define item placement. The result specifies the output item and count.

```json
{
    "type": "minecraft:crafting_shaped",
    "pattern":
    [
        "XXX",
        "XAX",
        "XXX"
    ],
    "key":
    {
        "X":
        {
            "tag": "forge:gems/diamond"
        },
        "A":
        {
            "item": "mymod:myfirstitem"
        }
    },
    "result":
    {
        "item": "mymod:myseconditem",
        "count": 9
    }
}
```

--------------------------------

### Example Code References in User Talk

Source: https://forge.gemwire.uk/wiki/Special%3AContributions/Paint_Ninja

This entry references specific Java files and code snippets within a user talk page edit. It highlights the use of 'Actions.java', 'Action.java', 'ClientInstall/ServerInstall/ExtractAction.java', and 'ExtractAction'.

```text
see <code>Actions.java</code>, <code>Action.java</code>, <code>ClientInstall/ServerInstall/ExtractAction.java</code> example with <code>ExtractAction</code>: <code>final Acti...
```

--------------------------------

### Multipart Fence Connection Example

Source: https://forge.gemwire.uk/wiki/BlockState_JSONs

Defines a fence connection model that applies when the 'east' property is true.

```json
{
  "when":  { "east": "true" },
  "apply": { "model": "minecraft:block/oak_fence_side", "y": 90, "uvlock": true }
}
```

--------------------------------

### Shapeless Crafting Recipe Ingredients

Source: https://forge.gemwire.uk/wiki/Recipes/1.18

An example of an ingredients list for a shapeless crafting recipe. It specifies the items required for the crafting process.

```json
"ingredients": [
        {
            "tag": "forge:gems/diamond"
        },
        {
            "item": "minecraft:nether_star"
        }
    ],
```

--------------------------------

### ExampleCodecClass Codec using RecordCodecBuilder

Source: https://forge.gemwire.uk/wiki/Codecs/1.18

This example demonstrates creating a codec for `ExampleCodecClass` using `RecordCodecBuilder`, mapping JSON fields to Java class fields and its constructor. It uses `Codec.INT`, `Registry.ITEM`, and a list codec for `BlockPos`.

```java
public static final Codec<ExampleCodecClass> = RecordCodecBuilder.create(instance -> instance.group(
		Codec.INT.fieldOf("some_int").forGetter(ExampleCodecClass::getSomeInt),
		Registry.ITEM.fieldOf("item").forGetter(ExampleCodecClass::getItem),
		BlockPos.CODEC.listOf().fieldOf("block_positions").forGetter(ExampleCodecClass::getBlockPositions)
	).apply(instance, ExampleCodecClass::new));
```

--------------------------------

### Example Language File Structure

Source: https://forge.gemwire.uk/wiki/Internationalization/1.16

Defines translation keys and their corresponding displayable text for a specific locale. This JSON file should be placed in `assets/[namespace]/lang/[locale].json` and encoded in UTF-8.

```json
{
  "item.examplemod.example_item": "Example Item Name",
  "block.examplemod.example_block": "Example Block Name",
  "commands.examplemod.example_command.error": "Example Command Errored!"
}
```

--------------------------------

### Registering a Fluid Interaction

Source: https://forge.gemwire.uk/wiki/User%3AChampionAsh5357/Sandbox/Fluids_API

Register a custom fluid interaction with the FluidInteractionRegistry. This example shows how a test fluid interacts with lava, replacing it with a gold block.

```java
private void commonSetup(FMLCommonSetupEvent event) {
   // Test Fluid + Lava (source/flowing) -> Gold Block (Test fluid source/flowing gets replaced)
   FluidInteractionRegistry.addInteraction(TEST_FLUID_TYPE.get(), new FluidInteractionRegistry.InteractionInformation(ForgeMod.LAVA_TYPE.get(), Blocks.GOLD_BLOCK.defaultBlockState()));

}
```

--------------------------------

### Implement Capability Provider

Source: https://forge.gemwire.uk/wiki/Capability/1.18

Example implementation of a capability provider exposing an IItemHandler capability. Access is restricted to UP and DOWN directions. The capability is automatically invalidated when the provider is invalidated.

```java
// suppose the presence of a field 'inventory' of type 'IItemHandler'

private final LazyOptional<IItemhandler> inventoryOptional = LazyOptional.of(() -> this.inventory);

@Override
public <T> LazyOptional<T> getCapability(Capability<T> capability, @Nullable Direction direction) {
    if (capability == CapabilityItemHandler.ITEM_HANDLER_CAPABILITY
            && (direction == null || direction == Direction.UP || direction == Direction.DOWN)) {
        return this.inventoryOptional.cast();
    }
    return super.getCapability(capability, direction); // See note after snippet
}

@Override
protected void invalidateCaps() {
    super.invalidateCaps();
    this.inventoryOptional.invalidate();
}
```

--------------------------------

### Exclude Dependency Example

Source: https://forge.gemwire.uk/wiki/Jar-in-Jar

Excludes dependencies based on a pattern. This example excludes any dependency whose group name starts with 'com.google.gson.'.

```gradle
dependencies {
    exclude(dependency('com.google.gson.*')) 
}
```

--------------------------------

### Configured Game Test Method

Source: https://forge.gemwire.uk/wiki/Game_Tests/1.18

The `@GameTest` annotation can be configured with parameters like `setupTicks` for setup duration and `required` to determine if test failure impacts batch execution.

```java
@GameTest(
  setupTicks = 20L, // The test spends 20 ticks to set up for execution
  required = false // The failure is logged but does not affect the execution of the batch
)
public static void exampleConfiguredTest(GameTestHelper helper) {
  // Do stuff
}
```

--------------------------------

### Registering a Custom Display Test (Kotlin)

Source: https://forge.gemwire.uk/wiki/Sides

Register a custom IExtensionPoint.DisplayTest to manage how mod absence on the network side is handled. This example ensures the client ignores an absent server mod.

```kotlin
// Make sure the mod being absent on the other network side does not cause the client to display the server as incompatible
ModLoadingContext.get().registerExtensionPoint(IExtensionPoint.DisplayTest.class) { IExtensionPoint.DisplayTest(Supplier { NetworkConstants.IGNORESERVERONLY }, BiPredicate { _: String, _: Boolean -> true }) }
```

--------------------------------

### Generate Eclipse Project Files for VS Code

Source: https://forge.gemwire.uk/wiki/Getting_Started

This command is part of the Visual Studio Code setup process. It generates necessary files for Eclipse compatibility, which can be leveraged by VS Code.

```bash
./gradlew eclipse
```

--------------------------------

### Kotlin Hello World

Source: https://forge.gemwire.uk/wiki/User%3AChampionAsh5357/Test

Standard Kotlin entry point for a console application.

```kotlin
fun main(args : Array<String>) {
    println("Hello world!")
}
```

--------------------------------

### MCPConfig Parsing Rules

Source: https://forge.gemwire.uk/wiki/Toolchain

Rules used by ForgeGradle to interpret the config.json for MCP setup. Steps are executed in order, with versions as maven coordinates and arguments supporting variable substitution.

```text
* Every key, except for libraries, is interpreted as the name of a step.
* Steps are executed in order.
* The version value is interpreted as a maven coordinate of a file to download.
* If there is a repo value, it is used instead of the maven repositories defined in the buildscript, to retrieve the version.
* The args array is parsed, and {values} like this are interpreted as inputs, which can be substituted accordingly.
* Once the step is all parsed in, it is executed:
    * java -jar <version> <args> <jvmArgs>
```

--------------------------------

### Scala Hello World

Source: https://forge.gemwire.uk/wiki/User%3AChampionAsh5357/Test

Standard Scala entry point for a console application.

```scala
def main(args: Array[String]): Unit = {
    println("Hello, world!")
}
```

--------------------------------

### Registering a Custom Display Test (Java)

Source: https://forge.gemwire.uk/wiki/Sides

Register a custom IExtensionPoint.DisplayTest to manage how mod absence on the network side is handled. This example ensures the client ignores an absent server mod.

```java
// Make sure the mod being absent on the other network side does not cause the client to display the server as incompatible
ModLoadingContext.get().registerExtensionPoint(IExtensionPoint.DisplayTest.class, () -> new IExtensionPoint.DisplayTest(() -> NetworkConstants.IGNORESERVERONLY, (a, b) -> true));
```

--------------------------------

### Custom Biome Modifier JSON Example

Source: https://forge.gemwire.uk/wiki/Biome_Modifiers

Example of a custom biome modifier JSON that adds a feature to badlands biomes. Ensure the 'type' matches your registered codec.

```json
{
  "type": "yourmodid:example",
  "biomes": "#minecraft:is_badlands",
  "feature": "yourmod:some_feature"
}
```

--------------------------------

### Example Profiling Result Structure

Source: https://forge.gemwire.uk/wiki/Debug_Profiler

This snippet shows the hierarchical structure of data captured by the Debug Profiler, indicating time spent in different game systems. It's useful for understanding how to read the output files.

```text
[00] levels - 96.70%/96.70%
[01] |   Level Name - 99.76%/96.47%
[02] |   |   tick - 99.31%/95.81%
[03] |   |   |   entities - 47.72%/45.72%
[04] |   |   |   |   regular - 98.32%/44.95%
[04] |   |   |   |   blockEntities - 0.90%/0.41%
[05] |   |   |   |   |   unspecified - 64.26%/0.26%
[05] |   |   |   |   |   minecraft:furnace - 33.35%/0.14%
[05] |   |   |   |   |   minecraft:chest - 2.39%/0.01%
```

--------------------------------

### Serialize and Deserialize with Codecs

Source: https://forge.gemwire.uk/wiki/Codecs/1.18

Demonstrates how to use Codec#encodeStart to serialize Java objects to Tag or JsonElement, and Codec#parse to deserialize them back. Requires a Codec instance and a DynamicOps instance.

```java
DataResult<Tag> result = someCodec.encodeStart(NBTOps.INSTANCE, someJavaObject);
DataResult<SomeJavaType> result = someCodec.parse(NBTOps.INSTANCE, someTag );
DataResult<JsonElement> result = someCodec.encodeStart(JsonOps.INSTANCE, someJavaObject);
DataResult<SomeJavaType> result = someCodec.parse(JsonOps.INSTANCE, someJsonElement);
```

--------------------------------

### Generate Visual Studio Code Run Configurations

Source: https://forge.gemwire.uk/wiki/Getting_Started

This Gradle task generates specific run configurations for Visual Studio Code users. Ensure the Java and Gradle extensions are installed for optimal integration.

```bash
genVSCodeRuns
```

--------------------------------

### Java Hello World

Source: https://forge.gemwire.uk/wiki/User%3AChampionAsh5357/Test

Standard Java entry point for a console application.

```java
public static void main(String[] args) {
    System.out.println("Hello World");
}
```

--------------------------------

### Named HolderSet Example

Source: https://forge.gemwire.uk/wiki/HolderSet

Defines a Named HolderSet using a tag ID in JSON.

```json
{
  "biome_tag": "#is_plains", // tag holderset
}
```

--------------------------------

### Creating and Using TagKey Wrappers in Java

Source: https://forge.gemwire.uk/wiki/Tags/1.18

Demonstrates how to create TagKey wrappers for different registry types (Items, Potions, VillagerTypes) using Forge and Vanilla APIs. It also shows how to check if an object belongs to a specific tag.

```java
public static final TagKey<Item> myItemTag = ItemTags.create(new ResourceLocation("mymod", "myitemgroup"));

public static final TagKey<Potion> myPotionTag = ForgeRegistries.POTIONS.tags().createTagKey(new ResourceLocation("mymod", "mypotiongroup"));

public static final TagKey<VillagerType> myVillagerTypeTag = TagKey.create(Registry.VILLAGER_TYPE, new ResourceLocation("mymod", "myvillagertypegroup"));

// In some method where stack is an ItemStack
boolean isInItemGroup = stack.is(myItemTag);

// In some method where potion is a Potion
boolean isInPotionGroup = ForgeRegistries.POTIONS.tags().getTag(myPotionTag).contains(potion);

// In some method where villagerTypeKey is a ResourceKey<VillagerType>
boolean isInVillagerTypeGroup = Registry.VILLAGER_TYPE.getHolder(villagerTypeKey).map(holder -> holder.is(myVillagerTypeTag)).orElse(false);
```

--------------------------------

### Public Method Declaration

Source: https://forge.gemwire.uk/wiki/Access_Transformers/1.17

Makes the specified method public. Example for 'leastMostToIntArray' in SerializableUUID.

```java
# Makes public the 'leastMostToIntArray' method in SerializableUUID,

```

--------------------------------

### Declare Public Class

Source: https://forge.gemwire.uk/wiki/AT

Makes the specified class public. Example targets a nested class.

```java
public net.minecraft.client.gui.screens.MenuScreens$ScreenConstructor
```

--------------------------------

### Basic Sound Definition in sounds.json

Source: https://forge.gemwire.uk/wiki/Sounds

Defines a simple sound resource named 'example_sound' that points to an audio file.

```json
{
  "example_sound": {
    "sounds": [ "examplemod:example_sound_file" ]
  }
}
```

--------------------------------

### Complete Sapling Constructor

Source: https://forge.gemwire.uk/wiki/Saplings/1.18

Complete the ExampleSapling constructor by passing the custom Tree instance and Block Properties.

```java
public ExampleSapling() {
        super(new ExampleTree(), AbstractBlock.Properties.create(Material.PLANTS).doesNotBlockMovement().tickRandomly().zeroHardnessAndResistance().sound(SoundType.PLANT));
    }
```

--------------------------------

### Define and Consume Custom Client Extension Simultaneously

Source: https://forge.gemwire.uk/wiki/Custom_Item_Animations

An alternative approach to defining and consuming the `IClientItemExtensions` implementation in a single step within `Item#initializeClient`.

```java
@Override
public void initializeClient(Consumer<IClientItemExtensions> consumer) {
    consumer.accept(new IClientItemExtensions() {
    // .....
    });
}
```

--------------------------------

### Declare Public Method Access Transformer (No Parameters)

Source: https://forge.gemwire.uk/wiki/AT/1.18

Example of making a method public. The '#' character denotes a comment.

```java
# Makes public the 'leastMostToIntArray' method in SerializableUUID,
```

--------------------------------

### Cladogram Example

Source: https://forge.gemwire.uk/wiki/Template%3ATree_list/doc

Displays a cladogram illustrating evolutionary relationships, using the Tree list template within a hidden container.

```wikitext
{{hidden begin|border=1px  #aaa solid|title=A cladogram|ta1=center|expanded=on}}
{{Tree list}}
*[[Tetrapoda]]
** {{Tree list/branching}}
*** Many extinct groups such as the ''[[Eucritta]]''
*** '''[[Lissamphibia]]''' Whose ancestors of the current amphibians
** {{Tree list/branching}}
*** Many extinct groups reminiscent of amphibians with more or less pronounced reptilian characteristics such as [[Eoherpetontidae]], the [[Embolomeri]], the [[Tokosauridae]], [[Chroniosuchidae]], [[Gephyrostegidae]], [[Solenodonsauridae]], [[Seymouriamorpha]], [[Westlothiana]], [[Lepospondyli]]
*** [[Cotylosauria]]
**** [[Amniota]], Originally all "Reptilian"
**** Other extinct sibling taxa like [[Diadectomorpha]] or [[Tseajaiidae]] are close enough to reptiles
{{Tree list/end}}
{{hidden end}}
```

--------------------------------

### Create Page (Proper Mod Structuring)

Source: https://forge.gemwire.uk/wiki/Special%3ALog/Curle

Logs the creation of an article about proper mod structuring.

```text
04:01, 19 September 2020 Curle talk contribs created page Proper Mod Structuring (Add Mod Structuring article)
```

--------------------------------

### Create Page (Events/FMLCommonSetupEvent)

Source: https://forge.gemwire.uk/wiki/Special%3ALog/Curle

Logs the creation of a page for 'Events/FMLCommonSetupEvent'.

```text
01:46, 14 February 2021 Curle talk contribs created page Events/FMLCommonSetupEvent (Create page.)
```

--------------------------------

### Exception Case: Entity Injection

Source: https://forge.gemwire.uk/wiki/Registration/1.18

An example where @ObjectHolder is used for an Entity, but it results in an exception because Entity does not have a corresponding registry, nor do its supertypes.

```java
    @ObjectHolder("minecraft:creeper")
    public static Entity creeper = null;
```

--------------------------------

### Create Registry with DeferredRegister (Java)

Source: https://forge.gemwire.uk/wiki/Registration

This Java snippet demonstrates creating a DeferredRegister and making a registry using its static constructor and makeRegistry method.

```Java
public static final DeferredRegister<ExampleRegistry> EXAMPLE = DeferredRegister.create(new ResourceLocation(MODID, "example_registry"), MODID);

public static final Supplier<IForgeRegistry<ExampleRegistry>> REGISTRY = EXAMPLE.makeRegistry(RegistryBuilder::new);
```

--------------------------------

### Prevent Farmland Trampling Under Certain Conditions

Source: https://forge.gemwire.uk/wiki/Events/BlockEvent/1.18

Fired when farmland gets trampled. Set canceled to true to prevent trampling.

```java
public void onTrample(final BlockEvent.FarmlandTrampleEvent event)
    {
        IWorld world = event.getWorld();
        if (!world.isClientSide() && event.getFallDistance() < 10.0F)
        {
            event.setCanceled(true); // change conditions for trampling
        }
    }
```

--------------------------------

### Generate IDE Run Configurations with Gradle

Source: https://forge.gemwire.uk/wiki/Getting_Started

Use the Gradle wrapper to generate run configurations for your IDE. This command is essential for setting up your project to run and debug your mod.

```bash
./gradlew gen***Runs
```

--------------------------------

### Define a Java Class for Codec Serialization

Source: https://forge.gemwire.uk/wiki/Codec

This is the example class that will be serialized and deserialized. It includes fields for an integer, an item, and a list of block positions.

```java
public class ExampleCodecClass {

    private final int someInt;
    private final Item item;
    private final List<BlockPos> blockPositions;

    public ExampleCodecClass(int someInt, Item item, List<BlockPos> blockPositions) {...}

    public int getSomeInt() { return this.someInt; }
    public Item getItem() { return this.item; }
    public List<BlockPos> getBlockPositions() { return this.blockPositions;
}
}
```

--------------------------------

### Create Page (Toolchain/Magic Constants)

Source: https://forge.gemwire.uk/wiki/Special%3ALog/Curle

Logs the creation of a page named 'Toolchain/Magic Constants'.

```text
05:52, 11 January 2021 Curle talk contribs created page Toolchain/Magic Constants (Create page)
```

--------------------------------

### Registering a Custom Fluid with FluidType

Source: https://forge.gemwire.uk/wiki/User%3AChampionAsh5357/Sandbox/Fluids_API

Example of registering a custom fluid that overrides getFluidType to return a FluidType instance. Ensure FluidType is registered separately.

```java
private static final DeferredRegister<Fluid> FLUIDS = DeferredRegister.create(ForgeRegistries.FLUIDS, ID);

// TestFluid extends FlowingFluid
private static final RegistryObject<FlowingFluid> TEST_FLUID = FLUIDS.register("test_fluid", () -> new TestFluid() {
    @Override
    public FluidType getFluidType() {
        return TEST_FLUID_TYPE.get();
    }
});
```

--------------------------------

### Instantiating a Translatable Component

Source: https://forge.gemwire.uk/wiki/Components/1.18

Use this to create a translatable component with text and styles. Ensure the translation key exists in your language file.

```java
new TranslatableComponent("your.translation_key.here", new TextComponent("thing1").withStyle(ChatFormatting.RED), new TextComponent("thing2").withStyle(ChatFormatting.BLUE))
```

--------------------------------

### Define and Implement a Custom Capability

Source: https://forge.gemwire.uk/wiki/Capability/1.18

This snippet shows how to define a Java interface for a capability and provide a basic implementation. Ensure the implementation is provider-agnostic where possible.

```java
public interface MyCapability {
    String getValue();
    void setValue(String value);
}

public class MyCapabilityImplementation implements MyCapability {
    private String value;

    @Override
    public String getValue() {
        return this.value;
    }

    @Override
    public void setValue(String value) {
        this.value = value;
    }
}
```

--------------------------------

### Ancestry Tree Example

Source: https://forge.gemwire.uk/wiki/Template%3ATree_list/doc

Displays an ancestry tree for Prince William, Duke of Cambridge using the Tree list template within a hidden container.

```wikitext
{{hidden begin|border=1px  #aaa solid|title=Ancestry tree of Prince William, Duke of Cambridge|ta1=center|expanded=on}}
{{Tree list}}
*1. '''[[Prince William, Duke of Cambridge]]'''(born 21 June 1982)
**2. [[Charles, Prince of Wales]] (born 14 November 1948)
***4. [[Prince Philip, Duke of Edinburgh|Prince Philip of Greece and Denmark]](born 10 June 1921)
****8. [[Prince Andrew of Greece and Denmark]] (20 January 1882 – 3 December 1944)
****9. [[Princess Alice of Battenberg]] (25 February 1885 – 5 December 1969)
***5. [[Elizabeth II|Elizabeth II of the United Kingdom]] (born 21 April 1926)
****10. [[George VI|George VI of the United Kingdom]] (14 December 1895 – 6 February 1952)
****11. [[Queen Elizabeth The Queen Mother|Lady Elizabeth Bowes-Lyon]] (4 August 1900 – 30 March 2002)
**3. [[Diana, Princess of Wales|Lady Diana Spencer]]  (1 July 1961 – 31 August 1997)
***6. [[John Spencer, 8th Earl Spencer]] (born 21 April 1926)
****12. [[Albert Spencer, 7th Earl Spencer]]  (23 May 1892 – 9 June 1975)
****13. [[Cynthia Spencer, Countess Spencer|Lady Cynthia Hamilton]]  (16 August 1897 – 4 December 1972)
***7. [[Frances Shand Kydd|The Honourable Frances Roche]] (20 January 1936 – 3 June 2004)
****14. [[Maurice Roche, 4th Baron Fermoy]] (15 May 1885 – 8 July 1955)
****15. [[Ruth Roche, Baroness Fermoy|Ruth Gill]] (2 October 1908 – 6 July 1993)
{{Tree list/end}}
{{hidden end}}
```

--------------------------------

### Generate IDE Run Configurations with Gradle

Source: https://forge.gemwire.uk/wiki/Getting_Started/1.18

Use the Gradle wrapper to generate specific run configurations for your IDE. This is a crucial step for debugging and running your mod during development.

```bash
./gradlew genEclipseRuns

```

```bash
./gradlew genIntellijRuns

```

```bash
./gradlew genVSCodeRuns

```

--------------------------------

### Registering Static and Instance Event Handlers

Source: https://forge.gemwire.uk/wiki/Events/1.18

Demonstrates registering static methods from a class and instance methods from an object to the event bus. Use `bus.register(EventHandler.class)` for static methods and `bus.register(instance)` for instance methods.

```java
class EventHandler {
	public static void nonAnnotatedStatic(Event event) {}

	@SubscribeEvent
	public static void annotatedStatic(Event event) {}

	public void nonAnnotatedInstance(Event event) {}

	@SubscribeEvent
	public void annotatedInstance(Event event) {}
}

// Within the execution of the program
IEventBus bus = ...;

// This will register the "annotatedStatic" method from the class
bus.register(EventHandler.class);
// This would register "annotatedStatic", but it is already registered
bus.register(EventHandler.class);

EventHandler instanceA = new EventHandler();
EventHandler instanceB = new EventHandler();

// This will register the "annotatedInstance" method from the instanceA object, and will not touch the instanceB object
bus.register(instanceA);
```

--------------------------------

### Build Project with Gradle Wrapper

Source: https://forge.gemwire.uk/wiki/Getting_Started/1.18

Execute the Gradle build task using the gradlew script. This command is used for various build-related operations, including building the project.

```bash
./gradlew buildNeeded

```

--------------------------------

### Instantiate Translatable Contents

Source: https://forge.gemwire.uk/wiki/Components

Create translatable content with specific text and styles. Ensure the language file entry matches the translation key.

```java
new TranslatableContents("your.translation_key.here", new Component.literal("thing1").withStyle(ChatFormatting.RED), new Component.literal("thing2").withStyle(ChatFormatting.BLUE))
```

--------------------------------

### Create Template Stylesheet

Source: https://forge.gemwire.uk/wiki/Special%3ALog/Curle

Logs the creation of a CSS stylesheet for a template.

```css
.mw-tpl-nocopy { display: flex; align-items: center; width: 75%; margin: auto; border-radius: 0.2em; background: rgb(27, 32, 35); box-shadow: 0 0 0.2em #999999; overfl...
```

--------------------------------

### Declare Public Method Access Transformer (Partial)

Source: https://forge.gemwire.uk/wiki/Access_Transformers

This is a partial example for making a method public. It specifies the class and method name, but not parameters or return type.

```access_transformers
# Makes public the 'leastMostToIntArray' method in UUIDUtil,
public net.minecraft.util.UUIDUtil m_177777_
```

--------------------------------

### Default Translation Key for Items

Source: https://forge.gemwire.uk/wiki/Internationalization/1.16

Illustrates the expected translation key format for an item with the registry name `examplemod:example_item`. This key is used in language files to provide the item's display name.

```json
{
  "item.examplemod.example_item": "Example Item Name"
}
```

--------------------------------

### Registering Biome Modifier Codec with Deferred Register

Source: https://forge.gemwire.uk/wiki/Biome_Modifiers

Use Deferred Registers to register biome modifier codecs. This example shows how to register a codec for ExampleBiomeModifier.

```java
public class YourMod
{
  static DeferredRegister<Codec<? extends BiomeModifier>> BIOME_MODIFIER_SERIALIZERS =
    DeferredRegister.create(ForgeRegistries.Keys.BIOME_MODIFIER_SERIALIZERS, "yourmodid");

  static RegistryObject<Codec<ExampleBiomeModifier>> EXAMPLE_CODEC = BIOME_MODIFIER_SERIALIZERS.register("example", () ->
    RecordCodecBuilder.create(builder -> builder.group(
        // declare fields
        Biome.LIST_CODEC.fieldOf("biomes").forGetter(ExampleBiomeModifier::biomes),
        PlacedFeature.CODEC.fieldOf("feature").forGetter(ExampleBiomeModifier::feature)
      // declare constructor
      ).apply(builder, ExampleBiomeModifier::new)));
}
```

--------------------------------

### Standard License Header for New Programs

Source: https://forge.gemwire.uk/wiki/Special%3AVersion/License/Prism_Highlight

Include this header in your source files to declare the program's licensing under the GNU Affero General Public License. It specifies the version of the license and provides a link for more details.

```text
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
```

--------------------------------

### Introduction to Tag Standards

Source: https://forge.gemwire.uk/wiki/Special%3AContributions/KnightMiner

This snippet provides the introductory text for a page detailing standardized tag names for modder compatibility. It outlines the structure for providing information on tag usage.

```wikitext
This page details standardized tag names for compatibility among modders. The following subsections give specific information on where the tags are used. == Materials ==
```

--------------------------------

### Create Template Page

Source: https://forge.gemwire.uk/wiki/Special%3ALog/Curle

Logs the creation of a template page with associated styles.

```html
<templatestyles src="Copy Guard/style.css"/> <div class="mw-tpl-nocopy"> 60px|class=mw-tpl-nocopy-exclamation|link=|alt=Important <div> <div class="mw-...
```

--------------------------------

### Apply Style to BaseComponent

Source: https://forge.gemwire.uk/wiki/Components/1.18

Applies a style to a BaseComponent. Use `withStyle` to merge properties or `setStyle` to replace the entire style. For example, adding a light blue color.

```java
theBaseComponent.withStyle(ChatFormatting.BLUE)
```

--------------------------------

### Game Test Annotations and Structure

Source: https://forge.gemwire.uk/wiki/Game_Tests

Demonstrates how to define game tests using annotations like @GameTestHolder, @GameTest, and @PrefixGameTestTemplate. Shows how template locations are determined based on these annotations and provided parameters.

```java
```java
// Modid for all structures will be MODID
@GameTestHolder(MODID)
public class ExampleGameTests {

  // Class name is prepended, template name is not specified
  // Template Location at 'modid:examplegametests.exampletest'
  @GameTest
  public static void exampleTest(GameTestHelper helper) { /*...*/ }

  // Class name is not prepended, template name is not specified
  // Template Location at 'modid:exampletest2'
  @PrefixGameTestTemplate(false)
  @GameTest
  public static void exampleTest2(GameTestHelper helper) { /*...*/ }

  // Class name is prepended, template name is specified
  // Template Location at 'modid:examplegametests.test_template'
  @GameTest(template = "test_template")
  public static void exampleTest3(GameTestHelper helper) { /*...*/ }

  // Class name is not prepended, template name is specified
  // Template Location at 'modid:test_template2'
  @PrefixGameTestTemplate(false)
  @GameTest(template = "test_template2")
  public static void exampleTest4(GameTestHelper helper) { /*...*/ }
}
```
```

--------------------------------

### Creating a Basic Entity Class

Source: https://forge.gemwire.uk/wiki/Making_Entities

Extend a base entity class like Mob and set up the constructor. This is the foundation for custom entity behavior.

```Java
public class ExampleMonsterEntity extends Mob {
    public ExampleMonsterEntity(EntityType<? extends Mob> entityType, Level level) {
        super(entityType, level);
    }
}
```

--------------------------------

### Create Registry with DeferredRegister (Kotlin)

Source: https://forge.gemwire.uk/wiki/Registration

This Kotlin snippet shows how to create a DeferredRegister and make a registry, utilizing lazy initialization for the registry supplier.

```Kotlin
val EXAMPLE: DeferredRegister<ExampleRegistry> = DeferredRegister.create(ResourceLocation(MODID, "example_registry"), MODID)

val REGISTRY: IForgeRegistry<ExampleRegistry> by EXAMPLE.makeRegistry(::RegistryBuilder).let {
    lazy {
        it.get()
    }
}
```

--------------------------------

### Start and End of a Tree List

Source: https://forge.gemwire.uk/wiki/Template%3ATree_list/doc

Defines the beginning and end of a tree structure using Template:Tl and Template:Tree list/end. Content is organized using asterisks for nesting.

```wikitext
{{Tree list}}
* Here goes the content of the tree using asterisks.
{{Tree list/end}}
```

--------------------------------

### Create a Translatable Component

Source: https://forge.gemwire.uk/wiki/Components

Instantiate `TranslatableContents` with a translation key and optional arguments for formatting. The client handles translation.

```java
new TranslatableContents("translation.key", "default message", new Object[]{
    "argument1",
    Component.literal("component argument")
})
```

--------------------------------

### Creating an Expanded Collapsible Tree

Source: https://forge.gemwire.uk/wiki/Template%3ATree_list/doc

Demonstrates how to make a collapsible tree appear expanded by default by adding the `|expanded=on` parameter to Template:Tlx.

```wikitext
{{hidden begin|border=1px  #aaa solid|title=Demonstration tree|ta1=center|expanded=on}}
{{Tree list}}
* A first level branch
** {{Tree list/branching}}
*** A third level branch
*** Another third level branch
*** The final third level branch
** A second level branch
** {{Tree list/branching}}                 <!--- This branch ends the second level --->
*** A third level branch
*** The final third level branch
{{Tree list/end}}
{{Hidden end}}
```

--------------------------------

### Create a SimpleChannel Instance

Source: https://forge.gemwire.uk/wiki/SimpleChannel/1.18

Instantiate a SimpleChannel object for custom packet communication. This should be done in a dedicated handler class.

```java
private static final String PROTOCOL_VERSION = "1";
public static final SimpleChannel INSTANCE = NetworkRegistry.newSimpleChannel(
    new ResourceLocation("mymodid", "main"),
    () -> PROTOCOL_VERSION,
    PROTOCOL_VERSION::equals,
    PROTOCOL_VERSION::equals
);
```

--------------------------------

### Create a Literal Component

Source: https://forge.gemwire.uk/wiki/Text_Components

Instantiates a literal content component with a given string. This is the most basic form of component content.

```Java
Component.literal("Hello, world!");
```
Tokens:
Raw