ChatVRM is a project primarily intended for technology sharing and demonstration purposes.
This repository was archived with the code as of 2024-07-18. If you would like to make changes to ChatVRM in the future, we would appreciate it if you could fork it and develop it.
We have also released a related project, local-chat-vrm. local-chat-vrm is an application that generates response messages and text-to-speech in a browser. However, it only supports English responses; Japanese is not available.
ChatVRM is a demo application that allows you to easily converse with a 3D character in your browser.
You can import a VRM file to customize the voice to match the character, generate response messages that include emotional expressions, and more.
ChatVRM's features primarily use the following technologies.
- Recognizing user speech
- Web Speech API (SpeechRecognition)
- Generating response text
- ChatGPT API
- Generating text-to-speech
- Koemotion/Koeiromap API
- Displaying 3D characters
- @pixiv/three-vrm
To run locally, clone or download this repository.
git clone git@github.com:pixiv/ChatVRM.gitInstall the required packages.
npm installAfter the package installation is complete, start the development web server with the following command:
npm run devAfter execution, access the following URL to confirm operation.
ChatVRM uses the ChatGPT API to generate responses.
For ChatGPT API specifications and terms of use, please refer to the following link or the official website.
- https://platform.openai.com/docs/api-reference/chat
- https://openai.com/policies/api-data-usage-policies
ChatVRM uses Koeiromap API from Koemotion to read responses aloud.
For Koeiromap API specifications and terms of use, please see the following link or the official website.