What is RPSLib?

Named after my game studio alias, Red Phoenix Studios. This library is a constantly evolving collection of common systems that are used throughout my Unity projects. The idea is to:

• Save time re-writing the same code for each project.
• Provide optimized code for common operations, aiding in high performance for runtime.
• Provide easy to use methods for more complex algorithms.

RPSLib.unitypackage:

The Unity package is the main asset in this repo and is all you need to use this library. It contains various scripts, prefabs, render pipeline configs, UI elements, a splash scene and more. Some systems included are inventory management, itemisation and ScriptableObject based quests.

⚠️ The Red Phoenix Studios logo included in the Unity package is NOT for reuse or modification.

Third-party packages included:

• The free edition of LeanTween by dentedpixel. For all kinds of tweening animations.
• Steamworks by Riley Labrecque. A C# wrapper for the Steamworks API.

Installation:

Head to Releases and grab the files you need.

• (Unity Package) Install the RPSLib package by dropping RPSLib.unitypackage into your project and import everything. Yeah, that easy.

Dependencies:

• Steamworks.NET (included in RPSLib.unitypackage)
• You may get some references not found warnings, simply add the required libraries into RPScore.asmdef. One example is the Unity Localization package.

Usage:

Within your code, you can access the DLL by simply typing RPSLib. and then the class you require, or by importing RPS at the top of your file with using RPSLib;.

Examples:

// Returns a GameObject at the mouse position.
clickedObject = RPSLib.Physics.Raycast.GetGameObjectAtMousePosition(rayDistance, buildingMask, mainCamera);

// Returns a float value representing the distance between 2 objects, using square magnitude.
inspectedDistance = RPSLib.Maths.Distances.SqrMagDistance(fromPos, toPos);

// If we loaded the current scene Additively, go back to the previous scene and set it as the active scene.
RPSLib.SceneManagement.NavigateSceneBack(true);

// Take a screenshot with some optional params (file name, include DateTime, hide UI, file extension and debug logging.
RPSLib.ScreenshotHandler.TakeScreenshot("Screenshot", true, true, RPSLib.ScreenshotHandler.FileExtension.PNG, true);

Class list and functions:

Class	Description
Debug	For console printing with various styles.
Geometry	For handling various geometric calculations.
Graphics	Display and Graphical settings.
LineRendering	For performing various actions with LineRenderers.
Maths	Various maths functions such as distance checks, weights and curves.
Physics	Raycasting related functions, including getting GameObject at mouse.
Pooling	For object pooling. Returns/iterates a list of pooled objects.
SceneManagement	For more complex scene handling. Including Additive scene loading and a back stack for navigating to previously loaded scenes.
ScreenshotHandler	For capturing screenshots in-game. Offers optional file formats, custom filename and the option to hide all UI while capturing.
Time	Time manipulation.

Contribution:

PRs are welcome here. See contribution rules. Please branch off the release branch. You are also welcome to edit the RPSLib.unitypackage, but please be explicit in your changes.