EssentialClient

EssentialClient is a client side only mod originally forked from Carpet Client for 1.15.2 that implements new client side features.

This mod is currently supporting 1.16.5+

1.16.5 requires Carpet Mod v1.4.44+.

1.17.1 requires Carpet Mod v1.4.57+.

1.18.2 requires Carpet Mod v1.4.69+.

1.19.4 requires Carpet Mod v1.4.78+

To access the Essential Client menu you must join a world, then it will be accessible to you when you press ESC, you can enable menu access from the title screen by enabling essentialClientButton.

Feel free to contribute by adding as many features as you want!

Here is a link to my YouTube video about the mod

Features

clientscript

This feature provides an API for the Minecraft allowing for scripts to be run while playing the game. The API uses Arucas a programming language made by myself.

Documentation and how to use can be found: here

ChunkDebug

ChunkDebug is a useful tool allowing you to monitor currently loaded chunks in the world. See the ChunkDebug wiki for more information.

CarpetClient

CarpetClient allows you to modify Carpet rules with a GUI. This only works if you have carpet installed on the server you are playing on and you have the appropriate permissions, descriptions of rules are provided through Crec0's rule database which can be found here.

GameruleScreen

This is a GUI that allows you to modify gamerules in singleplayer, and on servers (with EssentialAddons installed), it is accessible from the Essential Client menu.

Client Rules:

For commands any value inside [ ] are variables and should be replaced with real values when using the command

afkLogout

This will disconnect you after you have been afk for a set number of ticks

• Type: Integer
• Default Value: 0
• Extra Info: value must be >=200 to be enabled

announceAFK

This announces when you become afk after a set amount of time (ticks),

• Type: Integer
• Default Value: 0
• Extra Info:
  • This is judges by weather your player position is constant
  • Prints the message determined by announceAFKMessage

announceAFKMessage

This is the message you announce after you are afk

• Type: String
• Default Value: I am now AFK
• Extra Info:
  • Requires announceAFK

autoWalk

This will auto walk after you have held your key for set amount of ticks

• Type: Integer
• Default Value: 0
• Extra Info:
  • Once auto walking press backwards or forward again to cancel

betterAccurateBlockPlacement

This is the same as accurate block placement in tweakeroo, it allows you to place blocks in different orientations when holding a keybind. This does not need server side support, everything is handled on the client

• Type: Boolean
• Default Value: false
• Extra info:
  • This may not work on servers with strong anticheat

carpetAlwaysSetDefault

This makes it so whenever you set a carpet rule it automatically sets it to default

• Type: Boolean
• Default Value: false
• Extra info:
  • This works both in the Carpet Options GUI and when executing the /carpet command

chunkDebugMinimapBackground

This toggles whether a background will be rendered for the chunk debug minimap

• Type: Boolean
• Default Value: true

chunkDebugShowUnloadedChunks

This will display unloaded chunks in ChunkDebug, these will disappear once you refresh or close and reopen the Map

• Type: Boolean
• Default Value: false

clientScriptAnnouncements

This announces whether a script has started or finished in chat

• Type: Boolean
• Default Value: true

commandAlternateDimension

This command will give you the coordinates of your position in the alternate dimension (nether or overworld), you can click on the coordinates to teleport there (must have permissions)

• Type: Boolean
• Default Value: false

commandClientNick

This allows you to nickname other players using, this is only on the client, this can be any string (with spaces and special characters), you can also use Mojang formatting, use & instead of §

• Type: Boolean
• Default Value: false
• Extra Info:
  • /clientnick set [playername] [replacementname], /clientnick delete [playername], /clientnick get [playername]

commandPlayerClient

This command allows you to save /player... commands and execute them

• Type Boolean
• Default Value: false
• Extra Info:
  • Requires commandPlayer (from carpet) on server/singeplayer to be true
  • Documentation on how to use: here

commandPlayerList

This command allows you to execute /player... commands in one command

• Type: Boolean
• Default Value: false
• Extra Info:
  • Requires commandPlayerClient
  • Documentation on how to use: here

commandRegion

This command allows you to determine the region you are in or the region at set coords

• Type: Boolean
• Default Value: false
• Extra Info:
  • Usage: /region get, /region get [x] [y]

commandSuggestorIgnoresSpaces

This makes the command suggestor suggest the correct commands even if you type extra spaces

• Type: Boolean
• Default Value: false

craftingHax

When enabled if you hold control and click on a recipe it will drop crafted items, hold shift also to drop stacks of crafted items

• Type: Boolean
• Default Value: false

customClientCape

This allows you to choose a Minecraft cape to apply to your player. This will only render for your client

• Type: Cycle
• Default Value: None

disableArmourRendering

This stops armour from rendering on certain selected Entities, you can choose between none, you (only your player), all players, or all entities

• Type: Cycle
• Default Value: None

disableBobViewWhenHurt

Disables the camera bobbing when you get hurt

• Type: Boolean
• Default Value: false

disableBossBar

This disables boss bars from rendering

• Type: Boolean
• Default Value: false

waterFovMultiplier

This stops the FOV changing when you are submerged in water

• Type: Double
• Default Value: 0

