Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BoiHanny authored Feb 20, 2023
1 parent 4a8b04d commit 1336112
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
![MagicOSC_icon](https://user-images.githubusercontent.com/114599052/194428052-3e5d0018-4a96-405d-b2e2-c7db16d02940.png) v0.5.0
<!-- BEGIN LATEST DOWNLOAD BUTTON -->
[![Download zip](https://custom-icon-badges.herokuapp.com/badge/-Download-blue?style=for-the-badge&logo=download&logoColor=white "Download zip")](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.4.0/Version-0.4.0.zip)
<!-- END LATEST DOWNLOAD BUTTON -->


**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.**

### Download and Installation

1. Download the [zip file](https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v0.4.0/Version-0.4.0.zip).
2. Right-click and choose the option 'extract all'.
3. By default it will create a new folder in your download folder (you can also extract the content to other locations).
4. When extracted, the folder will open.
5. Run the file 'MagicChatbox.exe'.

[**Please make sure OSC is enabled in VRChat**](https://youtu.be/OHjN_q6RqGY?t=80)

![197355959-83441bed-2b27-469e-974f-53acbc0badf9](https://user-images.githubusercontent.com/114599052/218335607-3f1b904b-5812-41c5-84de-9d82290962c1.png)

### Features

- **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.

- **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.

- **Status tab:** One of the most exciting changes we made 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.

- **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.

- **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.

- **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.

- **Options** tab allows you to customize your experience by enabling/disabling options such as showing only the time in VR, using 24-hour time format, adding "My time:" prefix, changing the OSC IP and port, and playing FX sounds for VRChat users when sending messages. Additionally, you can choose to add "💬" as a prefix for personal status messages and chat messages, and have the app always on top.

### 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:

- **Discord:** [BoiHanny#6666](https://discordapp.com/users/270646719086198803)
- **Github Issues:** [Report a bug or submit a feature request](https://github.com/BoiHanny/vrcosc-magicchatbox/issues)

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 1336112

Please sign in to comment.