Commands
Convert content, convert and restore the world, clear caches and reload.
The command is /craftengineconverter, with the aliases /cengineconverter and
/cec. Every command works from the console. Flags take two dashes and come
after the arguments: /cec convert nexo ITEMS --dryrun.
| Command | Does | Permission (craftengineconverter.…) |
|---|---|---|
/cec convert | Convert files of Nexo and ItemsAdder | command.convert |
/cec reload | Reload configuration, messages and block-state limits | command.reload |
/cec clearfilescache | Clear the file cache | command.clearfilescache |
/cec worldconverter start | Convert every loaded chunk now | command.worldconverter.start |
/cec worldconverter restore | Put converted blocks and furniture back | command.worldconverter.restore |
/cec worldconverter clear-cached-chunks | Forget which chunks were done | command.worldconverter.clear.cached.chunks |
Using any of them also needs craftengineconverter.command.use, and the
worldconverter ones craftengineconverter.command.worldconverter. See
Permissions.
/cec convert
/cec convert [plugin] [type] [--dryrun] [--force] [--threads <n>]Reads the files of the other plugin and writes the CraftEngine version to
plugins/CraftEngineConverter/converted/<Plugin>/. See
Integrations for what to do with the result.
| Argument / flag | Default | Meaning |
|---|---|---|
plugin | all | nexo or itemsadder, any case (tab-completed). Without it, all run. |
type | ALL | ITEMS, EMOJIS, IMAGES, LANGUAGES, SOUNDS, RECIPES, PACKS, ALL |
--dryrun | off | Go through the conversion without creating folders or files |
--force | off | Stop a conversion still running and start this one |
--threads <n> | 1 | Threads to convert with; capped at the server's processor count |
Only one conversion runs at a time; without --force, a second one is refused.
Block-state limits are reset at the start of each run.
# Everything from Nexo
/cec convert nexo
# Only ItemsAdder's items, on 4 threads
/cec convert itemsadder ITEMS --threads 4/cec reload
Alias /cec rl. Rescans your CraftEngine configuration for block-state
capacity, then reloads every configuration file and the messages. One setting
needs a restart instead: enable in world-converter.yml.
/cec clearfilescache
Alias /cec cfc. The plugin caches the files it reads. Without a flag, this
evicts the entries that have expired; with --all, it drops the whole cache.
Use --all if a conversion seems to read an old version of a file.
/cec worldconverter start
Alias /cec wc start. Converts the Nexo and ItemsAdder blocks and furniture in
every loaded chunk of every world, now, with a progress bar. Needs
world-converter.yml
enable: true.
| Flag | Default | Meaning |
|---|---|---|
--chunks-per-tick <n> | 10 | Chunks handled per tick, 1 to 100 |
--force | off | Stop a world conversion still running first |
At the end it reports the chunks, blocks and furniture converted. Lower
--chunks-per-tick if the server lags while it runs.
/cec worldconverter restore
Alias /cec wc r. Puts back every block and piece of furniture the world
converter replaced, from the record in the
database.
Run it once without a flag to see how many blocks and entities would be
restored, then again with --confirm to do it. The restore runs in pages of
50, one page per tick, loading chunks as needed, and reports what it restored at
the end. It needs storage-type other than NONE.
/cec worldconverter clear-cached-chunks
The world converter remembers which chunks it already handled, so it does not check them again. This makes it forget, so the next pass checks every chunk: useful after converting more content.
Last updated on