Skip to content
fishcute edited this page Dec 15, 2021 · 30 revisions

BreakBlocker Wiki

BreakBlocker is a relatively simple, and customizable mod. This wiki will go through how to use and customize this mod.

This mod is not 100% reliable in creative mode yet!

Scroll down to view the pages, or click on one of these links:

Examples

Configuration

Commands

Key Binds

Upcoming Features


Examples

Below shows some examples of BreakBlocker's possible usages.

Mining out a geode

Mining a geode

Clearing grass very efficiently

Clearing grass

Removing every other block in a floor design

Clearing grass


Configuration

This is where most of this mod's features can be changed. The configuration should be named blockblocker_config.json (Future versions may rename the config to breakblocker_config.json, I forgot to update the name). Below will go through the functions of the config:

playMiningAnimation: Show the default block mining animation on a disabled block (Hand swinging, breaking particles).

Default: true

indicatorType: Indicator for when your crosshair is over a disabled block. Below is a list of possible options:

  • icon: Shows an icon.

icon

  • crosshair: Recolors your crosshair. Note: If you have a mod that changes your crosshair in some way, it is not recommended to use this indicator.

crosshair

  • outline: Recolors the outline of blocks

outline

  • none: Shows no indicator.

none

Default: icon

icon{X,Y}: Changes the X and Y value of the icon on the screen (Only if indicatorType is set to icon).

Default: -4, 8

iconSize: Changes the size of the icon on the screen (Only if indicatorType is set to icon).

Default: 9

iconType: Changes the texture of the icon (Only if indicatorType is set to icon) Below is a list of possible options:

  • star: Default icon. Star shaped.

star

  • red_x: A detailed red X. Can look weird when crosshair is over some colors.

red_x

  • x: A simple X.

x

  • pickaxe: Pickaxe symbol.

pickaxe

  • alert: Solid circle with an exclamation mark.

alert

Default: star

disabledBlocks: A list of disabled blocks. Can be changed in-game easily.

Entry format examples:

  • cobblestone
  • weathered_cut_copper_stairs
  • diorite

This list will accept any string value. If the entry is invalid, it will be ignored. Takes in block ids, which can be viewed with advanced tooltips.

Empty by default

blackListBlocks: Determines if the disabledBlocks list will be a blacklist or a whitelist. If the value is set to false, any block not on the disabled blocks list will be unmineable, and blocks on the list will be mineable.

Default: true

crosshair{Red,Green,Blue,Alpha}: Changes the rgba color values of the crosshair if indicatorType is set to crosshair. If indicatorType is set to outline, the outline will use these colors instead.

Default: 1.0, 0.0, 0.0, 1.0

cooldownAfterMiningDisabledBlock: The cooldown of when you can break another block after attempting to mine a disabled block. Any values below 3 will break the mod's main function. Example: If you set this value to 20, you will not be able to mine another block for a second after attempting to mine a disabled block. Higher values are usually more reliable. There is no cap to what this value can be, so be careful. Only change this value if you really need to, the default value works in pretty much all cases.

Default: 3


Commands

The base command is breakblocker, all entries below are followed by this.

list: Lists all disabled blocks.

toggle (Block ID): Disables/enables a specific block.

disable: Disables/enables the mod.

clear: Clears all entries in the disabled blocks list

help: Shows available commands


Keybinds

All keybinds can be found in the BreakBlocker keybind section.

Disable/Enable Block: Disables/Enables the breaking of the block you are looking at.

Default key: Grave/Accent

Toggle Mod: Disables/Enables the mod. Same function as the disable command.

Default key: Z


Upcoming features

These are some features that may or may not be added in the future. Some of these are just things I need to do.

  • Blocking entity hits
  • Ability to disable blocked list modification
  • Update config name to breakblocker_config
  • Rework block breaking prevention

Clone this wiki locally