Skip to content

Commit

Permalink
Merge branch 'Pre-Master' of https://github.com/BoiHanny/vrcosc-magic…
Browse files Browse the repository at this point in the history 
…chatbox into Pre-Master
  • Loading branch information
@BoiHanny
BoiHanny committed Aug 22, 2024
2 parents e974928 + 527aa0e commit aa9d7d7
Showing 1 changed file with 127 additions and 44 deletions.
171 changes: 127 additions & 44 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
![MagicOSC_icon](https://user-images.githubusercontent.com/114599052/194428052-3e5d0018-4a96-405d-b2e2-c7db16d02940.png)
![Unbenannt](https://github.com/user-attachments/assets/661975f8-601d-49e2-850c-6bc239fbe1a5)


[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/BoiHanny/vrcosc-magicchatbox?color=%23512BD4&label=%20&style=plastic)](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/latest)
[![downloads](https://img.shields.io/github/downloads/BoiHanny/vrcosc-magicchatbox/total?color=%23512BD4&label=Total%20download&logo=docusign&logoColor=white&style=plastic)](https://tooomm.github.io/github-release-stats/?username=BoiHanny&repository=vrcosc-magicchatbox)
[![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/BoiHanny/vrcosc-magicchatbox?color=%23512BD4&label=Last%20update&style=plastic)](https://github.com/BoiHanny/vrcosc-magicchatbox/releases)
Expand All @@ -8,81 +10,162 @@
[![Coffee](https://img.shields.io/badge/Send-A%20Coffee-FFDD00?style=plastic&logo=buymeacoffee&logoColor=white)](https://www.buymeacoffee.com/BoiHanny)
--

[![Download zip](https://custom-icon-badges.herokuapp.com/badge/-Download-%23512BD4?style=for-the-badge&logo=download&logoColor=white "Download")](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.8.321/v0.8.321.zip)
[![Download zip](https://custom-icon-badges.herokuapp.com/badge/-Scan%20at%20VirusTotal-blue?style=for-the-badge&logo=virustotal&logoColor=white "virustotal")](https://www.virustotal.com/gui/url/0943e0bc664411f5bf4dade5ec00376ef1fd79cbedb863fad1cf98f64eb63507?nocache=1)
[![Download zip](https://custom-icon-badges.herokuapp.com/badge/-Download-%23512BD4?style=for-the-badge&logo=download&logoColor=white "Download")](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.9.003/MagicChatbox-0.9.003.zip)
[![Download zip](https://custom-icon-badges.herokuapp.com/badge/-Scan%20at%20VirusTotal-blue?style=for-the-badge&logo=virustotal&logoColor=white "virustotal")](https://www.virustotal.com/gui/file/4f1508955db90fe7d66106cf82d4e21628110b7c442a3386c27aa2a05ab78fbd/detection)
<!-- END LATEST DOWNLOAD BUTTON -->
# MagicChatbox
> **Introducing MagicChatbox: the ultimate companion for all your VRChat needs! Whether you're on desktop or in VR, we've got you covered with our compact and modern UI.**
**Introducing MagicChatbox: the ultimate companion for all your VRChat needs! Whether you're on desktop or in VR, we've got you covered with our compact and modern UI.**

![Previes_5_MCB](https://github.com/user-attachments/assets/e9981525-fde4-4ea6-a421-28e431e2285f)

![Version_0 8](https://github.com/BoiHanny/vrcosc-magicchatbox/assets/114599052/f8394c0a-699b-43ce-b5dd-70b4f6fa2f26)

## Installation


### Download and Installation
1. Download the [zip file](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.8.321/v0.8.321.zip).
2. Make sure you have [.NET 6](https://dotnet.microsoft.com/en-us/download) installed.
3. Right-click and choose the option 'extract all'.
4. By default it will create a new folder in your download folder (you can also extract the content to other locations).
5. When extracted, the folder will open.
6. Run the file 'MagicChatbox.exe'.

[**Please make sure OSC is enabled in VRChat**](https://youtu.be/OHjN_q6RqGY?t=80)
> Proceed with following steps:
> * Download the [zip file](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.8.885/MagicChatbox-0.8.885.zip).
> * Make sure you have [.NET 6](https://dotnet.microsoft.com/en-us/download) installed.
> * Right-click and choose the option **'extract all'**.
> * By default it will create a new folder in your download folder (you can also extract the content to other locations).
> * When extracted, the folder will open.
> * Run the file **'MagicChatbox.exe'**
> * [**Please make sure OSC is enabled in VRChat**](https://youtu.be/OHjN_q6RqGY?t=80)
>
> OSC-Option:
![image](https://github.com/BoiHanny/vrcosc-magicchatbox/assets/114599052/616efa5c-9126-4364-8782-975b1d2bb5db)

<hr>


![FeaturesNEU](https://github.com/user-attachments/assets/6351a835-9035-4819-945b-e5bfd5b5ba86)


## Features

> - 🔳 Personal Status
> - 🔳 Local Time Display
> - 🔳 Window Activity
> - 🔳 System Stats
> - 🔳 Network Stats
> - 🔳 SoundPad Display
> - 🔳 Spotify/Music Display
> - 🔳 TTS Support
> - 🔳 ChatGPT Chat Enhancer
> - 🔳 Heart-Rate Display (Only [Pulsoid PRO](https://pulsoid.net))
Prototype Features (not implemented)
> - ◾ FPS Display
> - ◾ Instance Display
> - ◾ Online Time Display
> - ◾ Badge Collector Display
> - ◾ Community-Rank Display
<hr>

## Detailed-Features

<details>
<summary>LEFT-CLICK</summary>

> - **Extended Media Support:** We've introduced `MediaLink` to the integration tab and incorporated support for YouTube Music, SoundCloud, Spotify, Apple Music and even YouTube videos with the help of the `Windows Media API`.
### Features
<p align="center">
<img src="https://github.com/user-attachments/assets/4076af0e-bc70-4261-8eaa-d745c87a8706" alt="YouTube Music" width="32" height="32"/>
<img src="https://github.com/user-attachments/assets/a4f25c86-a442-46dc-84a3-841efb2d3450" alt="SoundCloud" width="32" height="32"/>
<img src="https://github.com/user-attachments/assets/8dc8d93f-7719-4ad6-bf62-89295c0cfa6a" alt="Spotify" width="32" height="32"/>
<img src="https://github.com/user-attachments/assets/a1400fee-a205-4197-b3e6-eccbff96a3da" alt="Apple Music" width="32" height="32"/>
<img src="https://github.com/user-attachments/assets/fcdeeae1-eeff-4dc8-a084-417943b7e225" alt="YouTube" width="32" height="32"/>
<img src="https://github.com/user-attachments/assets/e77c2f3f-de5e-4e12-b3d9-2af708d903bf" alt="Adobe" width="32" height="32"/>
<img src="https://github.com/user-attachments/assets/fb5edfca-96e0-41f1-a475-b7c7dffb7f58" alt="Windows" width="32" height="32"/>
</p>
<p align="center">
<img src="https://github.com/user-attachments/assets/5473eaef-bb9d-49e8-b054-ab42bc9d9354" alt="Preview" width="212" height="36"/>
<img src="https://github.com/user-attachments/assets/d561e0ff-4027-4610-b3f1-32d19938a7d2" alt="Preview" width="212" height="36"/>
<img src="https://github.com/user-attachments/assets/5473eaef-bb9d-49e8-b054-ab42bc9d9354" alt="Preview" width="212" height="36"/>
</p>

- **Extended Media Support:** We've introduced `MediaLink` to the integration tab and incorporated support for YouTube Music, SoundCloud, and even YouTube videos with the help of the `Windows Media API`.
> - **Desktop mode:** MagicChatbox shows "On desktop" on the UI, and displays which application you are currently focused on. It's a great way to keep track of your messages while multitasking. The Spotify integration also shows the currently playing song, making it easier to keep up with your favorite tunes.
- **VR mode:** MagicChatbox shows "In VR" on the UI, and you have the option to display your local time in-game. MagicChatbox also provides a Spotify integration that shows the currently playing song, adding to the immersive experience. You can enable or disable this feature from the options menu.
<p align="center">
<img src="https://github.com/user-attachments/assets/87c067f2-baba-40a3-90ce-04e57937708b" alt="DesktopUi" width="32" height="32"/>
</p>
<p align="center">
<img src="https://github.com/user-attachments/assets/d8f77539-ba58-4e51-ae65-b03e39e9df2f" alt="PreviewDesktop" width="212" height="36"/>
<img src="https://github.com/user-attachments/assets/8fef7f71-d1ea-4105-a739-38b9890b6850" alt="Desktop" width="212" height="36"/>
<img src="https://github.com/user-attachments/assets/d8f77539-ba58-4e51-ae65-b03e39e9df2f" alt="PreviewDesktop" width="212" height="36"/>
</p>

- **Desktop mode:** MagicChatbox shows "On desktop" on the UI, and displays which application you are currently focused on. It's a great way to keep track of your messages while multitasking. The Spotify integration also shows the currently playing song, making it easier to keep up with your favorite tunes.
<div style="border-top: 1px solid gray; width: 50%; margin-left: 0;"></div>

- **Heart Rate Display**: Display your heart rate in real-time using Pulsoid-supported devices. This feature requires a 'BRO plan' from Pulsoid.

- **Enhanced Heart Rate Monitoring:** Enhanced your heart rate monitoring experience with the addition of "Smooth Heart Rate" and a "Heart Rate Trend Indicator" under `Options > Heart Monitoring Options`. Additionally, we've optimized the `HeartRateConnector` to provide smoother and more accurate heart rate readings.
> - **Heart Rate Display**: Display your heart rate in real-time using Pulsoid-supported devices. This feature requires a 'BRO plan' from Pulsoid.
- **Status tab:** One of the most exciting changes we made back in version 0.4.0 is the addition of the Status tab, which provides an easy way to manage your status items. You can sort your status items based on creation date, recent usage, and if they are a favorite. Each status item has three types of interactions - activate, delete, and favorite - and you can quickly add new items using the input box.
<p align="center">
<img src="https://github.com/user-attachments/assets/dddb53d5-7c27-425d-90a0-12c7ae097558" alt="Pulsoid" width="42" height="42"/>
</p>
<p align="center">
<img src="https://github.com/user-attachments/assets/1caeaab3-1e19-4854-b631-3a46e901480e" alt="PreviewHeartrate" width="212" height="36"/>
<img src="https://github.com/user-attachments/assets/a6a0d37e-dfbd-4e58-a1ce-f010f44648a5" alt="Heart" width="212" height="36"/>
<img src="https://github.com/user-attachments/assets/1caeaab3-1e19-4854-b631-3a46e901480e" alt="PreviewHeartrate" width="212" height="36"/>
</p>

- **Personal Message integration:** In addition to the Status tab, we have also added a new Personal Message integration, allowing you to easily share messages with others.
> - **Status tab:** One of the most exciting changes we made back in version 0.4.0 is the addition of the Status tab, which provides an easy way to manage your status items. You can sort your status items based on creation date, recent usage, and if they are a favorite. Each status item has three types of interactions - activate, delete, and favorite - and you can quickly add new items using the input box.
- **Chatting:** allows you to quickly send messages of up to 140 characters. The UI displays the last five messages in a scroll viewer that fades out, and you can copy or resend any of these messages. Additionally, when sending a new message, you can see a countdown of how long it will last (you can set this value in options), and there is a stop button to clear the message instantly in VRChat. You can also clear your message history (last 5 messages) with the Clear History button.
> - **Personal Message integration:** In addition to the Status tab, we have also added a new Personal Message integration, allowing you to easily share messages with others.
- **Chat Message Editing**: Your chat messages are no longer set in stone! This feature lets you edit sent messages with two modes at your disposal:
- **'Live' mode** for real-time editing. See changes as you type!
- **'On Confirm' mode** lets you revise at leisure and hit `ENTER` to apply changes.
> - **Chatting:** allows you to quickly send messages of up to 140 characters. The UI displays the last five messages in a scroll viewer that fades out, and you can copy or resend any of these messages. Additionally, when sending a new message, you can see a countdown of how long it will last (you can set this value in options), and there is a stop button to clear the message instantly in VRChat. You can also clear your message history (last 5 messages) with the Clear History button.
- **Time options:** MagicChatbox offers an option to show only the current time in VR, without the "my time:" prefix. You can choose to display the time in a 24-hour format, making it easier to read. u can also set a custom time zone and auto-apply or toggle daylight saving time.
> - **Chat Message Editing**: Your chat messages are no longer set in stone! This feature lets you edit sent messages with two modes at your disposal:
> - **Live mode** for real-time editing. See changes as you type!
> - **On Confirm mode** lets you revise at leisure and hit `ENTER` to apply changes.
- **In-app updates**: Keep MagicChatbox up-to-date with the in-app update feature. It communicates with the GitHub API and pulls the .ZIP file from the latest branch.
> - **Time options:** MagicChatbox offers an option to show only the current time in VR, without the "my time:" prefix. You can choose to display the time in a 24-hour format, making it easier to read. u can also set a custom time zone and auto-apply or toggle daylight saving time.
- **Simplified Beta Updates:** A new update module for beta builds has been introduced, offering seamless beta updates and an option to downgrade if you want to switch back to a stable version. An option has also been added to opt-out of the alpha channel.
> - **In-app updates**: Keep MagicChatbox up-to-date with the in-app update feature. It communicates with the GitHub API and pulls the .ZIP file from the latest branch.
- **OSC customization:** We have updated our codebase to support UTF-8 and made the switch from Sharp OSC to CoreOSC-VRC-UTF8, which was a collaborative effort with VRCWizard. MagicChatbox also provides an option to change the OSC IP and port from the options menu, allowing for more customization.
> - **Simplified Beta Updates:** A new update module for beta builds has been introduced, offering seamless beta updates and an option to downgrade if you want to switch back to a stable version. An option has also been added to opt-out of the alpha channel.
- **2nd VRChat Output Option:** We've introduced a new feature under `Options > App Options > 2nd VRChat output`, enabling you to send OSC messages to a second VRChat session.
> - **OSC customization:** We have updated our codebase to support UTF-8 and made the switch from Sharp OSC to CoreOSC-VRC-UTF8, which was a collaborative effort with VRCWizard. MagicChatbox also provides an option to change the OSC IP and port from the options menu, allowing for more customization.
> - **2nd VRChat Output Option:** We've introduced a new feature under `Options > App Options > 2nd VRChat output`, enabling you to send OSC messages to a second VRChat session.
- **Integration Separator Toggle:** A new option to switch the integration separator from '┆' to 'Enter' for cleaner VRChat interactions.
> - **Integration Separator Toggle:** A new option to switch the integration separator from '┆' to 'Enter' for cleaner VRChat interactions.
> - **Improved Windows Activity Integration & Control in Settings:** We've made improvements to the Windows activity integration, providing more accurate information about your current Windows activity. You can now manage the Window Activity feature directly from the settings for easier control.
> - **Enhanced Application Names Setting:** Customize the names of your applications in the settings for a more personalized experience.
> - **Local save and version checker:** We have implemented a local JSON file to save your status items, ensuring they are always available to you. The application also features a built-in version checker that informs you if you have the latest version, if a new version is available, or if you are running a preview version.
> - **Overload feature:** Finally, MagicChatbox features a unique overload feature that disables some integrations automatically if the number of characters in your message exceeds 140. The order of disabled integrations will be as follows: Personal Message, Windows Activity, Current Time, and finally Spotify. MagicChatbox will try to fill the 144 character cap, but when above it, it will disable the integration.
> - **Text to Speech:** allows you to communicate better with users in VRChat, you have a wide range of voices/languages. In settings, you can "Toggle VRChat voice on TTS", "Stop current playing TTS on new chat" and select the output device. We recommend using VoiceMeter or just a virtual audio cable.
> - **Options** tab allows you to customize your experience by enabling/disabling options.
</details>

<hr>

## Dependencies


> * Make sure you have [.NET 6](https://dotnet.microsoft.com/en-us/download) installed.
> * Latest Operating-System Update installed
- **Improved Windows Activity Integration & Control in Settings:** We've made improvements to the Windows activity integration, providing more accurate information about your current Windows activity. You can now manage the Window Activity feature directly from the settings for easier control.

- **Enhanced Application Names Setting:** Customize the names of your applications in the settings for a more personalized experience.
<hr>

- **Local save and version checker:** We have implemented a local JSON file to save your status items, ensuring they are always available to you. The application also features a built-in version checker that informs you if you have the latest version, if a new version is available, or if you are running a preview version.

- **Overload feature:** Finally, MagicChatbox features a unique overload feature that disables some integrations automatically if the number of characters in your message exceeds 140. The order of disabled integrations will be as follows: Personal Message, Windows Activity, Current Time, and finally Spotify. MagicChatbox will try to fill the 144 character cap, but when above it, it will disable the integration.
## Contact

- **Text to Speech:** allows you to communicate better with users in VRChat, you have a wide range of voices/languages. In settings, you can "Toggle VRChat voice on TTS", "Stop current playing TTS on new chat" and select the output device. We recommend using VoiceMeter or just a virtual audio cable.

- **Options** tab allows you to customize your experience by enabling/disabling options.
> Have any questions, suggestions, or feedback regarding MagicChatbox? We'd love to hear from you! Feel free to reach out to us through one of the following channels:
### Contact
Have any questions, suggestions, or feedback regarding MagicChatbox? We'd love to hear from you! Feel free to reach out to us through one of the following channels:
> - [![](https://dcbadge.vercel.app/api/server/ZaSFwBfhvG)](https://discord.gg/ZaSFwBfhvG)
> - **Github Issues:** [Report a bug or submit a feature request](https://github.com/BoiHanny/vrcosc-magicchatbox/issues)
> - Wiki: [Help & more](https://github.com/BoiHanny/vrcosc-magicchatbox/wiki)
- **Discord:** [![](https://dcbadge.vercel.app/api/server/ZaSFwBfhvG)](https://discord.gg/ZaSFwBfhvG)
- **Github Issues:** [Report a bug or submit a feature request](https://github.com/BoiHanny/vrcosc-magicchatbox/issues)
- Wiki: [Help & more](https://github.com/BoiHanny/vrcosc-magicchatbox/wiki)

We're committed to providing the best possible experience for our users, and your feedback helps us make MagicChatbox even better.

0 comments on commit aa9d7d7

Please sign in to comment.