Skip to main content

Installing

Hangar ↗GitHub releases ↗

Latest release: MachineEngine 0.1.0.

  1. Check the requirements: Paper or Folia 1.20.6 – 26.3, and the right Java.
  2. Stop the server.
  3. Put CraftEngine and MachineEngine in plugins/, and zMenu if you want machine menus. Add any addon (such as Mekanized) at the same time.
  4. Start the server.
  5. Run /ce reload all once, so CraftEngine builds its resource pack with the new blocks and items, and sends it to players.

Check it loaded​

/machineengine status

It shows the enabled addons, the loaded machines and the number of startup problems. /machineengine report lists those problems, each with its file and place when it comes from a YAML file.

In the console, at startup:

[MachineEngine] Using CraftEngine <version>
[MachineEngine] Scheduling with FoliaLib on Paper
[MachineEngine] Started with 1 addon(s) [...]

Without zMenu you also get zMenu is not installed: machines have no menus.

What gets created​

On the first start:

plugins/MachineEngine/
├── config.yml settings, a comment above each one
├── definitions/
│ └── example.yml a commented example, disabled
└── menus/ with zMenu only
├── machine.yml the default machine menu
└── player_settings.yml the /machinesettings menu
plugins/CraftEngine/resources/machineengine/
├── pack.yml
└── configuration/
├── lang.yml the text players see, in their language
└── templates.yml templates for blocks that use MachineEngine

Machine data is not in these files: each machine's contents, process and upgrades are saved in the world, with its block.

Next​