README.md

Amica: Your friendly personal AI

If you like our project, please give us a star ⭐ on GitHub.

Amica allows you to converse with highly customizable 3D characters that can communicate via natural voice chat and vision, with an emotion engine that allows Amica to express feelings and more. Customize her any way you want with any AI technology.

Try Amica here on mobile, tablet or desktop

For Windows Users: Please create a new folder for Amica during installation to prevent the unintentional deletion of other files during uninstallation.

We just released Amica 1.2 with lots of new features. Docs will be further updated soon, watch the video to learn about what Amica 1.2 offers:

You can import VRM files, adjust the voice to fit the character, and generate response text that includes emotional expressions.

The various features of Amica mainly use and support the following technologies:

To see tutorials on configuring any of these with Amica please visit the official Amica documentation.

• 3D Rendering
  • three.js
• Displaying 3D characters
  • @pixiv/three-vrm
• Running Transformers in the browser
  • Transformers.js
• Speech recognition
  • Whisper
• Voice Activity Detection
  • Silero VAD
• ChatBot
  • Llama.cpp server
  • ChatGPT API (compatible with projects such as LM Studio)
  • Window.ai
  • Ollama
  • KoboldCpp
  • Oobabooga
  • OpenRouter (access to multiple AI models)
• Text-to-Speech
  • Eleven Labs API
  • Speech T5
  • OpenAI
  • Coqui (Local)
  • RVC
  • AllTalkTTS
• Vision
  • Bakllava

🛠️ Installation and running

To run this project locally, clone or download the repository.

git clone [email protected]:semperai/amica.git

Install the required packages.

npm install

After installing the packages, start the development web server using the following command:

npm run dev

Once started, please visit the following URL to confirm that it is working properly.

http://localhost:3000

📝 Configuration

Most of the configuration is done in the .env.local file. Reference the config.ts file for the available options.

OpenRouter Configuration

To use OpenRouter as a chat backend, set the following environment variables in your .env.local file:

• NEXT_PUBLIC_OPENROUTER_APIKEY: Your OpenRouter API key (required)
• NEXT_PUBLIC_OPENROUTER_URL: Custom OpenRouter API URL (optional, defaults to https://openrouter.ai/api/v1)
• NEXT_PUBLIC_OPENROUTER_MODEL: Default OpenRouter model (optional, defaults to openai/gpt-3.5-turbo)

amica
├── .env.local
├── src
│   ├── utils
│   │   └── config.ts

📦 Desktop Application

Amica uses Tauri to build the desktop application.

To develop the desktop application, use the following command:

npm run tauri dev

📖 Documentation

View the documentation for more information on how to configure and use Amica.

📜 History

This project originated as a fork of ChatVRM by Pixiv:

https://pixiv.github.io/ChatVRM

🔒 License

• The majority of this project is released under the MIT license as found in the LICENSE file.
• Assets such as 3D models and images are released under their authors respective licenses.

✨ Star History

🤗 Contributors