Quickstart

Using Crystal Save is like adding a Collider Component to your GameObject. Here is the fastest way to use of Crystal Save in your project:

Import Crystal Save through the Unity Package Manager

No Scene Preparation, Prefab Registrations required.

Crystal Save requires your confirmation to download the necessary dependencies. When prompted accept the request - if accidentally canceled - install the dependencies through the editor top menu: Tools/Crystal Save/Project/Install Dependencies

Create Crystal Save Settings (Settings Wizard)

Upon the first import of Crystal Save into your project, a Settings Wizard will open. The wizard guides you through the basic setup process. It will continue to appear each time you open your project until the Save Settings have been created. Alternatively, you can click the Close & Setup Manually button, which will automatically create Save Settings with default working values and the Wizard will stop showing up upon opening of your project.

Demo Scenes

If you plan to use the Demo Scenes: Install the Default Setting → Menu: Tools/Crystal Save/Settings/Install Default Settings

  • Add the Demo Scenes to your Scene Manager


Save Prefabs

Save/Load Prefabs: Add the Remember Prefab component to your prefab. Done! Saving and Loading will now restore this Prefab. Easier than ever!


Save Components (Scene Game Objects)

Add the Remember Component on your GameObject. Click on the button Add Remember Component... and choose what component you want to make saveable

If you want to save the Transform Position of a Player:

  1. Add the Remember Transform component

  2. Check the boxes of the data that you want to save: Position, Rotation, Scale, in this case Position

  3. Done


Save and Load with the Unity Editor

Open the Save Slot Manager Window in the top menu under Tools/Crystal Save/Runtime Debug/Manage Save Slots (Runtime only)

The will open the Save Slot Manager Window. Keep in mind the window will only show the Save Slots during Runtime!


Save and Load at Runtime through UI

Right click in the Hierarchy Window and navigate to Crystal Save/UI/Save Menu and add the Save Menu to your scene.

This will add a theme-able and ready-to-use Save Menu into your scene

Last updated