FTB Pack Companion

Your best friend when developing a Modpack. With an ever-growing list of features, tools, game fixes and more that'll aid in the creation, maintenance and stability of your pack. There is nothing better than bring along a good companion.

Features for 1.21.1

• Action Pad
  • Teleportation item / and general purpose action item that can be used to display entries to the player when used.
• Global Mob heath buff
  • Allows a global health modifier to be applied to all mobs.
• Forced GameRules
  • Mapping of forced game-rules that will be applied on world creation / load.
• Random Name Loot Function
  • Allows for random names to be applied to items via loot tables.
• Shader Notice
  • Presents the player with a shader notice screen on the first world load of the instance to allow them to pick shaders on or off.
• Spawner Behaviour Modifications
  • Custom spawner behaviour including:
  • Punish the player on break
  • Prevent breaking of spawners
  • Break torches / light sources near a spawner
  • Modify the difficulty of the spawners mobs via a custom attribute
• Structure Rotation Overrides
  • Force a specific rotation on jigsaw structures via config instead of random rotation.
• WaterLogging Structure Processor Fixer
  • Fixes issues with waterlogged blocks in structures via a custom structure processor.
• Trigger Block
  • An invisible block that can trigger events when a player walks over it.
• No wandering trader invisible
  • Config to disable wandering trader spawning in with invisible potion effects.
• Toast Removals
  • Removal of tutorial toasts, social interaction toasts and more via config.
• Forced Seed (Single player)
• FTB Chunks Custom Y Level Integration
  • Support for FTB Chunks custom Y level registry to allow for custom world height levels.

Other Features

• Improve reloading performance by disabling block cache rebuild on client tag data reload. Controlled in ftbpc-server.snbt and ftbpc-client.snbt via performance.skip_block_cache_rebuild config option.

Action Pad

Multipurpose action item that will display a user friendly GUI when used. This can be used for teleporting or running a command.

ftbpc_pad_actions.snbt Config

{
    actions: [
        {
            command_action: {
                command: "tp @s ~5 ~5 ~5",
                execution_level: 4
            },
            name: "lol",
            icon: "ftblibrary:icons/globe"
        },
        {
            teleport_action: {
                position: [100, 64, -100],
                dimension: "minecraft:the_nether",
                rotation: [0.0, 0.0]
            },
            name: "Nether Teleport",
            icon: "ftblibrary:icons/nether_portal"
        }
    ]
}

Global Mob Heath Buff

Easily apply a global health buff to all mobs in your world. Controlled via the modify_mob_base_health config option in the ftbpc-server.snbt file. Set this to a decimal value representing the multiplier you want to apply to mob health. For example, setting this to 2.0 will double all mob health.

Forced GameRules

The Forced GameRules feature allows you to set specific game rules that will be applied whenever a world is created or loaded. This is controlled via the forced-game-rules setting in the ftbpc-common.snbt config file.

