{"id":23477617,"url":"https://github.com/rwth-acis/i5-toolkit-for-unity","last_synced_at":"2025-07-02T10:32:46.170Z","repository":{"id":37862707,"uuid":"239718625","full_name":"rwth-acis/i5-Toolkit-for-Unity","owner":"rwth-acis","description":"A collection of common tools and features which can be reused in Unity projects","archived":false,"fork":false,"pushed_at":"2025-06-14T16:58:00.000Z","size":74275,"stargazers_count":68,"open_issues_count":8,"forks_count":18,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-06-14T17:35:01.770Z","etag":null,"topics":["unity","upm"],"latest_commit_sha":null,"homepage":"https://rwth-acis.github.io/i5-Toolkit-for-Unity","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/rwth-acis.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"Contributing.md","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":"2020-02-11T09:04:09.000Z","updated_at":"2025-05-24T20:14:30.000Z","dependencies_parsed_at":"2024-03-05T16:41:33.993Z","dependency_job_id":"772f1f20-00f3-4187-b74f-f2d5239132f4","html_url":"https://github.com/rwth-acis/i5-Toolkit-for-Unity","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/rwth-acis/i5-Toolkit-for-Unity","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fi5-Toolkit-for-Unity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fi5-Toolkit-for-Unity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fi5-Toolkit-for-Unity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fi5-Toolkit-for-Unity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rwth-acis","download_url":"https://codeload.github.com/rwth-acis/i5-Toolkit-for-Unity/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2Fi5-Toolkit-for-Unity/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263121018,"owners_count":23416923,"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":["unity","upm"],"created_at":"2024-12-24T18:27:48.954Z","updated_at":"2025-07-02T10:32:46.159Z","avatar_url":"https://github.com/rwth-acis.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# i5 Toolkit for Unity\n\n![i5 Toolkit for Unity](https://raw.githubusercontent.com/rwth-acis/i5-Toolkit-for-Unity/develop/Logos/Logo%20wide.svg)\n\nThis toolkit contains a collection of features which can be reused in Unity projects.\nIt is a foundation for new projects, kickstarting the development with already completed tools.\n\n![Continuous Integration](https://github.com/rwth-acis/i5-Toolkit-for-Unity/workflows/Continuous%20Integration/badge.svg)\n\n![1.9.6](https://img.shields.io/badge/version-1.9.6-blue)\n\n[![openupm](https://img.shields.io/npm/v/com.i5.toolkit.core?label=openupm\u0026registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.i5.toolkit.core/)\n\n## Modules\n\nThe i5 Toolkit provides a series of modules and features that can be used in projects.\n\n\u003ctable style=\"text-align: center; vertical-align: middle\"\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/App-Console.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/AppConsole.svg\" alt=\"App Console\" style=\"width:200px\"/\u003e\u003cbr/\u003eApp Console\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Deep-Linking.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/DeepLink.svg\" alt=\"Deep Link\" style=\"width:200px\"/\u003e\u003cbr/\u003eDeep Link\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Experience-API.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/ExperienceAPI.svg\" alt=\"Experience API\" style=\"width:200px\"/\u003e\u003cbr/\u003eExperience API\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/File-Cache.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/FileCache.svg\" alt=\"File Cache\" style=\"width:200px\"/\u003e\u003cbr/\u003eFile Cache\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Modified-3D-Objects.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/RoundedCorners.svg\" alt=\"Modified 3D Objects\" style=\"width:200px\"/\u003e\u003cbr/\u003eModified 3D Models\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Object-Pool.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/ObjectPool.svg\" alt=\"Object Pool\" style=\"width:200px\"/\u003e\u003cbr/\u003eObject Pool\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Obj-Importer.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/ObjImporter.svg\" alt=\"Obj Importer\" style=\"width:200px\"/\u003e\u003cbr/\u003eObj Importer\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/OpenID-Connect-Client.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/OpenIDConnectClient.svg\" alt=\"OpenID Connect Client\" style=\"width:200px\"/\u003e\u003cbr/\u003eOpenID Connect Client\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Procedural-Geometry.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/ProceduralGeometry.svg\" alt=\"Procedural Geometry\" style=\"width:200px\"/\u003e\u003cbr/\u003eProcedural Geometry\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/RocketChat-Client.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/RocketChatClient.svg\" alt=\"Rocket.Chat Client\" style=\"width:200px\"/\u003e\u003cbr/\u003eRocket.Chat Client\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Scene-Documentation.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/SceneDocumentation.svg\" alt=\"Scene Documentation\" style=\"width:200px\"/\u003e\u003cbr/\u003eScene Documentation\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Service-Core.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/ServiceCore.svg\" alt=\"Service Core\" style=\"width:200px\"/\u003e\u003cbr/\u003eService Core\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Spawner.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/Spawner.svg\" alt=\"Spawner\" style=\"width:200px\"/\u003e\u003cbr/\u003eSpawner\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Verbose-Logging.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/Verbose-Logging.svg\" alt=\"Verbose Logging\" style=\"width:200px\"/\u003e\u003cbr/\u003eVerbose Logging\u003c/a\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ca href=\"https://rwth-acis.github.io/i5-Toolkit-for-Unity/1.9.6/manual/Version-Tool.html\"\u003e\u003cimg src=\"Documentation/resources/Logos/Version-Tool.svg\" alt=\"Version Tool\" style=\"width:200px\"/\u003e\u003cbr/\u003eVersion Tool\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n## Setup\n\nMinimum Unity version: 2019.4.\n\nThere are different ways to add the package to a project.\n\nYou can follow the step-by-step instructions below or watch the [video tutorial](https://youtu.be/VtJUG7-GWM0) with installation instructions.\n\n\n### Alternative 1: Unity Dependency File with OpenUPM (Recommended)\n\nThe toolkit can be loaded using Unity's package manager.\nTo do this, add an entry to the dependency file:\n\n1. Open your project's root folder in a file explorer.\n2. Navigate to the Packages folder and open the file manifest.json.\n   It contains a list of package dependencies which are loaded into the project.\n3. Add a scoped registry definition which tells Unity to look at the given URL for the package.\n   ```\n   {\n     \"name\": \"com.i5.toolkit.core\",\n     \"url\": \"https://package.openupm.com\",\n     \"scopes\": [\n       \"com.i5.toolkit.core\"\n     ]\n   }\n   ```\n\n4. To add a specific version of the tool to the dependencies, add the following line inside of the \"dependencies\" object and replace [version] by the release number, e.g. \"1.9.6\".\n   `\"com.i5.toolkit.core\": \"[version]\",`\n   After that, Unity will automatically download and import the package.\n\nSo, after completing these steps you should have a manifest.json file which looks like this:\n\n```\n{\n  \"scopedRegistries\": [\n    {\n      \"name\": \"com.i5.toolkit.core\",\n      \"url\": \"https://package.openupm.com\",\n      \"scopes\": [\n        \"com.i5.toolkit.core\"\n      ]\n    },\n    ... some more scoped registries\n    ],\n    \"dependencies\": {\n        \"com.i5.toolkit.core\":  \"1.9.6\",\n        ... some more packages\n    }\n}\n```\n\n### Alternative 2: Unity Dependency File with Git (Recommended)\n\nThe toolkit is available as a package for the Unity Package Manager.\nIt can be included in new projects by referencing the git-repository on GitHub in the dependency file of the Unity project:\n\n1. Open your project's root folder in a file explorer.\n2. Navigate to the Packages folder and open the file manifest.json.\n   It contains a list of package dependencies which are loaded into the project.\n3. To add a specific version of the tool to the dependencies, add the following line inside of the \"dependencies\" object and replace [version] with \"v\", followed by the release number, e.g. \"v1.9.6\".\n   To receive the latest version, replace [version] with upm.\n   `\"com.i5.toolkit.core\": \"https://github.com/rwth-acis/i5-Toolkit-for-Unity.git#[version]\",`\n   After that, Unity will automatically download and import the package.\n\nIf you specify \"upm\" to get the latest version, be aware that the package is not automatically updated.\nThis command just pulls the latest version which is available at that time.\nTo update to the newest current version, remove the package again and re-download it.\n\n### Alternative 3: Unity Package Manager UI with Git\n\nThe package can be downloaded from a git-repository in the package manager's UI.\n\n1. In Unity, go to Window \u003e Package Manger.\n2. Click on the plus-button in the top left corner of the package manager and select \"add\".\n3. Enter https://github.com/rwth-acis/i5-Toolkit-for-Unity.git#[version] into the text field where [version] is replaced with \"v\", followed by the release number, e.g. \"v1.9.6\" or upm for the latest version.\n   Confirm the download by clicking on the \"add\" button.\n\nIf you specify \"upm\" to get the latest version, be aware that the package is not automatically updated.\nThis command just pulls the latest version which is available at that time.\nTo update to the newest current version, remove the package again and re-download it.\n\n### Alternative 4: Import using the OpenUPM command line interface\n\nDocumentation about the OpenUPM CLI can be found [here](https://openupm.com/docs/getting-started.html#installing-openupm-cli).\n\n1. Intall the command line interface.\n2. Navigate to your Unity project's folder.\n   This is the folder which also contains folders such as *Assets* or *Packages*.\n3. Enter the command `openupm add com.i5.toolkit.core`.\n\n### Alternative 5: Import custom package\n\nAnother option is to import the package as a .unitypackage.\n\n1. Download the .unitypackage-file which is supplied with the corresponding release on the releases page.\n2. With your project opened, perform a right-click on the assets browser in Unity. Select \"Import Package \u003e Custom Packge\" from the context menu.\n3. Navigate to the path where you downloaded the .unitypackage-file, select it and confirm by clicking the \"Open\" buttom\n4. A dialog window opens where you can select which files should be imported. Select everything and click on \"Import\".\n\nImportant for this alternative: If you are updating from an earlier version, it is recommended to delete the existing \"i5 Toolkit\" folder.\nAfter that, import the new package.\n\n## Example Scenes\n\nThe different modules and features are presented in example scenes which can be found in the [GitHub repository](https://github.com/rwth-acis/i5-Toolkit-for-Unity).\nYou can use the example scenes as an interactive documentation, an experimentation playground and to test the features.\n\n## Unit Tests\nThe project is tested using Unit tests.\nContinuous integration using GitHub Actions has been set up to test and deploy new versions of the package.\n\n## Related Projects\n\nFor Mixed Reality development, also check out the [i5 Toolkit for MR](https://github.com/rwth-acis/i5-Toolkit-for-Mixed-Reality).\nIt is an extension package that builds upon the functionality of this package and is optimized for Mixed Reality.\n\nIf you are working with non-player characters (NPCs), virtual agents or mixed reality agents, take a look at the [Virtual Agents Framework](https://github.com/rwth-acis/Virtual-Agents-Framework).\nIt provides a foundation for building virtual humans and modeling their behavior in a configurable way.\n\n## Disclaimer\n\nThis repository is not sponsored by or affiliated with Unity Technologies or its affiliates.\n\"Unity\" is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Fi5-toolkit-for-unity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frwth-acis%2Fi5-toolkit-for-unity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Fi5-toolkit-for-unity/lists"}