{"id":21482085,"url":"https://github.com/vitrivr/cineastunityinterface","last_synced_at":"2026-04-06T03:02:30.105Z","repository":{"id":38109705,"uuid":"169209956","full_name":"vitrivr/CineastUnityInterface","owner":"vitrivr","description":"Unity3D for Cineast Restful APIs","archived":false,"fork":false,"pushed_at":"2024-05-16T10:20:11.000Z","size":3160,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-16T11:32:26.365Z","etag":null,"topics":["cineast","rest-client","unity","unity3d","upm"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vitrivr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-05T08:27:15.000Z","updated_at":"2023-01-05T13:01:30.000Z","dependencies_parsed_at":"2023-11-28T09:46:28.535Z","dependency_job_id":null,"html_url":"https://github.com/vitrivr/CineastUnityInterface","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitrivr%2FCineastUnityInterface","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitrivr%2FCineastUnityInterface/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitrivr%2FCineastUnityInterface/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitrivr%2FCineastUnityInterface/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitrivr","download_url":"https://codeload.github.com/vitrivr/CineastUnityInterface/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226043469,"owners_count":17564837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cineast","rest-client","unity","unity3d","upm"],"created_at":"2024-11-23T12:29:51.071Z","updated_at":"2026-04-06T03:02:25.069Z","avatar_url":"https://github.com/vitrivr.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cineast Unity Interface\n\nA Unity Package Manager package for the Cineast OpenAPI RESTful API (current compatibility for Cineast 3.11.1 and equivalent).\nSee [Cineast](https://github.com/vitrivr/cineast) for further API information.\n\n## Prerequisites\n\nThis package provides a Unity endpoint for vitrivr's Cineast RESTful API.\nThus, a running Cineast instance is a requirement for this package to work.\n\nFor a guide on how to setup cineast, please see [Cineast's Github page](https://github.com/vitrivr/cineast).\n\n## Usage -- Unity\n\nTo use this package in Unity, the `manifest.json` has to be expanded by the following entry:\n\n```json\n\"com.vitrivr.unityinterface.cineastapi\": \"https://github.com/vitrivr/CineastUnityInterface.git\"\n```\n\nThe Unity Package Manager (_upm_) will take care of downloading and linking this package.\n\n### Versions\n\nThis package uses [semver](https://semver.org). It is recommended to manually specify a version in the packages manifest entry.\nThe package was tested with Unity 2020.3 LTS.\n\n## Usage -- Developer\n\nThis is a Unity3d project setup to easily develop (and test) the Unity3d Cineast Interface.\nWe strongly recommend cloning this repository into the `Packages` directory of a Unity shell project to make development and generation of `.meta` files easier.\n\n1. If necessary, update the OpenApi Specs (OAS) of vitrivr. Reade more in [Generate OpenApi Dependencies](#generate-openapi-dependencies).\n2. To test your changes and generate the **required** `.meta` files for any files you may have added, import the root directory of this repository into a Unity project as a local package with the `file:` method.\n3. Do not forget to create a PR of your work to include it in the main branch.\n\n### Generate OpenAPI Dependencies\n\nFollow these steps to generate / update the cineast OAS. We provide the latest generation in this repo for convenience.\n\nFor unix systems, the build requires an installation of the [.NET Core SDK](https://dotnet.microsoft.com/), [wget](https://www.gnu.org/software/wget/) and [mono](https://www.mono-project.com). Mono and wget are available through [homebrew](https://brew.sh) on mac.\n\n1. Issue the following `gradle` command:\n   ```\n   $\u003e ./gradlew clean deploy tidy\n   ```\n2. (Android Only) Delete the file `Runtime/Libs/Newtonsoft.Json.dll`.\n3. Generate the **required** `.meta` files for generated files by importing the root directory of this repository into a Unity project as a local package with the `file:` method.\n\n\u003e _Notice_\n\u003e These steps were tested under Windows 10 64bit, using OpenJDK 11 and Gradle 6.1.1. The publish script was tested with python 3.8.2.\n\u003e While these scripts are written with platform independence in mind, they might not work as expected.\n\n## Contribution\n\nOne can contribute to this project by submitting a PR.\n\n## Contribtors\n\n * Loris Sauter \u003cloris.sauter@unibas.ch\u003e\n * Florian Spiess \u003cflorian.spiess@unibas.ch\u003e\n\n## License\n\nThis work is licensed under the MIT open source license. Please refer to the LICENSE file.\n\n## Credits\n\n * Credits go to @neogeek, his [Tutorial](https://github.com/neogeek/unity-package-example) lead to the transformation to a proper _upm_ package.\n * Credits go to @SamuelBoerlin, his [first steps](https://github.com/SamuelBoerlin/Cineast-OpenAPI-Implementation) with Cineast and OpenAPI helped a lot.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitrivr%2Fcineastunityinterface","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitrivr%2Fcineastunityinterface","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitrivr%2Fcineastunityinterface/lists"}