Getting Started

This page goes over how to get started using Reyveld.

To get started with Reyveld you first need to install the server on your PC. To do that, you can install a specific version of Reyveld from Github.

Where to download the server.

Once you download your desired version, run your platform's install script in the command line.

For Windows

install.bat

For Linux

install.sh

For MacOS

install.sh

To run Reyveld, start the server with your platforms' executable:

For Windows

C:/Reyveld/<version>/reyveld.exe

For Linux

/home/Reyveld/<version>/reyveld.elf

For MacOS

/home/Reyveld/<version>/reyveld.elf

Starting the server will create a documentation folder, containing all the info you need to interface with Reyveld. The documentation is designed to only work with the Lua Language Server extension.

To test your Lua scripts quickly, you can use any API testing client with Web Socket support (Restfox is highly recommended). Send your scripts to the Web Socket located at http://127.0.0.1:7274/lua.

Getting Full Access

Reyveld requires a certificate to be created that describes what features a program needs to function. All certificates must be agreed to by the user first before it can be used. This means that if you want access to Reyveld's features, you must first create a valid certificate.

Certificates

---This requests all permissions in Arceus. 
---This is not recommended, as it is not trustworthy.
function AuthAll()
    return AuthVeld.authorize("Rey Dau",
        { SPolicy.all() })
end

---This requests access to write, create, and delete SKits, but not read them.
---This will give the user a warning, as writing, creating, and deleting SKits could
---lead to missing/corrupted files, however, it can be contained.
function AuthSKit()
    return AuthVeld.authorize("Rey Dau", {
        SPolicy.skit({ write = true, create = true, delete = true })
    })
end

---This requests access to only read pk9, pk8, pk7, and pk6 files.
---This is the most trustworthy certificate, and should be safe.
function AuthFiles()
    return AuthVeld.authorize("Rey Dau", {
        SPolicy.externalFiles({
            read = true
            whitelist = Globs.whitelist().addAll({ "*.pk9", "*.pk8",
                "*.pk7", "*.pk6" })
        })
    })
end