-
Notifications
You must be signed in to change notification settings - Fork 19
feat: Refactor docs, add new images and instructions #140
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
fb50881
Update GitHub Link
scuffedplus 29b4f27
update structure
Aed-1 7cf3323
fix links
Aed-1 94f8816
fix link
Aed-1 25bae7d
update pagination and add relevant package
Aed-1 df2de89
edit pagination
Aed-1 8a84157
Merge pull request #131 from Aed-1/docsupdate
scuffedplus b894920
Add Pokebert's bio
Pokebert 6c5a231
Revise Babble Tracker quickstart instructions
Pokebert 0456454
Moved extra Wireless mode steps to Quickstart
Pokebert c0af048
Calib guide
prkkerx 455aeff
Calib guide insert
prkkerx 3317d42
Calibration Guide Images
prkkerx 4ce8025
Calibration Guide Image Folder
prkkerx 888995a
Delete static/img/BlankSlider.png
prkkerx 71a7e89
Delete static/img/CallibrationTab.png
prkkerx 1a1279c
Delete static/img/ExampleSlider.png
prkkerx 4cfb201
Delete static/img/BlendshapeMenus.png
prkkerx b7a50aa
Delete static/img/LeftSideSlider.png
prkkerx 6a1acbf
Delete static/img/RedDotSlider.png
prkkerx 82492f8
Delete static/img/RightSideSlider.png
prkkerx 5741075
Rename CallibrationTab.png to CalibrationTab.png
prkkerx a8dd9c3
Added Calibration guide
prkkerx 74d11fd
Update calibrationguide.mdx
prkkerx e0f131e
Update calibrationguide.mdx
prkkerx ead9949
Merge pull request #132 from prkkerx/patch-2
scuffedplus 7dffb99
Fix misleading wording in firmware.mdx
scuffedplus 76212ec
fixed compilation error
Aed-1 12e8da2
Merge pull request #133 from Aed-1/docsupdate
scuffedplus 52b4876
fix incorrect paths
Aed-1 9485f29
Merge pull request #135 from Aed-1/docsupdate
scuffedplus 5a5f131
add missing images
Aed-1 7f192fd
good enough :( sob
scuffedplus dd0dd54
wrong tip md
Aed-1 ee7d8b7
fixing kerix's mistakes :)
scuffedplus 7b3d78c
no more colon :(
scuffedplus 580e389
added bsb troubleshooting
jettsd 399ef85
fixed pagination pathing
jettsd 57450d2
removed junk files
jettsd 1991ae9
Merge pull request #139 from jettsd/docsupdate
scuffedplus 62f8990
Update babbleofficaltracker.mdx
Pokebert 82160ec
Update calibrationguide.mdx
Pokebert File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| id: faq | ||
| title: FAQs | ||
| sidebar_position: 6 | ||
| pagination_next: babbleofficaltracker/Troubleshooting/troubleshoot | ||
| --- | ||
|
|
||
| # Frequently Asked Questions | ||
|
|
||
| For most questions, we recommend joining our discord for up to date information, your question(s) may have already been answered there! The following are some common questions we get: | ||
|
|
||
| ### 1. **What is Babble and how does it work?** | ||
|
|
||
| **Answer:** Babble is a facial tracking software used in VR environments. It uses cameras, often mounted on VR headsets, to track facial movements and expressions. | ||
|
|
||
| ### 2. **What cameras are compatible with Babble?** | ||
|
|
||
| **Answer:** Babble works with various cameras, including generic USB webcams and specialized cameras like the PS3 Eye and ESP32CAM. Compatibility depends on the specific hardware setup and firmware used. | ||
|
|
||
| ### 5. **How do I connect and use multiple cameras with Babble?** | ||
|
|
||
| **Answer:** You can use multiple cameras by ensuring each one is recognized by your PC. They will usually be listed as different COM ports or UVC devices. Configure each camera individually in Babble's settings. | ||
|
|
||
| ### 6. **Can I use Babble with a wireless camera?** | ||
|
|
||
| **Answer:** Yes, Babble supports wireless cameras, including those using the ESP32CAM with the Openiris firmware. Ensure your camera and PC are connected to the same network. | ||
|
|
||
| ### 7. **How do I calibrate Babble for facial tracking?** | ||
|
|
||
| **Answer:** Calibration involves performing a series of facial expressions while the software records and analyzes the data. It may take a few minutes, and using the latest alpha version (e.g., 2.0.6) improves calibration accuracy. | ||
|
|
||
| ### 9. **How do I set up Babble for use with VRChat?** | ||
|
|
||
| **Answer:** Ensure Babble is configured to output data to the correct OSC port (default 9000 or 8888). Then, enable the VRCFT module in VRChat's settings to receive facial tracking data. | ||
|
|
||
| ### 10. **What battery should I use with an ESP32CAM for Babble?** | ||
|
|
||
| **Answer:** A 3.7V LiPo battery can be used, but ensure it has sufficient capacity (e.g., 2000mAh) and that your voltage regulator can handle the power requirements of both the camera and the LEDs. | ||
|
|
||
| ### 11. **How do I check if Babble is sending data correctly to VRChat?** | ||
|
|
||
| **Answer:** Use the OSC debug tab in VRChat to monitor incoming data. If Babble is sending data correctly, you should see values changing as your facial expressions change. | ||
|
|
||
| ### 12. **What is the default port for Babble’s OSC output?** | ||
|
|
||
| **Answer:** Babble typically uses port 9000 for OSC output. However, depending on your setup, it might also use port 8888. | ||
|
|
||
| ### 15. **Can I use the same camera for both EyeTrackVR and Babble?** | ||
|
|
||
| **Answer:** Yes, but ensure that the camera is not locked by one application when trying to use it with another. You might need to restart the application after changing settings. | ||
|
|
||
| ### 20. **Is it possible to use Babble over Bluetooth?** | ||
|
|
||
| **Answer:** While theoretically possible, Bluetooth is generally not recommended due to high latency and reliability issues. Wi-Fi or USB connections are preferred for better performance. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| title: Bigscreen Beyond power fixes | ||
| --- | ||
|
|
||
| # Power issue troubleshooting | ||
|
|
||
| ## Having power delivery issues? | ||
| If your headset is struggling to receive consistent power, it can cause a **LOT** of performance problems—especially when running additional hardware like the Babble face tracker. | ||
|
|
||
| :::warning | ||
| These fixes can help with power delivery and stability, but this is often related to a headset hardware flaw. Open a ticket with Bigscreen to request replacement hardware. The most common fixes are a link box and cable replacement, especially if you are on Link Box v1. | ||
| ::: | ||
|
|
||
| ### Diagnostics | ||
| While power issues manifest differently for everyone, the most common signs include: | ||
| - Tracking jitter | ||
| - Loss of audio or microphone | ||
| - Random grey screens | ||
|
|
||
| ### External wall power | ||
| Sometimes the motherboard does not provide enough power to the Beyond, making tracking loss more likely when the headset and Babble are powered from the same USB source. This can be alleviated by powering the cable through a USB wall adapter. | ||
|
|
||
| Use any 5V 2A non-smart USB-A brick. Alternatively, use MMI Modular's [USB-PD Adapter](https://mmimodular.myshopify.com/products/beyond-2-linkbox-usb-pd-adapter). | ||
|
|
||
| ### PCIe USB expansion cards | ||
| Giving the Beyond a dedicated PCIe USB card has shown tracking improvement when using the Babble. [Check out Bigscreen's recommended PCIe cards](https://bigscreen-inc.frontkb.com/en/articles/10629633). | ||
|
|
||
| ### Cable strain relief | ||
| Wrapping electrical tape around the cable that plugs into the headset can reduce slack and motion. Decreasing the strain on this connection has been reported by users to improve overall stability. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| sidebar_position: 2 | ||
| title: Big Screen Beyond tracking fixes | ||
| --- | ||
|
|
||
| # Tracking loss troubleshooting | ||
|
|
||
| ## Losing tracking a lot? | ||
| The Bigscreen Beyond has a flaw in the headset tracking diodes. Babble’s IR LEDs can overexpose those diodes and cause the headset to lose tracking. While this seems to mostly affect users with 1.0 base stations, it can affect 2.0 base stations as well. Not every headset has this issue, but many do. This page shares community-made fixes to reduce or eliminate the issue. | ||
|
|
||
| :::warning | ||
| These fixes can help with tracking loss, but this is a headset hardware flaw. Open a ticket with Bigscreen to request replacement hardware. The most common fixes are a link box and cable replacement, especially if you are on Link Box v1. | ||
| ::: | ||
|
|
||
| ### 1.2 tracking loss firmware | ||
| The fastest fix is to try flashing `BabbleFirmware1.2_trackingLossFix.bin`. Follow [this video tutorial](https://www.youtube.com/watch?v=FAGvpBFi5hU) and select `BabbleFirmware1.2_trackingLossFix.bin` in the firmware drop-down. This firmware lowers IR LED brightness, so you may need to raise the brightness slider in the software. | ||
|
|
||
| ### 3D-printed shield | ||
| This print blocks excess IR light from reaching the headset. It is a full back shell replacement; printing in PETG is recommended, but PLA will work. [Download the 3D model on Printables](https://www.printables.com/model/1651565-babble-face-tracker-case-w-ir-led-shields). | ||
|
|
||
|  | ||
|
|
||
| <div style={{ display: 'flex', justifyContent: 'center', gap: '20px', margin: '20px 0' }}> | ||
| <img src="/img/3dprintapart.jpg" alt="3D print apart" style={{ width: '45%', maxWidth: '400px' }} /> | ||
| <img src="/img/3dprintfull.jpg" alt="3D print full" style={{ width: '45%', maxWidth: '400px' }} /> | ||
| </div> | ||
|
|
||
| Just unscrew the original backplate and screw the 3D print in its place. While **NOT** recommended as a long-term fix, if you do not have a 3D printer, you can replicate a similar solution using electrical tape. | ||
|
|
||
| # Power-related issues | ||
| Loss in tracking can also be related to power delivery issues. [Check out our troubleshooting guide on power issues](/docs/babbleofficaltracker/troubleshooting/powerissues). |
46 changes: 46 additions & 0 deletions
46
docs/babbleofficaltracker/Troubleshooting/Troubleshooting.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| id: troubleshoot | ||
| sidebar_position: 3 | ||
| title: Troubleshooting | ||
| pagination_next: faq | ||
| --- | ||
|
|
||
| # Troubleshooting | ||
|
|
||
| For most questions, we recommend joining our discord for up to date information, your question(s) may have already been answered there! The following are some common questions we get: | ||
|
|
||
| ### 3. **Why is my camera feed in Babble running at low FPS?** | ||
|
|
||
| **Answer:** This could be due to the camera defaulting to a lower FPS setting. Check the UVC settings in Babble and set the resolution and framerate to match your camera's capabilities. | ||
|
|
||
| ### 4. **Why is the camera feed in Babble “wobbly” or misaligned?** | ||
|
|
||
| **Answer:** This could be due to rolling shutter issues with your camera. Ensure that your camera settings are optimized for Babble, and try adjusting the resolution and framerate. | ||
|
|
||
| ### 8. **Why isn’t my camera recognized in Babble after reconnecting it?** | ||
|
|
||
| **Answer:** This is a known issue. Try restarting Babble or re-selecting the camera in the UVC settings to refresh the connection. | ||
|
|
||
| ### 13. **How can I improve the performance of Babble with lower-resolution cameras?** | ||
|
|
||
| **Answer:** If lower resolutions result in poor performance, consider upgrading the camera or ensuring it’s correctly configured to avoid defaulting to low FPS settings. Using hardware that supports better framerates and resolution is recommended. | ||
|
|
||
| ### 14. **What should I do if Babble calibration is taking too long or gets stuck?** | ||
|
|
||
| **Answer:** Calibration might take some time, especially on older versions of Babble. Consider upgrading to the latest alpha version, as it improves calibration speed and accuracy. | ||
|
|
||
| ### 16. **Why does my webcam work fine in OBS but not in Babble?** | ||
|
|
||
| **Answer:** The issue might be related to UVC settings in Babble. Make sure the resolution and framerate settings match what works in OBS. | ||
|
|
||
| ### 17. **Why is my ESP32CAM camera not providing a stable feed in Babble?** | ||
|
|
||
| **Answer:** This could be due to insufficient power supply or incorrect firmware. Make sure your battery and voltage regulator are adequate, and consider using the Openiris firmware. | ||
|
|
||
| ### 18. **What do I do if I get an error that the COM port can’t be found?** | ||
|
|
||
| **Answer:** Ensure the correct COM port is selected in the Babble settings. If using multiple applications, make sure the COM port isn’t already in use. | ||
|
|
||
| ### 19. **How do I fix the issue where Babble’s CPU usage is very high?** | ||
|
|
||
| **Answer:** High CPU usage could be due to high-resolution settings or issues with the camera feed. Lowering the resolution or switching to a more efficient camera might help. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This starts at 3, this should start at 1 and so on.