Skip to main content

koe live2d-py


Docker Build Version Python Version CMake C++17 CsmSDK

English README

注意:本仓库不包含 Live2D Cubism Core 及 Framework(受许可限制),源码编译时需自行从 Live2D官网 下载。

使用 Python 直接加载和操作 Live2D 模型,不通过 Web Engine 等间接手段进行渲染。

基于 Python C Extension 对 Live2D Native SDK (C++) 进行了封装。理论上,只要配置好 OpenGL 上下文,可在 Python 中将 live2d 绘制在任何基于 OpenGL 的窗口。

代码使用示例:examples

详细使用文档:Wiki

修改和开发:CONTRIBUTING

兼容UI库

理论上兼容所有能使用 OpenGL 进行绘制的UI库: Pygame / PyQt5 / PySide2 / PySide6 / GLFW / pyopengltk / FreeGlut / Qfluentwidgets ...

支持功能

  • 加载模型:Cubism 2.1 和 Cubism 3.0 及以上版本
  • 视线跟踪
  • 点击交互
  • 动作播放回调
  • 口型同步
  • 模型各部分参数控制
  • 各部件透明度控制
  • 精确到部件的点击检测

兼容性

Cubism Live2D 版本

live2d-py 支持的live2d模型 实现
live2d.v2 Cubism 2.1 以及更早的版本 纯 Python 实现
live2d.v2cpp Cubism 2.1 以及更早的版本 C++ 移植 (高性能)
live2d.v3 Cubism 3.0 及以上版本 Python C Extension 封装

推荐使用 live2d.v2cpp 替代 live2d.v2 以获得更好的性能。API 完全兼容,只需将 import live2d.v2 as live2d 替换为 import live2d.v2cpp as live2d。

Python 版本及平台

✅: 可用, 支持, 已通过

❓: 尚未测试

🚧, ❌: 编译期问题或平台兼容性问题待解决

Platform Python Version live2d.v2 live2d.v2cpp live2d.v3 PyPI
macOS arm64 >=3.11 ✅ ✅ ✅ ✅
Windows x64 >=3.11 ✅ ✅ ✅ ✅
Linux x64 >=3.11 ✅ ✅ ✅ ✅

注:

  • Cubism 2.X 导出的模型:文件名格式常为 XXX.moc,XXX.model.json,XXX.mtn
  • Cubism 3.0 及以上导出的模型:文件名格式常为 XXX.moc3,XXX.model3.json, XXX.motion3.json

使用说明

  1. 在 Release 中下载对应版本的 whl 文件并安装(推荐)
pip install live2d_py-0.X.X-cpXXX-cpXXX-win_amd64.whl
  1. 通过 PyPI 安装
pip install live2d-py
  1. 从源码构建,参考 安装#源码构建

示例

简易面捕

源码见 main_facial_bind.py

面捕-期末周破防

基于 live2d-py C 模块及 Qt 开发的 Live2DViewer

Live2DViewer

多模型加载

源码见 main_glfw_four_model.py

multi_model

添加背景

源码见 main_pygame_background.py

background

模型变换 & 口型同步音频 & 点击测试

源码见 main_glfw.py

完整用例

模型整体透明度示例

源码见 main_pyqt5_canvas_opacity.py

opacity

鸣谢

特别感谢以下用户为本项目提供的帮助和支持: 96bearli, Ovizro, AnyaCoder, jahtim, Honghe, RobertMeow, LUORANCHENG, TinyKiecoo, Barracuda72, GuangChen2333, makabakadot, thynetruly, mastwet, KyvYang, @Mozilla88, @CooperWang0912, @minghf85

非常感谢以下项目及其贡献者们的帮助:

CubismNativeSamples (live2d.v3)

Cubism2 Web SDK (live2d.v2)

de4js(JavaScript 反混淆工具)

JsConvert (Javascript 转 Python 工具)

D2Evil (moc 文件分析)

facial-landmarks-for-cubism (面捕参考)

