/inventory-pause-forge

Pause your single player game when opening your inventory, opening chests, trading etc.

Primary LanguageJavaEuropean Union Public License 1.2EUPL-1.2

Inventory Pause

Supported Versions Modrinth Download Count CurseForge Download Count Side: Client-Only License

Pause your single player game when you open your inventory and more.

(Neo)Forge GitHub Modrinth CurseForge
Fabric (by umollu) GitHub Modrinth CurseForge
Fabric Legacy GitHub Modrinth

This small client-side mod supports pausing when opening the inventory, when dying, opening furnaces, crafting tables, shulker boxes and even has support for other mods. In case of incompatibilities try adding the modded screen to the list of "Compat mod class names".

All features can be disabled individually inside the config menu (accessible via the Forge mod list).

This mod is client-side only and won't be active in LAN worlds or on servers.

Supported versions:

  • 1.19.4: 2.0.0
  • 1.20-1.20.1: 1.3.1
  • 1.20.3-1.20.4: 1.5.1

Releases

Releases prior to 1.2 depend on Cloth Config Forge.

The mod is licensed under the EUPL 1.2.

Tutorial: How to add custom screens

1.2+ (click to expand)
  1. Check whether you have assigned the keybind for "Add to Custom Screens".
  2. Navigate to the menu you want to add and press the "Add to Custom Screens" key you assigned earlier. You should get a confirmation in chat when you do so.
  3. Verify it worked by checking if the screen is now paused.

If you experience any problems with modded screens (e.g. modded UI elements not working) try adding the screen to the list of "Compat mod class names".

0.1 - 1.1.2 (click to expand)

To add custom screens to the config you need the internal name of the screen to add. If you don't know it you can try this:

  1. Check the Minecraft Controls settings if you have assigned the keybinds for "Copy Class Name" and "Open Settings" (only available on versions released after October 2022)
  2. Open the settings and change "Enable Debug Mode" to true. This should make an overlay appear on the top left of the screen whenever you have a screen open.
  3. Navigate to the menu you want to add and depending on your mod version:
  • (0.8.2, 0.9, 1.0 or 1.1): note down the topmost text (e.g. appeng.client.gui.implementations.IOPortScreen). Alternatively copy it from the Minecraft log. That is the internal name of the screen.
  • (0.8.3, 0.9.1, 1.0.1, 1.1.1 or later): press the "Copy Class" key you assigned earlier. You should get a confirmation in chat when you do so.
  1. Add an entry to "Custom Mod class names" and paste the internal name.

Now the screen should be paused. If it works disable "Enable Debug Mode" again.

If you experience any problems (e.g. modded UI elements not working) try adding the screen to the list of "Compat mod class names".

Note: This mod will not be able to work on all types of screens due to technical limitations

In-Game Config

2.0+ (click to expand)

Main Config

Ingame Config Mod Version 2.0.0 and up

  • Enable Mod: enables / disables every part of the mod apart from the debug overlay
  • Save on Pause: this can help if you experience lag spikes when quickly opening and closing inventories Enable / disable pausing of specific inventories by clicking on the corresponding button

Mod Compat Options

Mod Compat Options Mod Version 2.0.0 and up

  • Custom mod class names: List of custom screens which get paused
  • Compat mod class names: List of custom screens which don't get fully paused. They get ticked in regular intervals as specified in Time between compat ticks.
  • Time between compat ticks: Specifies how often (20 ticks = one second) screens listed in Compat mod class names are ticked
  • Enable Debug Mode: enables an overlay for easier mod compat configuration
1.2+ (click to expand)

Main Config

Ingame Config Mod Version 1.2 and up

  • Enable Mod: enables / disables every part of the mod apart from the debug overlay
  • Save on Pause: this can help if you experience lag spikes when quickly opening and closing inventories Enable / disable pausing of specific inventories by clicking on the corresponding button

Mod Compat Options

Mod Compat Options Mod Version 1.2 and up

  • Custom mod class names: List of custom screens which get paused
  • Compat mod class names: List of custom screens which don't get fully paused. They get ticked in regular intervals as specified in Time between compat ticks.
  • Time between compat ticks: Specifies how often (20 ticks = one second) screens listed in Compat mod class names are ticked
  • Enable Debug Mode: enables an overlay for easier mod compat configuration
0.1 - 1.1.2 (click to expand)

Ingame Config Mod Version 1.1.2 and down

General:

  • Enable Mod: enables / disables every part of the mod apart from the debug overlay
  • Enable Save on Pause: this can help if you experience lag spikes when quickly opening and closing inventories
  • Enable Debug Mode: enables an overlay for easier mod compat configuration
  • Debug Overlay Options:
    • X-Coordinate / Y-Coordinate: The position of the debug overlay
    • Maximum Crawl Depth: Limit the number of items to display (useful for deep gui hierarchies)

Abilities:

  • Pause on Inventory / Pause on Creative Inventory / Pause on Death Screen / Pause on Furnace / Pause on Crafting Table / Pause on Shulker Box: Enables / Disables the respective feature

Mod Compat:

  • Custom mod class names: A custom list of GUI class names can be input here to force the screen to pause the game
  • Time between compat ticks: Frequency in ticks (20 ticks = every second) to unpause when in screens specified in "Compat mod class names"
  • Compat mod class names: A custom list of GUI class names can be input here to tick less often