-
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.
Merge branch 'main' of https://github.com/stashgg/stash-unity
- Loading branch information
Showing
1 changed file
with
19 additions
and
14 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,47 @@ | ||
| # Stash SDK for Unity  | ||
|
|
||
| ## About | ||
| This package is designed to get your Unity project up and running with the Stash web shop in just a few steps. The package is lightweight and wraps Stash API endpoints without any external dependencies. | ||
|
|
||
| This package is designed to get your Unity project up and running with the Stash web shop in a few easy steps. The package is wrapping Stash API endpoints and is very lightweight with no external dependencies. | ||
|
|
||
| To start with the SDK, you need to import the package from the releases tab and follow [getting started guide](https://docs.stash.gg/docs/configure-unity-project). | ||
| To get started, you need to import the latest package from the [releases](https://github.com/stashgg/stash-unity/releases) section and follow our [Unity guide](https://docs.stash.gg/docs/configure-unity-project). | ||
|
|
||
| ## Usage | ||
|
|
||
| To interact with Stash API and handle responses, the SDK offers the `StashAuth`, `StashLauncher`, and other classes, named according to the product you plan to use. | ||
| All classes are static, with no inheritance to the MonoBehaviour, no need to place them in the scene, and can be called only when needed. | ||
| To interact with the Stash API and handle responses, the SDK offers the `StashAuth`, `StashLauncher`, and other classes (named according to the product you want to use). | ||
| All classes are static, with no inheritance to [MonoBehaviour](https://docs.unity3d.com/Manual/class-MonoBehaviour.html), so there's need to place them in the scene, and can be called only when needed. | ||
|
|
||
| ## Sample | ||
|
|
||
| The repository contains a sample project. This scene is always up to date and pre-build for testing in the `Actions` tab. | ||
| For more samples, visit [playground repository](https://github.com/stashgg/stash-playground), keep in mind that some of the samples in the playground repository might be out of date and should not be used in production. | ||
| This repository contains a sample project. The provided scene is always up to date and pre-built for testing in the **Actions** tab. | ||
| For more samples, see the [playground repository](https://github.com/stashgg/stash-playground). Keep in mind that the samples in the playground repository are just examples, and that they shouldn't be used as-is in production. | ||
|
|
||
| ## Requirements | ||
|
|
||
| Stash package always targets the latest LTS version of Unity. We recommend you use the LTS version of Unity to build projects that are in production or about to ship. However, you should not encounter any issues when integrating or migrating into any other versions of Unity above the targeted release. | ||
| The Stash package always targets the latest LTS version of Unity. We recommend you use the LTS version of Unity to build projects that are in production or about to ship. However, you should not encounter any issues when integrating or migrating into any other versions of Unity above the targeted release. | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Import package manually | ||
| 1. Download [the latest build from the release page](https://github.com/stashgg/stash-unity/releases) | ||
|
|
||
| 1. Download [the latest build from the release page](https://github.com/stashgg/stash-unity/releases). | ||
| 2. Import the `.unitypackage` file into your Unity game using the [local asset package import](https://docs.unity3d.com/Manual/AssetPackagesImport.html) process. | ||
| 3. Optionally select the `Scenes` folder to test out our reference implementations. | ||
|
|
||
| ### Import package via repository | ||
| 1. In the Unity editor main menu, click Window > Package Manager. | ||
| 2. Click the + icon and select Add package from git URL. | ||
|
|
||
| 1. In the Unity editor main menu, click **Window > Package Manager**. | ||
| 2. Click the **+** icon and select **Add package from git URL**. | ||
| 3. Specify the git repository URL: https://github.com/stashgg/stash-unity.git?path=Assets/Stash. | ||
|
|
||
| ## Changelog | ||
|
|
||
| Package follows Semantic Versioning `(major.minor.patch)`. Any potential breaking changes will always cause a major version increment, non-breaking new features will cause a minor version increment, and bugfixes will cause a patch version increment. | ||
| This package follows Semantic Versioning `(major.minor.patch)`: | ||
|
|
||
| - Breaking changes always result in a major version increment. | ||
| - Non-breaking new features result in a minor version increment | ||
| - Bug fixes result in a patch version increment. | ||
|
|
||
| A full version changelog is available in the [changelog](/CHANGELOG.md) file. | ||
|
|
||
| ## Feedback and troubleshooting | ||
|
|
||
| If you run into any problems or have a feature request, open up a [new issue](https://github.com/stashgg/stash-unity/issues/new) in the repository. Please follow the issue/request template. | ||
| If you run into any problems or have a feature request, open up a [new issue](https://github.com/stashgg/stash-unity/issues/new) in the repository. Please follow the issue template. |