https://github.com/iamtakuu/spooky-loader
A simple-to-use Asynchronous Scene Loader for your big levels/games!
https://github.com/iamtakuu/spooky-loader
asynchronous-scene loader scene-load tools unity unity3d
Last synced: about 2 months ago
JSON representation
A simple-to-use Asynchronous Scene Loader for your big levels/games!
- Host: GitHub
- URL: https://github.com/iamtakuu/spooky-loader
- Owner: iamTakuu
- License: mit
- Created: 2023-03-30T13:57:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-23T12:01:36.000Z (about 3 years ago)
- Last Synced: 2025-05-29T14:13:40.412Z (about 1 year ago)
- Topics: asynchronous-scene, loader, scene-load, tools, unity, unity3d
- Language: C#
- Homepage:
- Size: 23.4 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Spooky Loader
A plug-and-play, easy to use Scene Loader for your Big Worlds!
# Getting Started
## Context
Before using this tool, keep in mind that it is for a specific use in which you have a big level that might work better in a multi-scene workflow instead of loading the entire level at runtime. This allows scenes to be loaded in and out as needed, improving overall performance and scalability.
This tool is greatly inspired by The Unity Glue and this
2017 GDD Talk on Multi-Scene Editing. Along side these two I took the implementation that Unity shows on their Youtube channel and attempted to improve on it where possible, while also adding some nice quality of life features for designers. I would highly recomend watching their video to gain a basic understanding of how Spooky Loader works.
Here's a tutorial for the tool if you don't feel like reading the rest: Spooky Loader Tutorial
## Installation
### Git URL (Recommended)
1. Open the package manager window
2. Click the plus icon
3. Choose ``"Add package from git URL..."``
4. Use the link below.
```
https://github.com/iamTakuu/Spooky-Loader.git
```
# How to Use
## Setup
The idea setup has a "Base" scene that holds persistent entities throughout the scene.
You'll need Gameobjects named after the scenes you want to load in and out. These will hold the **SpookySceneLoader** Component
**NOTE**: It's **key** that the gameobject is named after the scene AND the scenes are added to the Build Order.
Set up your level as need be, breaking it up into smaller, more appropriate scenes.
## SpookySceneLoader.cs
The **SpookySceneLoader** component is attached to the empty Gameobject created earlier, all it needs from you is the scene's current status and a **Trigger Prefab** (which is of type **SpookyTrigger**). Tick _isLoaded_ when the scene you start with is already present, otherwise leave it as false.
The _Add Trigger_ button creates a new instance of the trigger prefab as a child of the Gameobject with the Loader. A scene can have multiple triggers, in the event that there are multiple entrances to the level.
## SpookyTrigger.cs and Trigger Prefab
You can make your own custom _Trigger Prefab_ if need be, you just need to create a prefab that has a box collider (set to isTrigger) and give it the component _SpookyTrigger_. Add this prefab to the loader, and the _Add Trigger_ button will take care of assigning the **OnSceneTrigger()** Unity Event.
This event can also be used to add any extended functionality you might need.