Getting Started

Migrating from CCEmuX

CraftOS-PC v2.5.2 and later automatically prompt to migrate data from any detected CCEmuX installation when run for the first time. This process preserves all of your computer data as well as most options that may be set in ccemux.json. You can also trigger this manually by running CraftOS-PC on the command line with --migrate.

Supported options

  • maximumFilesOpen => maximumFilesOpen
  • maxComputerCapacity => computerSpaceLimit
  • httpEnable => http_enable
  • httpWhitelist => http_whitelist
  • httpBlacklist => http_blacklist
  • disableLua51Features => disable_lua51_features
  • defaultComputerSettings => default_computer_settings
  • debugEnable => debug_enable
  • http.websocketEnabled => http_websocket_enabled
  • http.max_requests => http_max_requests
  • http.max_websockets => http_max_websockets
  • termWidth => defaultWidth
  • termHeight => defaultHeight
  • plugins["net.clgd.ccemux.plugins.builtin.HDFontPlugin"].enabled => useHDFont
  • All files on all computers will be copied over

Command-line flags

CraftOS-PC v2.3.4 adds a number of new flags to make it a snap-in replacement for any tools that may use CCEmuX flags. These flags include:

  • -a|--assets-dir <dir>: Sets the CC:T directory that holds the ROM & BIOS (must contain an assets/computercraft/lua folder inside)
  • -C|--computers-dir <dir>: Sets the directory that stores data for each computer
  • -c=|--start-dir <dir>: Sets the directory that holds the startup computer's files
  • -d|--data-dir <dir>: Sets the directory that stores user data
  • --plugin <file>: Adds an additional plugin to the load list
  • -r|--renderer [renderer]: Lists all available renderers, or selects the renderer

With these arguments, you can seamlessly replace java -jar ccemux-launcher.jar in any script with craftos.