nlohmann/json (v2cpp)

Live2D 模型:

Metadata

Release files for live2d-py 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for live2d-py 0.8.1
File Size Uploaded
live2d_py-0.8.1.tar.gz 7.1 MB Details

Built distributions (wheels)

Table of built distributions (wheels) for live2d-py 0.8.1
File
live2d_py-0.8.1-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details
live2d_py-0.8.1-cp311-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.11 abi3 Linux glibc 2.28+ x86-64, Linux glibc 2.27+ x86-64 Details
live2d_py-0.8.1-cp311-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl CPython 3.11 abi3 Linux glibc 2.27+ ARM64, Linux glibc 2.28+ ARM64 Details
live2d_py-0.8.1-cp311-abi3-macosx_26_0_universal2.whl CPython 3.11 abi3 macOS 26.0+ universal2 (ARM64, x86-64) Details

Total release size: 10.8 MB

Release files / live2d_py-0.8.1.tar.gz

Download URL live2d_py-0.8.1.tar.gz
Size 7.1 MB
Tags Source
SHA-256 checksum
How to use checksums
868a443f56a4841709f1cf6bd2a82c7769fceb06debb97fbb382f6a2ea86a81a
BLAKE2b-256 checksum
How to use checksums
452408075c68d24d73efd99732142500fe6ec9098649c7558e78b7aff7eafb9f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / live2d_py-0.8.1-cp311-abi3-win_amd64.whl

Download URL live2d_py-0.8.1-cp311-abi3-win_amd64.whl
Size 639.9 kB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
bbf66de1d3e7a4b23d1dd5a49e641468c734c97df28e36bbb900c948773a9d17
BLAKE2b-256 checksum
How to use checksums
f4fcc8faaa5e0beddb0d70b0f893f42a68139ba80d33cee0048bfceb96704b3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release files / live2d_py-0.8.1-cp311-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL live2d_py-0.8.1-cp311-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.2 MB
Tags CPython 3.11 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
399d26d858a2971b22676ce9a423dc7ebbecad9e04edf7bc5314d367fb2ef9e9
BLAKE2b-256 checksum
How to use checksums
44aa16928e7cb01ff6099698251703969373ce1ef67d9521096987ddc18ba725
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / live2d_py-0.8.1-cp311-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl

Download URL live2d_py-0.8.1-cp311-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl
Size 1.2 MB
Tags CPython 3.11 Linux glibc 2.27+ ARM64 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
3b421e5f563806534e3271320d6d4730f9e303f5943b975ff18f84720e57b956
BLAKE2b-256 checksum
How to use checksums
afb9f1ab7efabec446632d284c340353f9144feec1da88f9fc8ba47584767b14
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / live2d_py-0.8.1-cp311-abi3-macosx_26_0_universal2.whl

Download URL live2d_py-0.8.1-cp311-abi3-macosx_26_0_universal2.whl
Size 616.5 kB
Tags CPython 3.11 abi3 macOS 26.0+ universal2 (ARM64, x86-64)
SHA-256 checksum
How to use checksums
2bd8207376f3340d01358024e3b891c24a3fba293bb5a10d08314aa7cfc89bbe
BLAKE2b-256 checksum
How to use checksums
7d8655c440a0a50c8f9909f49e08cfa4b1adadd176ce6955b161198e14db6973
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release history Release notifications | RSS feed

1.0.0

5 release files

This release

0.8.1 This release

5 release files

0.8.0

2 release files

0.7.0

10 release files

0.6.1

10 release files

0.5.3

19 release files

0.5.2

16 release files

0.5.1

16 release files

0.5.0

16 release files

0.4.5

16 release files

0.4.4

17 release files

0.4.0

12 release files

0.3.6

12 release files

0.3.5

10 release files

0.3.4

10 release files

0.3.2

10 release files

0.3.1

7 release files

0.3.0

8 release files

0.2.5

7 release files

0.2.4

11 release files

0.2.2

7 release files

0.2.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page