This repository has been archived by the owner on Jan 14, 2025. It is now read-only.
forked from jeffcampbellmakesgames/jcmg-slate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Fixed issue of warnings showing up for package due to demo content being present in package and not in an AsmDef * Fixed casing of readme at root of repo and included updated readme and changelog in package contents * Bumped version locally to 0.1.3
- Loading branch information
Showing
20 changed files
with
108 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Changelog | ||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## [Releases] | ||
### [0.1.3] - 2022-12-04 | ||
#### Fixed | ||
* Moved demo content out of package folder. | ||
|
||
### [0.1.2] - 2022-12-03 | ||
#### Fixed | ||
* Added missing dependency for NaughtyAttributes | ||
|
||
### [0.1.1] - 2022-12-02 | ||
#### Fixed | ||
* Fixed incorrect min unity version for package, replaced 2022.3.14f1 with 2021.3.14f1 | ||
|
||
### [0.1.0] - 2022-12-03 | ||
#### Added | ||
* Created initial project using library template | ||
* Added initial library content and example demo scene. | ||
|
||
## CL Template | ||
This template should be used for any new releases to document any changes. | ||
|
||
### [0.0.0] - 1900-01-01 | ||
#### Added | ||
For new features. | ||
|
||
#### Changed | ||
For changes in existing functionality. | ||
|
||
#### Deprecated | ||
For soon-to-be removed features. | ||
|
||
#### Removed | ||
for now removed features. | ||
|
||
#### Fixed | ||
For any bug fixes. | ||
|
||
#### Security | ||
In case of vulnerabilities. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
[](https://github.com/jeffcampbellmakesgames/jcmg-slate/actions/workflows/publish_release.yml) | ||
[](https://openupm.com/packages/com.jeffcampbellmakesgames.slate/) | ||
 | ||
[](https://twitter.com/stampyturtle) | ||
|
||
# JCMG Slate | ||
## About | ||
JCMG Slate is a lightweight UI framework library for Unity. It contains a simple paradigm for defining distinct UIScreens and offers an easy way to look them up and hook up animations for them. | ||
|
||
## Minimum Requirements | ||
* **Unity Version:** 2021.3.X or Higher | ||
* **Scripting Runtime**: .Net 4.X | ||
|
||
## Installing JCMG Slate | ||
Using this library in your project can be done in three ways: | ||
|
||
### Install via OpenUPM | ||
The package is available on the [openupm registry](https://openupm.com/). It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli). | ||
|
||
``` | ||
openupm add com.jeffcampbellmakesgames.jcmg-slate | ||
``` | ||
|
||
### Install via GIT URL | ||
Using the native Unity Package Manager introduced in 2017.2, you can add this library as a package by modifying your `manifest.json` file found at `/ProjectName/Packages/manifest.json` to include it as a dependency. See the example below on how to reference it. | ||
|
||
``` | ||
{ | ||
"dependencies": { | ||
... | ||
"com.jeffcampbellmakesgames.jcmg-slate" : "https://github.com/jeffcampbellmakesgames/jcmg-slate.git#release/stable", | ||
... | ||
} | ||
} | ||
``` | ||
|
||
|
||
You will need to have Git installed and available in your system's PATH. | ||
|
||
## Support | ||
If this is useful to you and/or you’d like to see future development and more tools in the future, please consider supporting it either by contributing to the Github projects (submitting bug reports or features and/or creating pull requests) or by buying me coffee using any of the links below. Every little bit helps! | ||
|
||
[](https://ko-fi.com/I3I2W7GX) | ||
|
||
## Contributing | ||
|
||
For information on how to contribute and code style guidelines, please visit [here](CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters