{"id":23477433,"url":"https://github.com/rwth-acis/virtual-agents-framework","last_synced_at":"2025-04-14T20:22:13.289Z","repository":{"id":37023584,"uuid":"461241069","full_name":"rwth-acis/Virtual-Agents-Framework","owner":"rwth-acis","description":"This framework provides the architecture, assets and samples for creating own virtual agents, also called non-player characters (NPCs), in Unity.","archived":false,"fork":false,"pushed_at":"2024-04-13T23:11:44.000Z","size":21654,"stargazers_count":14,"open_issues_count":2,"forks_count":4,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-14T13:08:51.949Z","etag":null,"topics":["artificial-intelligence","npc","unity3d","virtual-agent"],"latest_commit_sha":null,"homepage":"https://rwth-acis.github.io/Virtual-Agents-Framework/","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":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}},"created_at":"2022-02-19T16:02:59.000Z","updated_at":"2024-04-15T16:04:31.166Z","dependencies_parsed_at":"2023-10-13T00:14:41.721Z","dependency_job_id":"f2acedeb-36d9-4d5a-9b85-75c5769e413b","html_url":"https://github.com/rwth-acis/Virtual-Agents-Framework","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2FVirtual-Agents-Framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2FVirtual-Agents-Framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2FVirtual-Agents-Framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2FVirtual-Agents-Framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rwth-acis","download_url":"https://codeload.github.com/rwth-acis/Virtual-Agents-Framework/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248952583,"owners_count":21188470,"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":["artificial-intelligence","npc","unity3d","virtual-agent"],"created_at":"2024-12-24T18:27:05.390Z","updated_at":"2025-04-14T20:22:13.267Z","avatar_url":"https://github.com/rwth-acis.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Virtual Agents Framework\n\n![Virtual Agents Framework](https://raw.githubusercontent.com/rwth-acis/Virtual-Agents-Framework/master/Logos/Logo_wide.png)\n\nA Unity package for creating virtual agents.\n\n![1.3.0](https://img.shields.io/badge/version-1.3.0-blue)\n\n[![openupm](https://img.shields.io/npm/v/com.i5.virtualagents?label=openupm\u0026registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.i5.virtualagents/)\n\nThis framework provides the architecture, assets and samples for creating own virtual agents, also called non-player characters (NPCs), in Unity.\n\n## Setup\n\nMinimum Unity version: 2020.3.\n\nThere are different ways to add the package to a project.\n\n### Alternative 1: OpenUPM using the Package Manager UI\n\nThe first option to install the package is to include it via Unity's package manager.\nHere, we first need to add a scoped registry which tells Unity that the package is hosted on [OpenUPM](https://openupm.com/packages/com.i5.virtualagents/?subPage=readme#).\nAfter that, we can add the package in Unity's package manager window.\n\n1. In Unity, go to Window \u003e Package Manager to open the package manager UI.\n2. In the right corner of the opened windows, click on the small cogwheel and select \"Advanced Project Settings\".\n3. Add a new scoped registry with the following values:\n\n| Field | Value(s) |\n| --- | --- |\n| Name: | `package.openupm.com` |\n| URL: | `https://package.openupm.com` |\n| Scope(s): | `com.i5.toolkit.core` \u003cbr/\u003e `com.i5.virtualagents` |\n\n4. Next, click the Save/Apply button.\n5. Close the settings window and return to the package manager window.\n6. Click the small plus button at the left top of the window.\n   Select \"\"Add package by name...\" or \"Add package from git URL...\" depending on your Unity version.\n7. Enter `com.i5.virtualagents` in the text field.\n8. If the package manager asks for a version number, enter the latest one, so `1.3.0`.\n9. Click the add button and wait for the download to finish.\n\nAs an alternative to steps 7 - 8, the package should also be available in the list if you switch the dropdown next to the plus button from \"Packages: Unity Registry\" to \"Packages: My Registries\".\nYou can then select the entry and click the \"Install\" button.\n\n### Alternative 2: OpenUPM with manifest.json file\n\nA second option is to directly edit the manifest.json file of your project.\nIn alternative 1, Unity performs this in the background, but you can also just copy-paste the necessary scoped registry definitions and add the package directly in the manifest.json file.\n\n1. Open a file explorer and navigation into your project's root folder (the folder which contains sub-directories like \"Assets\" or \"Library\").\n   Then, navigate into the \"Packages\" folder and open the \"manifest.json\" file.\n\nIntegrate the following json string into the manifest.json file:\n\n```\n{\n    \"scopedRegistries\": [\n        {\n            \"name\": \"package.openupm.com\",\n            \"url\": \"https://package.openupm.com\",\n            \"scopes\": [\n                \"com.i5.toolkit.core\",\n                \"com.i5.virtualagents\"\n            ]\n        }\n    ],\n    \"dependencies\": {\n        \"com.i5.virtualagents\": \"1.3.0\"\n    }\n}\n```\n\nIf your manifest.json file already contains a scopedRegistries array, make sure to add the entry to the existing one.\nIf your scopedRegistries array already contains an entry with the name \"package.openupm.com\", just add the given scopes to that list.\nIn that case, there is no need to create a second \"package.openupm.com\" entry.\n\nThe entry `\"com.i5.virtualagents\": \"1.3.0\"` can be inserted anywhere in the dependencies object with the other installed packages that are already listed there.\n\n### Alternative 3: Git Package\n\nYou can also directly include the package as a Git repository.\n\nFirst, you need to install the [i5 Toolkit for Unity](https://github.com/rwth-acis/i5-Toolkit-for-Unity) by following one of its [installation instructions in the readme file](https://github.com/rwth-acis/i5-Toolkit-for-Unity).\nThis step needs to happen first - otherwise there is an error message as Unity cannot resolve the dependency.\n\n1. In Unity, go to \"Window \u003e Package Manager\" to open the package manager window.\n2. Click the plus button in the top left corner and select \"Add package from git URL...\".\n3. Enter https://github.com/rwth-acis/Virtual-Agents-Framework.git#[version] into the text field where [version] is replaced with \"v\", followed by the release number, e.g. \"v1.3.0\" 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 and you will not be notified about updates automatically.\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## Quickstart Guide\n\nAs part of the documentation a quickstart guide can be found [here](https://rwth-acis.github.io/Virtual-Agents-Framework/1.2.1/manual/task-system.html).\n\n## Documentation\n\nCheck out the [documentation pages](https://rwth-acis.github.io/Virtual-Agents-Framework/) and select the version that you are using.\n\nYou can also find practical examples of features in the package's samples.\nTo access them, follow these steps:\n\n1. In Unity, go to \"Window \u003e Package Manager\".\n2. Make sure that the dropdown menu in the top left of the package manager window is set to \"Packages: In Project\".\n3. Click on the entry for the Virtual Agents Framework in the list.\n4. On the right side, expand the samples section.\n   Here, you can find a list of available examples.\n5. Click the import button to download the samples.\n   They are saved in your Assets folder in a folder \"Samples/Virtual Agents Framework/1.3.0\".\n\nUsually, each sample contains a sample scene as the starting point.\nWithin the scene, there is a documentation object, indicated by an information icon.\nIf you click on it, there are further descriptions about the scene in the inspector.\n\n## Licensing\n\nThe package's code is distributed under the [MIT license](https://github.com/rwth-acis/Virtual-Agents-Framework/blob/master/LICENSE).\n\nAll art assets (e.g. files located in the folders \"3D Models\" and \"Animations\" in the package's root folder) are distributed under the [Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/) license and are attributed to Benedikt Hensen unless stated otherwise.\n\n## Contributors\n\n### Code \u0026 Documentation:\n\n- Benedikt Hensen\n- Danylo Bekhter\n- Sebastian Meinberger\n- David Terhürne\n- Lena Linke\n\n### 3D Models \u0026 Animations:\n\n- Benedikt Hensen\n- David Terhürne\n\n## Related Projects\n\nThis framework uses the [i5 Toolkit for Unity](https://github.com/rwth-acis/i5-Toolkit-for-Unity) which provides building blocks and modules for general development with the Unity 3D engine.\nIf you want to use the virtual agents in mixed reality, check out our [i5 Toolkit for Mixed Reality](https://github.com/rwth-acis/i5-Toolkit-for-Mixed-Reality).\nIt is an extension package that builds upon the functionality of the i5 Toolkit for Unity and is optimized for mixed reality.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Fvirtual-agents-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frwth-acis%2Fvirtual-agents-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Fvirtual-agents-framework/lists"}