Vanling

Warning

This project is being developed,all the things is not stable.

Purpose

To learn the rust programming language,voice interaction and large language model.

To make an self contained chatbot(self host all component,eg: llm,tts etc..), like xiaozhi-esp32 with self host server.

Features

• Connection: websocket
• Voice interaction: VAD,ASR,TTS
• Chat: LLM
• MCP: self host/remote server mcp,device mcp
• Backend
  1. home page(WIP)
  2. admin console(WIP)
  3. simulation deivce in web(WIP)
• Deploy: bin(WIP),docker(WIP)
• Compatible devices
  1. xiaozhi-esp32(WIP)
  2. vanling (cross platform app,create by flutter)(WIP)

Documentation

You can find user guide documentation on here.

You can find user development documentation on here.

Quick start

Development

apps/server

moon run server-ui:build
moon run server:downloader-install
moon run server:run

# with CUDA, in place of the last line (moon cannot forward --features):
cd apps/server && cargo run -p vanling-server --features cuda -- \
  -O 'address=0.0.0.0' -O 'data_dir=../../data' --config=application.toml

• Access home page http://127.0.0.1:3000
• Access admin console http://127.0.0.1:3000/login
  • default account: root/Change_Me
• Access api documentation http://127.0.0.1:3000/docs
• Access device test page http://127.0.0.1:3000/test/device/test_page.html
• Client setting
  • ota url http://127.0.0.1:3000/api/ota/
  • ws url ws://127.0.0.1:3000/vanling/v1/

apps/server-ui

pnpm i
moon run server-ui:dev

apps/app

TODO

Building

TODO

Using

TODO

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

Note

1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
2. If you have found a vulnerability in the project, please write privately to lastsunday@yeah.net. Thanks!

FAQ

See the FAQ file

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Further information

Looking for an overview of the interface? Check it out!

Login/Register Page

TODO

User Dashboard

TODO

AI-Assisted Development

Part of the code and documentation in this project was generated with the assistance of AI tools. All AI-generated content has been reviewed and modified by the project maintainer.

• OpenCode (Big Pickle,DeepSeek V4 Flash)

Thanks

https://github.com/78/xiaozhi-esp32

https://github.com/xinnan-tech/xiaozhi-esp32-server

https://github.com/joey-zhou/xiaozhi-esp32-server-java