Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

unicornpkg recommends the following paths for package contents:

  • /bin for executable Lua files. This path should be on shell.path.
  • /lib for modules, APIs, and libraries. This path should be on package.path if you're writing complementary software.
  • /usr/share/help/ for help files. This path should be on help.path.
  • /usr/libexec for executable files for use by other programs. This path should not be on shell.path or package.path.
  • /usr/libLoadAPI for APIs meant to be loaded by os.loadAPI. This path should not be on package.path. Packages should refrain from loading their APIs into the global environment by default.
  • /etc/startup for files that should be executed when starting the machine.
    • Implementations MAY encourage use /startup instead when compatibility with older versions of ComputerCraft is not desired. Such older versions require /startup to be a file.
  • /home for user data, or /home/{user} if you are writing a multi-user system.

If your use-case is not specified here, follow IEEE 1003.1-2017 (POSIX).