Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mos9527/sssekai_blender_io

Project SEKAI Blender Asset Importer / PJSK 资源导入插件
https://github.com/mos9527/sssekai_blender_io

3d blender sekai unity unitypy

Last synced: about 2 months ago
JSON representation

Project SEKAI Blender Asset Importer / PJSK 资源导入插件

Host: GitHub
URL: https://github.com/mos9527/sssekai_blender_io
Owner: mos9527
License: mit
Created: 2024-01-17T09:15:28.000Z (12 months ago)
Default Branch: master
Last Pushed: 2024-10-16T00:47:10.000Z (3 months ago)
Last Synced: 2024-10-17T13:04:06.280Z (3 months ago)
Topics: 3d, blender, sekai, unity, unitypy
Language: Python
Homepage: https://github.com/mos9527/sssekai
Size: 8.45 MB
Stars: 10
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# sssekai_blender_io
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Blender asset importer for Project SEKAI (JP: プロジェクトセカイカラフルステージ！ feat.初音ミク) asset bundles.

Tested on Blender `4.0.3`, `4.2.0 Alpha`, `4.2.0 LTS`, `4.3.0 Alpha`

# Importer Features
* Textures
* Character Toon Material (via [SekaiShaderStandalone](https://github.com/mos9527/sssekai_blender_io/blob/master/assets/SekaiShaderStandalone.blend))
* Static/Skinned Meshes
* Armatures
* Articulations (Scene rebuilt with Empty object and static meshes)
* Physics (WIP. Limited support for Rigidbodies, Colliders, and Spring Bones)
* Animations (Armatures, Articulations, BlendShape, Camera. From `live_pv` and `streaming_live` assets)

# Supported Languages
PRs are welcome for additions.
- You can find the translation file [here](https://github.com/mos9527/sssekai_blender_io/tree/master/translations.py).
- The script used to generate the translation file is [here](https://github.com/mos9527/sssekai_blender_io/tree/master/translations_codegen.py). Run this in the root of this repo, with any Python 3.8+ interpreter to update the translation file. Exisiting translations will be preserved.

You can find your language code by entering `bpy.app.translations.locale` in the Blender Python console.

Currently supported languages and maintainers:
- English (en_US, mos9527)
- 简体中文 (zh_HANS, mos9527)

# Installing & Updating
## Install the dependencies
- Navigate to your Blender installation path, and find the Python interperter of your version. (e.g. `C:\Program Files (x86)\Steam\steamapps\common\Blender\4.0\python\bin\python.exe`)
- ...and no, managing your Blender installation with Steam isn't recommended.
- (For Windows) It is recommended, however,to use the portable ZIP package instead of the MSI installer for your blender installation to avoid file permission issues
- In its working directory (i.e. `...\python\bin`), run the following (**in a command prompt**. In Windows you can press Shift+Mouse Right Click to open up a new Terminal/Powershell Prompt)
```bash
.\python -m ensurepip
.\python -m pip install --no-user -U sssekai
```
- **Make sure** the scripts are deployed to your **Blender** instance.
- Run `.\python.exe -m pip show sssekai` and look for the `Location` field. It should be in your Blender's Python `Scripts` directory.
```bash
Name: sssekai
Version: 0.4.4
Summary: Project SEKAI Asset Utility / PJSK 资源下载 + Live2D, Spine, USM 提取
Home-page: https://github.com/mos9527/sssekai
Author: greats3an
Author-email: [email protected]
License:
Location: C:\Program Files (x86)\Steam\steamapps\common\Blender\4.2\python\Lib\site-packages
Requires: coloredlogs, msgpack, pycryptodome, python-json-logger, requests, tqdm, unitypy, wannacri
Required-by:
```
- If Location mismatched
- Specifying `--no-user` can help to avoid this issue
- This is most commonly introduced when the script deployed to the user installation directory, such as `C:\Users\mos9527\AppData\Roaming\Python\Python311`, due to permission issues
- On Windows - this could happen if your Blender instance is installed via the offical MSI installer **and** installing it in the `Program Files` directory. Without admin rights, the script will be installed in the user directory - which **cannot** be accessed by Blender.
- Uninstall `sssekai`, **and** its dependencies
- This could be tricky. However, if the package are installed in the user directory, you can simply delete the entire user directory (`C:\Users\mos9527\AppData\Roaming\Python\Python311` in the example)
- Or, to uninstall it one by one:
```powershell
.\python -m pip freeze sssekai > ~\sssekai.txt
.\python -m pip uninstall -r ~\sssekai.txt
```
You may want to expand `~` to your actual user directory.
- With a **elevated shell** (e.g. `Win + X -> Terminal/Powershell (Admin)`), navigate to your Blender Python path again, and reinstall with `.\python -m pip install -U sssekai`
## Install the addon
- Download [this repo as zip](https://codeload.github.com/mos9527/sssekai_blender_io/zip/refs/heads/master)
- In Blender, go to `Edit > Preferences > Add-ons > Install...` and select the zip file you just downloaded.
- The addon should appear in the 3D Viewport sidebar (N key) under the tab `SSSekai`

# Documentation
See the [wiki page!](https://github.com/mos9527/sssekai_blender_io/wiki)

# Notes
The plugin is observed to work with other Unity games as well. But such compatibility is not guaranteed, and WILL NOT receive support from the author in full capacity.

# License
MIT

# References
- https://github.com/K0lb3/UnityPy
- https://github.com/KhronosGroup/glTF-Blender-IO
- https://github.com/theturboturnip/yk_gmd_io
- https://github.com/SutandoTsukai181/yakuza-gmt-blender
- https://github.com/UuuNyaa/blender_mmd_tools
- https://github.com/Pauan/blender-rigid-body-bones
- https://zhuanlan.zhihu.com/p/411188212
- https://zhuanlan.zhihu.com/p/337944099
- https://zhuanlan.zhihu.com/p/670837192
- https://github.com/przemir/ApplyModifierForObjectWithShapeKeys