Skip to content

Latest commit

 

History

History
352 lines (280 loc) · 13.4 KB

README.md

File metadata and controls

352 lines (280 loc) · 13.4 KB

Oh My Minecraft Client

MC Versions CurseForge Issues Pull Requests CI Publish Release Release Github Release Downloads

The project will be maintained in this repository until plusls back.

English | 中文

Make Minecraft Client Great Again!

The default hotkey to open the in-game config GUI is O + C.

❗Before reporting a problem, be sure to try the latest beta version to check if the problem still exists.

Dependencies

Dependency Download
Fabric API CurseForge | GitHub | Modrinth
MagicLib CurseForge | GitHub | Modrinth
MaliLib CurseForge | Masa WebSite

Generic

clearWaypoint

A hotkey to clear highlight waypoint.

  • Category: Generic
  • Type: hotkey
  • Default value: C

debug

Display debug message

  • Category: Generic
  • Type: boolean
  • Default value: false

dontClearChatHistory

Don't clear chat history and input history.

  • Category: Generic
  • Type: boolean
  • Default value: false

forceParseWaypointFromChat

Force parse waypoint from chat (such it will override the clickevent of rtext).

  • Category: Generic
  • Type: boolean with hotkey
  • Default value: false, no hotkey

highlightWaypoint

openConfigGui

A hotkey to open the in-game Config GUI

  • Category: Generic
  • Type: hotkey
  • Default value: O,C

parseWaypointFromChat

Parse waypoint from chat.

  • Category: Generic
  • Type: boolean with hotkey
  • Default value: true, no hotkey

sendLookingAtPos

A hotkey to send looking at pos.

  • Category: Generic
  • Type: hotkey
  • Default value: O,P

sortInventory

A hotkey to sort inventory.

  • Category: Generic
  • Type: hotkey
  • Default value: R

sortInventoryShulkerBoxLast

Sort inventory shulker box last.

  • Category: Generic
  • Type: enum
  • Default value: AUTO
  • Option values: AUTO, FALSE, TRUE

sortInventorySupportEmptyShulkerBoxStack

Support empty shulker box stack when sort inventory.

  • Category: Generic
  • Type: boolean with hotkey
  • Default value: false, no hotkey

Feature Toggles

autoSwitchElytra

Auto switch elytra and chestplate.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

autoSwitchElytra

betterSneaking

Player can move down 1 height when sneaking.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

disableBlocklistCheck

Workaround for MC-218167, prevent network request from blocking the Render Thread.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey
  • Dependencies:
    • And (All conditions need to be satisfied):
      • minecraft: >1.15.2

disableBreakBlock

You can't break blocks in breakBlockBlackList.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

disableBreakScaffolding

You can only break scaffolding with the items in breakScaffoldingWhiteList.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

disableMoveDownInScaffolding

You can only move down scaffolding with the items inside moveDownInScaffoldingWhiteList in your hand.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

disablePistonPushEntity

Prevent piston push entities (except the player) to reduce piston lag (such as the carpet duper), it will cause entities pos error when entity push by piston.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

flatDigger

Which allowed you mine a flat road while digging stone by preventing digging of blocks under your feet while standing,sneak to dig blocks under you.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

forceBreakingCooldown

You will have 5gt cooldown after instant breaking.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

highlightLavaSource

Highlight lava sources.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

highlightLavaSourceOff highlightLavaSourceOn We have also provided some optional resource packs for this purpose.

highlightPersistentMob

Highlight persistent mobs (Mob have item in hand or mob have custom name).

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

highlightPersistentMobClientMode

Use client data to check persistent mob, such as hand item, custom name. Tips: in local game should disable this option, in server also can use syncAllEntityData in MasaGadget to sync entity data to local.

  • Category: Feature Toggles
  • Type: boolean
  • Default value: false

preventIntentionalGameDesign

Prevent Intentional Game Design (Bed and Respawn Anchor).

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

preventWastageOfWater

Prevent water bucket from vanishing in nether.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

realSneaking

You cannot ascend or descend non-full blocks when sneaking, e.g. carpets.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

removeBreakingCooldown

Remove cooldown after break block (default is 5gt), it will not work when enable forceBreakingCooldown.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

