stashgg / stash-unity

📦 Stash plugin for Unity projects.

Home Page:https://docs.stash.gg/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Stash SDK for Unity buildtest

About

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.

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.

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, keep in mind that some of the samples in the playground repository might be out of date and should not be used 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.

Installation

Import package manually

  1. Download the latest build from the release page
  2. Import the .unitypackage file into your Unity game using the local asset package import 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.
  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. A full version changelog is available in the changelog file.

Feedback and troubleshooting

If you run into any problems or have a feature request, open up a new issue in the repository. Please follow the issue/request template.

About

📦 Stash plugin for Unity projects.

https://docs.stash.gg/


Languages

Language:ShaderLab 68.6%Language:C# 19.5%Language:HLSL 11.9%