From 1c4b91d4d47e83014004a671898d035253a37aa8 Mon Sep 17 00:00:00 2001 From: Jonathan Carter Date: Fri, 24 May 2024 08:19:16 +0100 Subject: [PATCH] :nut_and_bolt: Update README.md Signed-off-by: Jonathan Carter --- README.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 191f541..5dac24a 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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
+✔️ Multi scene management
+✔️ Extensions with extra functionality such as URP camera stacking.
-### 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: Online Documentation. A offline copy if provided with the package and asset if needed. +You can access a online of the documentation here: Online Documentation. 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 - Jonathan Carter