Files

Create, read, write, and delete in-game files on virtual machines.

Permission required: filesystem

Methods

create(options)

Create a new file on a virtual machine.

await Files.create({
    ip: "10.0.0.1",
    path: "/home/admin/",
    name: "secret",
    extension: "txt",
    content: "Top secret data",
});

Parameters:

Name	Type	Description
options.ip	string	Target machine IP
options.path	string	Directory path
options.name	string	File name (without extension)
options.extension	string	File extension
options.content	string	File content
options.locked	boolean	Prevent deletion

read(ip, path)

Read a file's content.

const content = await Files.read("10.0.0.1", "/home/admin/secret.txt");

write(ip, path, content)

Write content to an existing file.

await Files.write("10.0.0.1", "/home/admin/secret.txt", "Updated content");

remove(ip, path)

Delete a file.

await Files.remove("10.0.0.1", "/home/admin/secret.txt");

exists(ip, path)

Check if a file exists.

const exists = await Files.exists("10.0.0.1", "/home/admin/secret.txt");

list(ip, path)

List files in a directory.

const files = await Files.list("10.0.0.1", "/home/admin/");