2024-10-16 01:37:01 +03:00

2.0 KiB

pack library

pack.is_installed(packid: str) -> bool

Check if specified pack is installed in the world

pack.data_file(packid: str, filename: str) -> str
-- and
pack.shared_file(packid: str, filename: str) -> str

Returns the path to the data file and creates missing directories in the path.

  • The first option returns: world:data/packid/filename
  • The second option returns: config:packid/filename

Examples:

file.write(pack.data_file(PACK_ID, "example.txt"), text)

For a containermod pack, write text to world:data/containermod/example.txt.

Use this to store in-world data.

file.write(pack.shared_file(PACK_ID, "example.txt"), text)

For a containermod pack, write text to config:containermod/example.txt

Use this to store shared data for all worlds.

pack.get_folder(packid: str) -> str

Returns the path to the folder of the installed content pack.

Example:

file.write(pack.data_file(PACK_ID, "example.txt"), text)

For pack containermod will write text to the file world:data/containermod/example.txt

pack.get_folder(packid: str) -> str

Returns installed content-pack folder.

pack.is_installed(packid: str) -> bool

Check if the world has specified pack installed.

pack.get_installed() -> strings array

Returns all installed content-pack ids.

pack.get_available() -> strings array

Returns the ids of all content packs available but not installed in the world.

pack.get_base_packs() -> strings array

Returns the id of all base packages (non-removeable)

pack.get_info(packid: str) -> {
  id: str,
  title: str,
  creator: str,
  description: str,
  version: str,
  icon: str,
  dependencies: optional strings array
}

Returns information about the pack (not necessarily installed).

  • icon - name of the preview texture (loading automatically)
  • dependencies - strings following format {lvl}{id}, where lvl:
    • ! - required
    • ? - optional
    • ~ - weak for example !teal