README.md

PrototypeMachinery Docs (English)

This folder contains English translations of the main project documentation.

• If a page is missing in docs/en/, please refer to the Chinese version in docs/.
• The code is always the source of truth; docs aim to explain conventions and architecture.

Index

Core concepts:

• Public API entry point (PrototypeMachineryAPI)
• Machine Attributes
• Machine runtime & recipe execution architecture
• PMKey system (resource keys)
• Key-level IO (PMKey-based IO)
• Resource storage (ResourceStorage / EnergyStorage)
• Task scheduler (TaskScheduler)
• Lifecycle & load order
• Localization / i18n

Registration:

• MachineType registration
• Block / item / block-entity registration pipeline

Multiblock structures:

• Structure system overview
• Structure loader features
• MachineStructure JSON guide
• Structure preview (client)

Modules:

• Tiered hatch system (10 tiers)

UI:

• UI: default ModularUI + scriptable UIRegistry
• Machine UI Editor: Runtime JSON contract

Integrations:

• CraftTweaker (ZenScript)
• JEI / HEI integration
• JEI integration internals (maintainers)

Chinese docs index (complete):

• docs/README.md