migus88 / Sandland.SceneTools

Sandland.SceneTools

Enhance your Unity scene management workflow with this powerful set of editor tools.

Table of Contents

• Features
• Quick Start Guide
  • Installation
    • OpenUPM
      • With CLI
      • Manually
    • Git URL
    • Unity Package
  • Usage
    • Scene Selector Tool
    • Scene Class Generation Tool
• Example of Generated Class Usage
• Theme Support
• License

Features

1. Scene Selector Tool - quickly navigate between scenes in your project.
2. Scene Class Generation Tool - automatically generate a C# class containing your scene names and indexes.

Quick Start Guide

Installation

OpenUPM

This is the preferred method of installation. OpenUPM handles updates a lot better than other methods described here.

With CLI:

1. Install openupm-cli.
2. Navigate to your project folder in the terminal/command prompt.
3. Run the following command: openupm add com.sandland.scene-tools

Manually:

1. Open the Packages/manifest.json file in your Unity project directory.
2. Add the following lines:

{
  "scopedRegistries": [
    {
      "name": "package.openupm.com",
      "url": "https://package.openupm.com",
      "scopes": [
        "com.sandland.scene-tools"
      ]
    }
  ],
  "dependencies": {
    "com.sandland.scene-tools": "0.11.1",
    // ...
  }
}

After saving the manifest.json file, Unity will automatically download and install the SceneTools package.

Git URL

1. Open Unity and navigate to Window > Package Manager.
2. Click the + button and select Add package from git URL....
3. Enter the following URL: https://github.com/migus88/Sandland.SceneTools.git?path=Assets/SceneTools.

To use a specific version, append a hashtag followed by the version number in a v0.0.0 format. Example: https://github.com/migus88/Sandland.SceneTools.git?path=Assets/SceneTools#v0.11.1.

Unity Package

1. Visit the releases page and download the latest SceneTools.unitypackage.
2. Open Unity and navigate to Assets > Import Package > Custom Package....
3. Select the downloaded SceneTools.unitypackage and click Import.

Usage

Scene Selector Tool

1. Press Ctrl+G on Windows or Cmd+G on Mac to open the Scene Selector Tool, or navigate to Tools > Sandland Games > Scene Selector.
2. Click on a scene icon to reveal its asset in the Project window.
3. Click on a scene name to load it in the editor.
4. Use the search bar to filter scenes by name.
5. Toggle the star icon next to a scene to add or remove it from your favorites. Favorited scenes will appear at the top of the list.

Scene Files Generation Tool

Additionally, Scene Tool can generate a class and a scriptable object containing the names, indexes and the addresses (if using Addressables) of the scenes in the project

1. Navigate to Tools > Sandland Games > Setup Scene Tools to enable and configure the tool.
2. Select the namespace, class name, and location for the generated class.
3. Select the Scriptable Object name and path
4. The class will be re-generated automatically whenever the "Scenes In Build" list changes.
   • If Addressables support is enabled in the "Setup Scene Tools" window, the class will also be regenerated every time there is a scene-related change in the Addressables.

To enable or disable Addressables support, open the "Setup Scene Tools" window, and toggle the corresponding option.

Example of Generated Class Usage

Here's an example of how to use the generated SceneList class:

using UnityEngine;
using UnityEngine.SceneManagement;
using Sandland;

public class SceneLoader : MonoBehaviour
{
    public void LoadSampleScene()
    {
        SceneManager.LoadScene(SceneList.Names.SampleScene);
    }

    public void LoadYetAnotherScene()
    {
        SceneManager.LoadScene(SceneList.Indexes.YetAnotherScene);
    }
}

Theme Support

Sandland.SceneTools now supports custom themes. You can choose from built-in themes or create your own. To select a theme, open the "Setup Scene Tools" window.

To create your own theme, follow these steps:

1. Create a USS file anywhere in your project (preferably inside one of the Editor folders, because you don't need it in the build). Name this file as you wish.
2. Add a label to the USS file by selecting the file in the Project window, and in the Inspector window, click the "Labels" icon (a tag icon). Type Sandland-theme into the input field and press Enter to add the label.
3. Edit the content of the USS file to look like this:

:root {
    --primary-background-color: #532A8F;
    --secondary-background-color: #2d1353;
    --element-background-color: #3c1a6e;
    --primary-text-color: #f7c2e5;
    --secondary-text-color: #ad7b9b;
    --disabled-text-color: #8d6981;
    --accent-color: #bf4d97;
    --selection-color: #E291C6;
    --button-color: #B7438E;
    --button-hover-color: #8f316e;
    --button-press-color: #A22576;

    --border-radius: 13px;
    --field-border-radius: 10px;

    --font-size: 15px;
    --small-font-size: 12px;
    --title-font-size: 20px;
    --title-secondary-font-size: 17px;

    --content-margin: 12px;

    --content-padding: 12px;
    --field-padding: 5px;

    --button-min-width: 40px;
    --list-icons-size: 50px;
    --favorites-size: 30px;
}

4. Replace the color values with your preferred colors.
5. Restart the "Setup Scene Tools" window, and you should see your color palette as an option in the themes list.

License

This project is licensed under the MIT License. See the license file for details.