Hello! Welcome to the alpha version of SnekStudio. This is the software I've been using in production for streams since around 2022. It's "organically grown", so-to-speak. The code's a bit of a mess, but I've finally decided to make it open-source and available to everyone.
Anyway, this is just my way of saying the code will do psychic damage to you if you look too closely into my code crimes.
<3
Binary releases are available on GitHub for Linux and Windows.
SnekStudio is still in early development, so is lacking in documentation and might be not be as straight-forward to use as it could be. If you need help or want to help out, join the community through Discord or Matrix.
If you're on a platform for which there is no release yet (MacOS), want to tinker with SnekStudio, or write your own modules, here's how to go about that:
-
Clone the repository recursively.
git clone --recursive https://github.com/ExpiredPopsicle/SnekStudio.git- If you forget to clone recursively, run
git submodule initandgit submodule update. - When pulling the newest changes from SnekStudio, use
git pull --recurse-submodulesto ensure submodules (like TwitchGD4) get updated too.
- If you forget to clone recursively, run
-
Open the project in Godot
4.6.x. (Newer versions might not work.) -
Set up Python Standalone + its dependencies by clicking the "Python Builds" tab in the bottom panel, and clicking both "Download" buttons for your platform. This can freeze the editor while downloading, so give it some time.
-
Run SnekStudio from the editor with the "Run Project" button in the top right. On first launch, this can also take some time to download the needed Python modules. (Visual feedback will be added later.)
-
(optionally) Load up your own model. Note that only VRM 0.x models are currently supported. VRM 1.x will have serious issues.
-
Configure "MediaPipeController" (
Esc-> "Modules" -> "Mod list...") and select your video device. If there's similar entries, be sure to check the others if the first doesn't work.
-
Make a solution for 3D VTuber face/model tracking.
-
Make it free for everyone to use.
-
Make a fully open-source.
-
Make it as cross-platform.
- Supporting x86, AMD64, ARM, and other architectures.
- Supporting Linux and Windows, with possible Mac and limited web (HTML5) support down the road.
- Make it compatible with existing standards.
- Support VRM.
- Support VMC.
- Make it as accessible to everyone as possible.
- Minimal system hardware requirements.
- Make it last as long as possible.
- Do not tie ourselves to technologies at risk of becoming unsupported.
- Make the code clean, modular, and easily maintainable.
- Do not rely on native code with complex build environment requirements (eg other languages).
So many. Please please please use the bug reporting tools on Github.
We do not accept AI-genreted pull requests, and issues that are suspected to be written by AI are likely to be closed without comment.
All code used in SnekStudio must be written by a person.