Saturn Ring Library

Easy to use SGL wrapper written in C++
Documentation

Brought to you by
	ReyeMe		robertoduarte
	7shades		willll
	nemesis-saturn		jae686

Getting started

Installing SRL

Download

Using pre-packaged release

Go to the Releases section and download latest .zip release.

Using git repository

Clone git repository by using:

git clone --recurse-submodules https://github.com/ReyeMe/SaturnRingLib.git

Note: It is important to not forget the --recurse-submodules otherwise some submodules (SaturnMath++ and TLSF memory allocator) will not get downloaded.

Setting up

1. Download toolchain. This can be done by running setup_compiler.bat.
2. Download mednafen and put it into emulators/mednafen/ folder (or install it with a package manager if on linux).
   You will also need to obtain bios file (mpr-17933.bin) and put it in the mednafen firmware folder.

Note: .bat scripts used within SRL can be run natively on Windows, Linux or Mac.

Linux dependencies

Use your preferred package manager to install the following:

• make - for compilation
• unzip - used during compiler installation
• wget - to download the compiler
• sox - to convert audio
  • libsox-fmt-mp3 - for sox to support mp3 files
• xorriso - to build cue/bin

Build and run samples

Samples and project in SRL can be build and run from VSCode or manually by starting .bat scripts in the sample/project directory

With VSCode (recommended)

1. Open the folder of a project/sample (folder contains .vscode sub folder) with VSCode.
2. Open tasks menu using CTRL+SHIFT+B.
3. Click on one of the compile tasks to build the project, or run with task to start emulator.
   Projects can be compiled with DEBUG or RELEASE target.

Manually

1. Open the folder of a project/sample.
2. To build just run compile.bat or to run a built project in an emulator use one of the run with .bat files.

Creating a project

To create a new custom project just copy one of the samples to the projects folder.
The name of the project can than be changed within the makefile.

Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting an issue or a pull request.