Skip to content

Commit b610128

Browse files
committed
Update README.md
1 parent 48001cc commit b610128

File tree

1 file changed

+35
-23
lines changed

1 file changed

+35
-23
lines changed

README.md

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,50 @@
11

22
![Babble Logo](https://github.com/SummerSigh/ProjectBabble/blob/SummerSigh-patch-4/Babble.png?raw=true)
33

4-
# Table of Contents
5-
- [What is Babble?](#what-is-babble)
4+
<h3 align="center">
5+
Project Babble is an open-source mouth tracking project designed to work with any VR headset. We strive to make our models robust to different lighting, cameras, image qualities and facial structures!
6+
</h3>
7+
8+
## Table of Contents
69
- [Features](#features)
7-
- [How do I set it up?](#setup-more-detailed-wiki-and-setup-video-coming-soon)
8-
- [Useful Links](#useful-links)
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Links](#links)
913

10-
11-
## What is Babble?
12-
13-
<p align="center">
14-
Babble is an opensource mouth tracking project designed to work with any existing VR headset. We strive to make our models robust to different lighting, cameras, image qualities, and facial structures!
15-
</p>
16-
1714
## Features
1815
- 100% Opensource! 🌟
1916
- Fast and robust! 🚀
2017
- Works with most existing blendshape standards! ⚙️
2118
- Constantly updated and modified! 🔧
2219

23-
## Setup (More detailed wiki and setup video coming soon!)
24-
To install babble is fairly simple! Head over to the releases tab and download the EXE located there. Run the EXE and install babble! After that, you can test with a USB WEBCAM by doing the following steps:
20+
## Installation
21+
### Windows
22+
Head to the releases section and [download the latest installer](https://github.com/Project-Babble/ProjectBabble/releases/latest).
23+
24+
### Linux
25+
Copy, paste and run the following script into the terminal of your choice:
26+
27+
```bash -c "$(curl -fsSL https://gist.githubusercontent.com/dfgHiatus/a92a3caae24c1bfab1c7544537a654c5/raw/494a4bc5ed6c97745c7a283661d2f5530ba3d949/project-babble-install.sh)"```
28+
29+
Once it's finished installing, you can update and run the Babble app by typing `babble-app` into your terminal.
30+
31+
*You should also be able to run the Windows executable through Wine!*
32+
33+
#### Note:
34+
If you recieve a `ModuleNotFoundError: No module named 'tkinter'` error message on run, you'll need to install `tkinter` for your distro:
35+
- For Ubuntu or other distros with apt:
36+
```sudo apt-get install python3-tk```
37+
- For Fedora:
38+
```sudo dnf install python3-tkinter```
2539

26-
- Run the babble app
27-
- Enter 0 into the camera address bar
28-
- Enter cropping mode where your camera feed should be
29-
- Crop your mouth out of the frame
30-
- Open VRCFT
31-
- Install the babble module
32-
- Test in VRC with a VRCFT-compatible avatar
40+
You can read more about this [here](https://stackoverflow.com/questions/25905540/importerror-no-module-named-tkinter).
3341

42+
## Usage
43+
We have integrations for [VRChat](https://docs.babble.diy/docs/software/integrations/vrc), [Resonite](https://docs.babble.diy/docs/software/integrations/resonite) or [ChilloutVR](https://docs.babble.diy/docs/software/integrations/chilloutVR)!
3444

35-
## Useful links
36-
- [Our Discord!](https://discord.gg/XAMZmjBktk)
37-
- [Wandb Runs](https://wandb.ai/summerai/ProjectBabble)
45+
Looking for something else? Check out our [documentation](https://docs.babble.diy/) here!
3846

47+
## Links
48+
- [Our Discord](https://discord.gg/XAMZmjBktk)
49+
- [Our Twitter](https://x.com/projectBabbleVR)
50+
- [Wandb Runs](https://wandb.ai/summerai/ProjectBabble)

0 commit comments

Comments
 (0)