worldEaterMineHelper

When the blocks in worldEaterMineHelperWhitelistr are exposed to the air, the game will render a mirror image above them, which is convenient for world eater maintenance and mining.

  • Category: Feature Toggles
  • Type: boolean with hotkey
  • Default value: false, no hotkey

worldEaterMineHelper

List

blockModelNoOffsetBlacklist

blockModelNoOffsetBlacklist

  • Category: Lists
  • Type: string list
  • Default value: []

blockModelNoOffsetListType

blockModelNoOffsetListType

  • Category: Lists
  • Type: enum
  • Default value: WHITELIST
  • Option values: WHITELIST, NONE, BLACKLIST

blockModelNoOffsetWhitelist

blockModelNoOffsetWhitelist

  • Category: Lists
  • Type: string list
  • Default value: [minecraft:wither_rose, minecraft:poppy, minecraft:dandelion]

breakBlockBlackList

If disableBreakScaffolding is enabled, you can't break blocks in breakBlockBlackList.

  • Category: Lists
  • Type: string list
  • Default value: [minecraft:budding_amethyst, _bud]

breakScaffoldingWhiteList

If disableBreakScaffolding is enabled, you can only break scaffolding with the items in breakScaffoldingWhiteList.

  • Category: Lists
  • Type: string list
  • Default value: [minecraft:air, minecraft:scaffolding]

highlightEntityBlackList

highlightEntityBlackList

  • Category: Lists
  • Type: string list
  • Default value: []

highlightEntityListType

highlightEntityListType

  • Category: Lists
  • Type: enum
  • Default value: WHITELIST
  • Option values: WHITELIST, NONE, BLACKLIST

highlightEntityWhiteList

highlightEntityWhiteList

  • Category: Lists
  • Type: string list
  • Default value: [minecraft:wandering_trader]

moveDownInScaffoldingWhiteList

If disableMoveDownInScaffolding is enabled, you can only move down scaffolding with the items inside moveDownInScaffoldingWhiteList in your hand.

  • Category: Lists
  • Type: string list
  • Default value: [minecraft:air, minecraft:scaffolding]

worldEaterMineHelperWhitelist

If worldEaterMineHelper is enabled, when the blocks in worldEaterMineHelperWhitelist are exposed to the air, the game will render a mirror image above them, which is convenient for world eater maintenance and mining.

  • Category: Lists
  • Type: string list
  • Default value: [_ore, minecraft:ancient_debris, minecraft:obsidian]

Advanced Integrated Server

flight

Integrated server enable flight.

  • Category: Advanced Integrated Server
  • Type: boolean
  • Default value: true

onlineMode

Integrated server use online mode.

  • Category: Advanced Integrated Server
  • Type: boolean with hotkey
  • Default value: true, no hotkey

port

Integrated server lan port, 0 to use default port.

  • Category: Advanced Integrated Server
  • Type: integer
  • Default value: 0
  • Min value: 0
  • Max value: 65535
  • Dependencies:
    • Not (Any condition needs to be excluded):
      • minecraft: <1.19.3

pvp

Integrated server enable pvp.

  • Category: Advanced Integrated Server
  • Type: boolean
  • Default value: true

Development

Support

Current main development for Minecraft version: 1.20.4

And use preprocess to be compatible with all versions.

Note: We only accept the following versions of issues. Please note that this information is time-sensitive and any version of the issue not listed here will be closed

  • Minecraft 1.14.4
  • Minecraft 1.15.2
  • Minecraft 1.16.5
  • Minecraft 1.17.1
  • Minecraft 1.18.2
  • Minecraft 1.19.2 (Ending support soon)
  • Minecraft 1.19.3 (Ending support soon)
  • Minecraft 1.19.4
  • Minecraft 1.20.1 (Ending support soon)
  • Minecraft 1.20.2 (Ending support soon)
  • Minecraft 1.20.4

Mappings

We are using the Mojang official mappings to de-obfuscate Minecraft and insert patches.

Document

The English doc and the Chinese doc are aligned line by line.

License

This project is available under the LGPL-3.0 license. Feel free to learn from it and incorporate it in your own projects.

Credit