{
	forced-game-rules: {
		rules: {
			randomTickSpeed: 3
			doDaylightCycle: 1b
		}
	}

Shader Notice

A simple shader notice screen that will let the user know that shaders can be used and warn them that performance may be impacted. This screen will only show once per instance.

ftbpc-common.snbt

{
	shaders_notice: {
		shader_pack_to_use: "" # Leave blank to pick the first available shader pack
		show_on_start: false
	}
}

Spawner Behaviour Modifications

Spawners default behaviour can be modified via the ftbpc-server.snbt config file.

Spawner behaviour options include:

• Forcing spawners to not be breakable
• Punishing players for breaking spawners
• Random entity spawning from spawners
• Respawning of spawners after broken
• Respawn interval modification

{
spawners: {
		allow_respawn: false
		punish_for_breaking_spawners: false
		random_entity: [ ]
		respawn_interval: 60
	}
}

Structure Rotation Overrides

Sometimes you may want a specific structure to have a set rotation when spawned in. This can be done with any structure that has the type of minecraft:jigsaw

This accepts a map of template pool ID's to a forced rotation for that pool: one of 'none', 'clockwise_90', '180', 'counterclockwise_90'

ftbpc-server.snbt

{
    worldgen: {
        structure_rotation_override: {
            "minecraft:village/plains/houses": "clockwise_90"
            "minecraft:stronghold/corridors": "180"
        }
    }
}

Trigger Block

The Trigger Block is an invisible block that can be placed in the world and will trigger events when a player walks over it. You can set a unique ID for this block via the block's NBT data. This can be used to trigger custom events via KubeJS

You can listen for the event in KubeJS like this:

NativeEvents.onEvent('dev.ftb.packcompanion.features.triggerblock.TriggerBlockEvent', event => {
    const player = event.player;
    const blockPos = event.pos;
    const uniqueId = event.identifier;
    
    // Do something.
});

This block has a delay to triggering the next event of 5 seconds to prevent spam triggering.

No wandering trader invisible

Sometimes, specifically in no-sky dimensions, it would be preferred to disable the wandering trader from being able to trigger their invisible potion effect on spawn. This can be disabled via the ftbpc-server.snbt config file.

{
    villagers: {
        no_wandering_trader_invis_potions: true
    }
}

Toast Removals

You can disable specific toasts via the ftbpc-client.snbt config file.

{
    disable_advancements_toasts: true
    disable_recipe_toasts: true
    disable_socialinteraction_toasts: true
    disable_tutorial_toasts: true
}

Forced Seed

You can force a new world to have a specific seed in singleplayer via the ftbpc-client.snbt config file.

{
    static_seed: 1234567890
}

WaterLogging Structure Processor fixer

The WaterLogging fix is applied directly into your template_pool. When creating a pool add the processor ftbpc:waterlogging_fix_processor to your processors list. The companion will now figure out when a block shouldn't be water logged and fix it!

It should look like this

{
  "processors": [
    {
      "processor_type": "ftbpc:waterlogging_fix_processor"
    }
  ]
}

Random Name Loot Function

The RandomNameLootFunction it a LootItemFunction that allows you to set an item's name based on a list of names. This requires a list of Component's in JSON format to be placed in the data/ftbpc/sources/random-name-loot-source.json folder. You can use a datapack or KubeJS to modify this file as by default, it simply contains an example.

Example of how the json file should look

{
  "example": [
    {"bold":true,"color":"blue","text":"I'm an examples!"}
  ],
  "list2": [
    {"text":"I'm an example 2!"},
    {"text":"More than just one"}
  ]
}

Each key in the Map / Object List must be unique as it's used as the identifier category for the loot function to find a random name. As you can see, you need to use a fully JSON compliant Component for the function to work correctly. Errors will be logged if this is done wrong.

Here is what the loot table can look like to take advantage of the above json file

{
  "entries": [
    {
      "type": "minecraft:item",
      "name": "minecraft:stone",
      "functions": [
        {
          "function": "ftbpc:random_loot_item_function",
          "nameSetKey": "example"
        }
      ]
    },
    {
      "type": "minecraft:item",
      "name": "minecraft:gold",
      "functions": [
        {
          "function": "ftbpc:random_loot_item_function",
          "nameSetKey": "list2"
        }
      ]
    }
  ]
}

FTB Chunks Custom Y Level Integration

FTB Chunks integration to allow for custom min-y level rendering of the minimap. Controlled via the ftbpc-common.snbt config file using the integrations.ftb_chunks.custom_y_level_chunk_positions which takes in a list of chunk positions.

• dimensionEqualityCheck is optional. This can be used when dimension names are dynamic like with FTB Team Bases
• dimensionEqualityCheck accepts starts_with, exact_match and ends_with as options
• asRadius and range are optional. If asRadius is true, the range will be used as a radius from the chunk position instead of a square area.

{
    integrations: {
        ftb_chunks: {
            custom_y_level_chunk_positions: [
                {
                    x: 0 
                    z: 0
                    min_y: -64
                    range: 128
                    asRadius: true
                    dimension: "minecraft:overworld" 
                    dimensionEqualityCheck: "starts_with"
                }
            ]
        }
    }
}

Support

• For Modpack issues, please go here: https://go.ftb.team/support-modpack
• For Mod issues, please go here: https://go.ftb.team/support-mod-issues
• Just got a question? Check out our Discord: https://go.ftb.team/discord

Licence

All Rights Reserved to Feed The Beast Ltd. Source code is visible source, please see our LICENSE.md for more information. Any Pull Requests made to this mod must have the CLA (Contributor Licence Agreement) signed and agreed to before the request will be considered.

Keep up to date