Skip to content

Commit

Permalink
🔩 Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Jonathan Carter <[email protected]>
  • Loading branch information
JonathanMCarter authored May 24, 2024
1 parent f94a45c commit 1c4b91d
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
![(PSD) MS Banner Template](https://user-images.githubusercontent.com/33253710/169396164-002bc6fc-e749-4119-a0da-3a49fb7e5f64.jpg)


# Multi-Scene
![Banner Full 1200-630x](https://github.com/CarterGames/MultiScene/assets/33253710/5ac7b9c7-2e51-41b0-8f1c-4f7058cdc6f1)

A library to help developers create Unity games that split elements of the game into multiple scenes.

Expand All @@ -10,25 +7,35 @@ A library to help developers create Unity games that split elements of the game
![GitHub all releases](https://img.shields.io/github/downloads/CarterGames/MultiScene/total?style=for-the-badge)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/CarterGames/MultiScene?style=for-the-badge)
![GitHub repo size](https://img.shields.io/github/repo-size/CarterGames/MultiScene?style=for-the-badge)
![Unity](https://img.shields.io/badge/Unity-2020.3.x_or_higher-critical?style=for-the-badge)

## Note
This package is considered experimental, updates will be fairly infrequent if at all.

## Features
- Cross scene referencing
- Multi scene management
- Extensions with extra functionality
## Key Features
✔️ Cross scene referencing<br>
✔️ Multi scene management<br>
✔️ Extensions with extra functionality such as URP camera stacking.<br>

### To-Do:
## To-Do
- Further editor tools
- Optimisation extension for better scene loading
- More scene loading options
- Additional attributes for more flexiability
- Additional attributes for more flexibility

## How To Install
Download the latest version of the project via the packages section of this repo & un-zip the downloaded files. Then either:
1. Run the .unitypackage and proceed to follow the steps in import window in Unity
2. Open your Unity project, right-click in the project window and select the "Import Custom Package" option. Select the package and follow the steps in import window

## Getting Started
- See docs for usage.

## Documentation
You can access a online of the documentation here: <a href="https://carter.games/multiscene">Online Documentation</a>. A offline copy if provided with the package and asset if needed.
You can access a online of the documentation here: <a href="https://carter.games/multiscene">Online Documentation</a>. An offline copy if provided with the package and asset if needed.

## Unity Supported Versions
The asset is developed and maintained in 2020.3.x and make use for available .Net updates in the version. Older versions of Unity are not supported for this asset.

## Authors
- <a href="https://github.com/JonathanMCarter">Jonathan Carter</a>
Expand Down

0 comments on commit 1c4b91d

Please sign in to comment.