Getting Started

This page goes over how to get started using Arceus.

To get started with Arceus you first need to install the server on your PC. To do that, you can install a specific version of Arceus 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

Using Arceus

To use Arceus, first start the server:

For Windows

C:/Arceus//arceus.exe

For Linux

/home/Arceus//arceus.elf

For MacOS

/home/Arceus//arceus.elf

Starting the server will create a doc folder near the executable, containing documentation for every type and function in Arceus. The documentation is designed to only work with the Lua Language Server extension for your favorite editor.

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

And, that's basically it! You're ready to use Arceus!