disableHotbarScrolling

This will prevent you from scrolling in your hotbar

• Type: Boolean
• Default Value: false
• Extra Info:
  • Learn to use hotkeys :)

disableJoinLeaveMessages

This will prevent join/leave messages from displaying

• Type: Boolean
• Default Value: false

disableMapRendering

This stops all item frames with maps in them from rendering, good for preventing lag around huge maps

• Type: Boolean
• Default Value: false

disableNameTags

This stops all player's name tags from rendering

• Type: Boolean
• Default Value: false

disableNarrator

Disables cycling narrator when pressing CTRL + B

• Type: Boolean
• Default Value: false

disableNightVisionFlash

Disables the flash that occurs when night vision is about to run out

• Type: Boolean
• Default Value: false

disableOpMessages

This will prevent system messages from displaying

• Type: Boolean
• Default Value: false

disableRecipeNotifications

Disables the recipe toast from showing

• Type: Boolean
• Default Value: false

disableScreenshotMessage

Disables the message in chat after you take a screenshot

• Type: Boolean
• Default Value: false

disableTutorialNotifications

Disables the tutorial toast from showing

• Type: Boolean
• Default Value: false
• Extra Info:
  • Useful for when switching versions when using vanilla launcher

displayRuleType

This allows you to choose the order you want rules to be displayed

• Type: Cycle
• Default Value: Alphabetical
• Extra Info:
  • Current options: Alphabetical and RuleType

displayTimePlayed

This will display how long you have had your current client open for in the corner of the pause menu

• Type: Boolean
• Default Value: false
• Extra Info:
  • Now you can see how much time you've wasted been productive

essentialClientButton

This renders the Essential Client Button on the pause menu and the main menu

• Type: Boolean
• Default Value: true
• Extra Info:
  • This may conflict with other mods so you are able to disable this. You can also oppen the menu by setting a keybind.

forceTitleTextDown

This forces the minecraft version and Mojang copyright text back down to the bottom if you have essentialClientButton enabled

• Type: Boolean
• Default Value: false

highlightLavaSource

Highlights lava sources, credit to plusls for the original code for this in their mod, this requires you to have Fabric API installed.

• Type: Boolean
• Default Value: false

increaseSpectatorScrollSensitivity

Increases the sensitivity at which you can scroll to go faster in spectator

• Type: Boolean
• Default Value: false
• Extra Info:
  • Couples nicely with increaseSpectatorScrollSpeed

increaseSpectatorScrollSpeed

Increases the limit at which you can scroll to go faster in spectator

• Type: Integer
• Default Value: 0
• Extra Info:
  • You can now go faster than ever before!

openScreenshotDirectory

This makes the screenshot message link open your screenshot directory instead of opening the screenshot itself

• Type: Boolean
• Default Value: false

overrideCreativeWalkSpeed

This allows you to override the vanilla walk speed in creative mode

• Type: Double
• Default Value: 0.0
• Extra Info:
  • Limited to creative mode, stop thinking of cheating

permanentChatHud

This prevents chat from being cleared, this also prevents chat from being cleared when leaving worlds/servers

• Type: Boolean
• Default Value: false
• Extra Info:
  • This means you can swap worlds and still have the same chat :)

permanentTime

This sets the time to a set value and visually the time will not change on the client

• Type: Integer
• Default Value: -1
• Extra Info:
  • This works on in-game time, so between 0 - 23999 is an appropriate value

quickLockRecipe

When you middle click a recipe it searches it essentially locking it inplace, middle click empty space or another recipe to change it

• Type: Boolean
• Default Value: false

removeWarnReceivedPassengers

"This removes the 'Received passengers for unknown entity' warning on the client

• Type: Boolean
• Default Value: false
• Extra Info:
  • This warning just clogs up logs when arround Minecarts

soulSpeedFovMultiplier

Determines the percentage of Fov scaling when walking on soil soul or soul sand

• Type: Integer
• Default Value: 0

stackableShulkersInPlayerInventories

This allows for shulkers to stack only in your inventory

• Type: Boolean
• Default Value: false
• Extra Info:
  • This only works if the server has EssentialAddons installed with stackableShulkersInPlayerInventories enabled

stackableShulkersWithItems

This allows for shulkers with items to stack only in your inventory

• Type: Boolean
• Default Value: false
• Extra Info:
  • This requires stackableShulkersInPlayerInventories

startSelectedScriptsOnJoin

This will start all of your selected ClientScripts when you join a world

• Type: Boolean
• Default Value: false

survivalInventoryInCreative

This lets you open a survival inventory while you are in creative mode

• Type: Boolean
• Default Value: false

switchToTotem

This will switch to a totem (if you have one), under a set amount of health

• Type: Integer
• Default Value: 0
• Extra Info:
  • Health is out of 20

toggleTab

This will make tab a toggle instead of a press to activate

• Type: Boolean
• Default Value: false

unlockAllRecipesOnJoin

Unlocks every recipe when joining a world

• Type: Boolean
• Default Value: false

waterFovMultiplier

Determines the percentage of Fov scaling when fully submerged in water

• Type: Integer
• Default Value: 0