Skip to content

Commit

Permalink
Added ReadMe and assets
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshLmao committed Oct 22, 2018
1 parent 774e4c3 commit bffc21b
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 1 deletion.
36 changes: 36 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[Ll]ibrary/
[Tt]emp/
[Oo]bj/
[Bb]uild/
[Bb]uilds/
Spotify4Unity/Assets/AssetStoreTools*

# Visual Studio cache directory
.vs/

# Autogenerated VS/MD/Consulo solution and project files
ExportedObj/
.consulo/
*.csproj
*.unityproj
*.sln
*.suo
*.tmp
*.user
*.userprefs
*.pidb
*.booproj
*.svd
*.pdb
*.opendb

# Unity3D generated meta files
*.pidb.meta
*.pdb.meta

# Unity3D Generated File On Crash Reports
sysinfo.txt

# Builds
*.apk
*.unitypackage
64 changes: 63 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,63 @@
Spotify4Unity
<h1 align="center">
<br>
Spotify4Unity
</br>
</h1>

<p align="center">
<a href="https://twitter.com/_JShepherd">
<img src="https://img.shields.io/badge/twitter-__JShepherd-blue.svg?style=flat-square" alt="twitter"/>
</a>
<a href="https://paypal.me/ijoshlmao">
<img src="https://img.shields.io/badge/donations-_£-brightgreen.svg?style=flat-square" alt="donations"/>
</a>
<a href="http://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square" alt="MIT license"/>
</a>
<a href="https://github.com/joshLmao/spotify4Unity/releases">
<img src="https://img.shields.io/badge/release-v1.0-green.svg?style=flat-square" alt="releases"/>
</a>
<a href="https://github.com/joshLmao/spotify4Unity/wiki">
<img src="https://img.shields.io/badge/documentation-online-brightgreen.svg?style=flat-square" alt="documentation"/>
</a>
</p>

<p align="center">
<a href="#quick-start">Quick Start</a> •
<a href="#examples">Examples</a> •
<a href="#donations">Donations</a>
</p>

Spotify4Unity is a plugin which helps you integrate Spotify connectivity into you Unity game/application easily, allowing users to use basic track control functionality to viewing their whole library. This plugin relies heavily on JohnnyCrazy's [SpotifyAPI-NET](https://github.com/JohnnyCrazy/SpotifyAPI-NET)

Check out more and the full and maintained documentation [on the Wiki](https://github.com/JoshLmao/Spotify4Unity/wiki) _(Updated regularly)_

![Spotify4Unity Demo Video](repository_assets/demo.gif)

## Requirements

1. Unity 2018.2.0f2 or above
2. Scripting Runtime Version: .NET 4.6
3. Use with Windows, Mac & Linux (Android/iOS **NOT** _currently_ supported)

## Important Note

**For you to set playback, the logged in user needs to be premium**. If the user isn't, the API only allows you to get what is publicly availble like songs, playlists, user information, etc.

## Quick Start

Check [the Home wiki page](https://github.com/JoshLmao/Spotify4Unity/wiki#Quick_Setup:) on how to quickly get started with Spotify4Unity!

## Examples

If anyone has an usage examples in any projects, [send me a message on Twitter](https://twitter.com/_JShepherd) so I can fill this section with your work! _(With your permission, of course)_

## License

Spotify4Unity is available under the [Fair Source License](https://fair.io/). Check the [License](LICENSE) for more information

## Donations

If you want to support my plugin and my works, please consider buying me a coffee (or two! ;D)

[![Donate Link](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://paypal.me/ijoshlmao)
Binary file added repository_assets/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bffc21b

Please sign in to comment.