Getting Started

Libraries and Functions

Saturn provides a number of libraries and functions that are there to help you create better plugins easier and more quickly. They allow you to remove the programming of common tasks from your workflow, you can find an overview of them by clicking the link below.

Libraries and Functions

Understanding the Autoloader

Saturn will automatically load all the required libraries, functions, and plugins to run correctly.

Most files in Saturn's Processes directory is automatically loaded, so no need to require them in PHP. The only files that are not autoloaded are the login, logout, and join scripts.

Getting started with plugins

Plugins

Technical Documentation

Saturn has PHPDocs available online. This documentation lists every function, class, and variable that Saturn uses and may be useful for more technical users. Whilst this website is useful for showing how to implement these functions, the PHPDocs may be useful if you wish to use functions in your project.

Access the PHPDocs here: https://pixelsetdev.github.io/Saturn/