Cupboard mod guide for All the Mods 10 0.51

Cupboard is a mod that ships in this pack as version 2.8 (the file is cupboard-1.21-2.8.jar). It was already in the pack by 0.51 or earlier.^[1]

That is all the sources I have for it, so I can't tell you what Cupboard does or how it behaves in the pack. There is no guidebook in the mod's jar and no platform description to draw from.^[1]

Unverified What Cupboard does, who it is meant for, and whether it adds any items, blocks or config options you would use directly is unconfirmed. The sources don't describe the mod's features.

On progression, there is nothing to plan around. The mod is not on the ATM Star path, and no quests in this pack involve it. You won't need to unlock, craft or configure anything from Cupboard to move forward.^[1]

In this pack, Cupboard shows up through its config file, so this section walks through the options you can tweak there.^[2]

Unverified The sources here show no quests, recipes or in-jar guidebook for Cupboard, so no first items to make are confirmed.

The options in the config

All of these live in config/cupboard.json. In this pack every value is set to the same default that the option's own description states.^[2]

• logOffthreadEntityAdd.logOffthreadEntityAdd is true. Entities should only be added on the server thread, and Cupboard fixes the crashes caused by mods that break that rule. This option turns on logging of those cases.^[2]
• showCommandExecutionErrors.showCommandExecutionErrors is true. It controls whether errors during command execution are displayed.^[2]
• skipErrorOnEntityLoad.skipErrorOnEntityLoad is false. If you turn it on, it prevents crashes on entity loading.^[2]
• forceHeapDumpOnOOM.forceHeapDumpOnOOM is false. Turning it on makes a heap dump automatically when the game crashes with an out of memory issue. The description warns that heap dumps take a lot of space.^[2]
• debugChunkloadAttempts.debugChunkloadAttempts is false. It enables debug logging of chunks being forceloaded on the server thread by directly accessing an unloaded chunk, which stalls the server until the chunk finishes loading. The description says it is incompatible with lithium and its forks.^[2]

The sources for Cupboard mod in this pack cover its config file only, so this section sticks to what that file shows. The options deal with crash handling, logging and debugging. Here is what each one does and how the pack sets it.^[2]

Entity handling

• logOffthreadEntityAdd.logOffthreadEntityAdd: entities should only be added on the server thread itself. Cupboard fixes the crashes caused by mods that break that rule, and this option turns on logging of those cases. The pack has it set to true.^[2]
• skipErrorOnEntityLoad.skipErrorOnEntityLoad: prevents crashes when entities load. The pack has it set to false, so this protection is off.^[2]

Commands and chunk debugging

• showCommandExecutionErrors.showCommandExecutionErrors: controls whether errors during command execution are displayed. The pack has it set to true.^[2]
• debugChunkloadAttempts.debugChunkloadAttempts: enables debug logging of chunks being forceloaded on the server thread by directly accessing an unloaded chunk. That access stalls the server until the chunk finishes loading. The pack has it set to false.^[2]

Crash diagnostics

forceHeapDumpOnOOM.forceHeapDumpOnOOM makes the game create a heap dump automatically when it crashes with an out of memory issue. The config warns that heap dumps take a lot of space, so use it with care. The pack has it set to false.^[2]

Cupboard is a small library-style mod, so there are only five options in its config file. This pack leaves every one of them at the mod's default. The descriptions in the file list the defaults, and the pack's values match them.^[2]

Crash and error handling

• skipErrorOnEntityLoad.skipErrorOnEntityLoad is false in this pack. If you turn it on, Cupboard tries to prevent crashes while entities load. Since the pack leaves it off, an entity loading error can still crash the game.^[2]
• forceHeapDumpOnOOM.forceHeapDumpOnOOM is false. Turning it on makes the game write a heap dump automatically when it crashes with an out of memory error. The file description warns that heap dumps take a lot of space, so only enable it when you are chasing a memory problem.^[2]

Logging options

• logOffthreadEntityAdd.logOffthreadEntityAdd is true. Entities should only be added on the server thread, and Cupboard fixes crashes caused by mods that break that rule. With this option on, it also logs those cases. That can help you work out which mod is misbehaving.^[2]
• showCommandExecutionErrors.showCommandExecutionErrors is true, so errors that happen while a command runs are displayed.^[2]
• debugChunkloadAttempts.debugChunkloadAttempts is false. When enabled, it logs chunks being force-loaded on the server thread by directly accessing an unloaded chunk, which stalls the server until the chunk finishes loading. The file notes it is incompatible with lithium and its forks.^[2]