Gameframe.Giphy 👋

[![Codacy Badge](https://camo.githubusercontent.com/0ddee4f6cfb6b10024cf3ca9762a10cdb9672fe9/68747470733a2f2f6170702e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3562356635343039616436663463623861656136636434306234353761353566)](https://www.codacy.com/manual/coryleach/UnityGiphy?utm_source=github.com&utm_medium=referral&utm_content=coryleach/UnityGiphy&utm_campaign=Badge_Grade) ![GitHub release (latest by date including pre-releases)](https://camo.githubusercontent.com/03fe2722502d123e9270e282f70b4adefeb00b51/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f636f72796c656163682f556e69747947697068793f696e636c7564655f70726572656c6561736573) [![openupm](https://img.shields.io/npm/v/com.gameframe.giphy?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.gameframe.giphy/) [![license](https://camo.githubusercontent.com/cc4ea7534b1837256bf50d82362fd4cfdf1ee6b3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f636f72796c656163682f556e6974794769706879)](https://github.com/coryleach/UnityGiphy/raw/master/LICENSE) This package contains a simple implementation of the Giphy API required to display random Gif images in Unity as MP4 videos. This package does not provide a means to display a gif directly but does provide urls to gif version of the images. Instead this package uses the mp4 links provided by giphy's api to display the gifs as movies ## Quick Package Install #### Using UnityPackageManager (for Unity 2019.3 or later) Open the package manager window (menu: Window > Package Manager)
Select "Add package from git URL...", fill in the pop-up with the following link:
https://github.com/coryleach/UnityGiphy.git#2.0.0
#### Using UnityPackageManager (for Unity 2019.1 or later) Find the manifest.json file in the Packages folder of your project and edit it to look like this: ```js { "dependencies": { "com.gameframe.giphy": "https://github.com/coryleach/UnityGiphy.git#2.0.0", ... }, } ``` #### Using OpenUPM The package is available on the [openupm registry](https://openupm.com/packages/com.gameframe.giphy/). It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli#openupm-cli). ``` openupm add com.gameframe.giphy ``` ## Usage To get started you must create an app and get an API key on the https://developers.giphy.com/ website.
Create your GiphyConfig asset by using the Create->Gameframe->Giphy->Config in the project tab's Create menu.
Once you have created your GiphyConfig asset you should add your API key to it that you got from the Giphy developer website.
You can use your config asset and the demo scene included in this package to get started. This library provides a GiphyRawImageController component that can be used with RawImage and VideoPlayer for displaying random giphy images in your UI but example API code is also shown below. ```C# //You can make basic queries to Giphy using the API provide in the GiphyQuery class. //As of this writing only Random and Search endpoints are supported. //For more info on the query results please see the following documentation // https://developers.giphy.com/docs/api/endpoint //Example code that loads a random image and plays it as a video public async void ShowRandomImage() { //Get a single random result var randomResult = await GiphyQuery.Random(apiKey,searchKeywords); //Display the random image result using Unity's video player videoPlayer.source = VideoSource.url; videoPlayer.url = randomResult.result.data.images.original_mp4.mp4; videoPlayer.Play(); } ``` ## Author 👤 **Cory Leach** * Twitter: [@coryleach](https://twitter.com/coryleach) * Github: [@coryleach](https://github.com/coryleach) ## Show your support Give a ⭐️ if this project helped you! *** _This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_