-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Updated MD's from newer repository to master repository
- Loading branch information
1 parent
5e3abcb
commit 6a3b4e3
Showing
6 changed files
with
186 additions
and
151 deletions.
There are no files selected for viewing
This file contains 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,15 @@ | ||
|  | ||
|
|
||
| # Limited Modification License | ||
|
|
||
| `Copyright (c) 2024 BoiHanny / MagicChatbox` | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| 1. Limited Modification: Users are granted the right to modify the Software, provided that no modifications allow for integration with any heart rate streaming service other than Pulsoid. Any such modification is considered a breach of this license and shall be subject to legal actions. | ||
| 2. Attribution: All copies of the Software, or substantial portions thereof, must include the following acknowledgment:“This product includes software developed by BoiHanny / MagicChatbox, designed to integrate exclusively with the Pulsoid heart rate streaming service.” | ||
| 3. Limitation of Liability: The Software is provided “as is,” without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall BoiHanny / MagicChatbox be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the Software or the use or other dealings in the Software. | ||
| 4. Modification Restriction: Modification of the badge/rank feature is strictly prohibited. Any alterations to this feature will be considered a breach of this license and will result in legal actions. | ||
|
|
||
| > [!WARNING] | ||
| > By using or interacting with the Software, you agree to abide by the terms and conditions set forth in this license. Violations of these terms will result in the immediate termination of permissions granted herein and may subject you to legal actions. |
This file contains 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,35 @@ | ||
|  | ||
|
|
||
| # Pulsoid Conditions of Use  | ||
|
|
||
| `The Pulsoid integration within MagicChatbox is a crucial component governed by strict rules due to our exclusive partnership with Pulsoid. By using the software, you agree to adhere to the following terms regarding the Pulsoid integration. Any violation of these terms will result in immediate action, including potential legal consequences.` | ||
|
|
||
| > [!NOTE] | ||
| > ## 1.1. Integrity of Integration | ||
| > - The Pulsoid integration must remain completely intact. Modifying, tampering, or removing any part of the Pulsoid integration is strictly prohibited. | ||
| > | ||
| > ## 1.2. No Additional Services | ||
| > - Users are forbidden from adding, integrating, or attempting to support any other heart rate streaming services within MagicChatbox. Pulsoid is the exclusive partner for heart rate data streaming. | ||
| > | ||
| > ## 1.3. Prohibition of Code Alteration | ||
| > - It is not allowed to alter the source code, scripts, or any associated files of MagicChatbox to enable the use of alternate heart rate services or to bypass the Pulsoid integration. Any attempt to circumvent these restrictions will be considered a breach of these terms. | ||
| > | ||
| > ## 1.4. Restrictions on API Usage | ||
| > - Accessing, modifying, or exploiting the Pulsoid API integration for unintended purposes is strictly forbidden. The Pulsoid integration is provided solely for its intended use within MagicChatbox. | ||
| > | ||
| > ## 1.5. No Redistribution of Altered Software | ||
| > - Users are prohibited from distributing, sharing, or selling any modified versions of MagicChatbox that include changes to the Pulsoid integration. This includes any modifications designed to replace or supplement Pulsoid's functionality. | ||
| > | ||
| > ## 1.6. Protection of Pulsoid Data | ||
| > - Any data obtained through the Pulsoid integration must be handled securely and used only for its intended purpose. Users are not permitted to manipulate, export, or misuse Pulsoid data in any way that violates Pulsoid's terms of service or privacy policy. | ||
| > | ||
| > ## 1.7. Unauthorized Feature Implementation | ||
| > - It is strictly forbidden to introduce features, plug-ins, or extensions within the MagicChatbox software that interact with or alter the Pulsoid integration. Only official updates and features provided by MagicChatbox are permitted. | ||
| > | ||
| > ## 1.8. Partnership Respect | ||
| > - Users must respect the exclusive partnership between MagicChatbox and Pulsoid. Any attempt to interfere with, diminish, or undermine this partnership through software alterations, alternative integrations, or other means will be met with severe penalties. | ||
| > | ||
| > ## 1.9. Consequences of Violation | ||
| > - Violations of any of these terms will result in immediate termination of your rights to use the software. Further legal actions may be taken if necessary to protect the integrity of the Pulsoid integration and the partnership agreement. | ||
| > | ||
| `By using MagicChatbox, you agree to uphold these terms and support the integrity of the Pulsoid integration. Any breach of this agreement will be met with strict enforcement to maintain the trust and partnership we have established with Pulsoid. Please also refer to the` [License.md](./License.md) `for further details on software usage and restrictions.` |
This file contains 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 |
|---|---|---|
| @@ -1,169 +1,59 @@ | ||
|  | ||
|  | ||
|
|
||
|
|
||
| [](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/latest) | ||
| [](https://tooomm.github.io/github-release-stats/?username=BoiHanny&repository=vrcosc-magicchatbox) | ||
| [](https://github.com/BoiHanny/vrcosc-magicchatbox/releases) | ||
| [](https://github.com/search?q=repo%3ABoiHanny%2Fvrcosc-magicchatbox++language%3AC%23&type=code) | ||
| [](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.8-windows-x64-installer) | ||
| [](https://discord.gg/ZaSFwBfhvG) | ||
| [](https://www.buymeacoffee.com/BoiHanny) | ||
| -- | ||
|
|
||
| [](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.9.032/MagicChatbox-0.9.032.zip) | ||
| [](https://www.virustotal.com/gui/file/09873367abeead40e33106e38ba8c4474a4e84e37ddb4238286eff388b7976d0/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.** | ||
|
|
||
|  | ||
|
|
||
| # MagicChatBox     | ||
| `Welcome to MagicChatBox – the ultimate VRChat upgrade! Unlock new features, enhance your interactions, and take your virtual experience to the next level.` | ||
|
|
||
| ## Installation | ||
|
|
||
| - 🔳 [Download](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.9.021/MagicChatbox-0.9.021.zip) **the official ZIP-File of MagicChatBox** | ||
| - 🔳 [Download](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) **NET-8 from Microsoft** | ||
| - 🔳 Extract the ZIP File into an Folder | ||
| - 🔳 Run the **MagicChatBox.exe** inside the Folder | ||
| - 🔳 You're good to go now! | ||
|
|
||
| > Proceed with following steps: | ||
| > * Download the [zip file](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.9.032/MagicChatbox-0.9.032.zip). | ||
| > * Make sure you have [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.8-windows-x64-installer) 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: | ||
|  | ||
|
|
||
| <hr> | ||
|
|
||
|
|
||
|  | ||
| If you need any further help `setting up` the program hit up our `Discord Server`. | ||
|
|
||
| > [!IMPORTANT] | ||
| > **You need to enable OSC inside VRChat in order to have the program working!** | ||
| ## 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`. | ||
| <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> | ||
|
|
||
| > - **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. | ||
| <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> | ||
|
|
||
| <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. | ||
| <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> | ||
|
|
||
| > - **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. | ||
| > - **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. | ||
| > - **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. | ||
| > - **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. | ||
| > - **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. | ||
| > - **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. | ||
| > - **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. | ||
| > - **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. | ||
| > - **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 | ||
|
|
||
| > [!NOTE] | ||
| > - 💭 Personal Status | ||
| > - 🧭 Window Activity | ||
| > - 🩵 Heart Rate | ||
| > - 🎛️ Component Stats | ||
| > - ⛓️💥 Network Stats | ||
| > - 📆 Time Status | ||
| > - 🎶 Music Activity | ||
| > - 🎼 Soundpad | ||
| > - 📱 FPS Display | ||
| > - 🛖 Instance Display | ||
| > - ⏱️ Playtime Display | ||
| > - 🥈 Badge Display | ||
| > - 🎫 MCB Rank Display | ||
| > * Make sure you have [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.8-windows-x64-installer) installed. | ||
| > * Latest Operating-System Update installed | ||
|
|
||
| > [!IMPORTANT] | ||
| > **Heart Rate Feature** needs an official `Pulsoid Member` Subscription. | ||
| <hr> | ||
| ## Support | ||
|
|
||
| If you need more help, feel free to click the button below: | ||
| > [!NOTE] | ||
| > **Our support team is here to assist you with any issues!** | ||
| > | ||
| > [](Support.md) | ||
| ## Contact | ||
| --- | ||
|
|
||
| ### 📚 Additional Resources | ||
| - [FAQ](FAQ.md) – Frequently Asked Questions and Answers | ||
| - [Contact](https://discord.gg/magicchatbox) – Create an Ticket here | ||
| - [Documentation](https://discord.gg/magicchatbox) – Detailed guides and manuals | ||
| - [Rating](Rating.md) – Our User Ratings | ||
| - [Pulsoid CoS](PulsoidTOS.md) – Terms of Service for Pulsoid Integration | ||
|
|
||
| > 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://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) |
Oops, something went wrong.