Update README.md

Condensed the readme and made it more user-friendly.
- Moved to-do list to the bottom 
- Updated to-do list 
- Added more pages to the wiki that contained the design document and stuff from the readme.

Author: WichitPritchett

README.md

@@ -29,7 +29,7 @@ and equipment.
 
 ### 2.2. Text-to-Speech Integration
 
--  [ ] Integration with Azure TTS for text-to-speech functionality
+-  [x] Integration with Azure TTS for text-to-speech functionality
     - [ ]  Step-by-step guide for users to obtain and set up an API key
 - [ ]  TTS to voice Twitch chat messages
 - [ ]  Alternative for VTubers to type instead of talking, using TTS for vocalization
@@ -39,43 +39,18 @@ and equipment.
 - [x]  Twitch chat integration for seamless viewer interaction
 - [ ]  Interactive features using Twitch bits or reward points, such as throwing objects at the model
 
-### 2.4. Expression and Gesture Presets
 
-- [ ]  Library of pre-set expressions and gestures (e.g., surprise, anger, joy)
-- [ ]  Custom hotkeys and wake words for triggering presets
-
-### 2.5. Scene Transitions and Effects
-
-- [ ]  Library of pre-made scene transitions and effects
-- [ ]  Customizable transitions for a professional and polished presentation
-
-### 2.6. Mouse Tracking for Eye and Body Movements
+### 2.4. Mouse Tracking for Eye and Body Movements
 - [x]  Avatar's eyes follow the user's cursor for a more lifelike and responsive experience
 - [ ]  Post-processing pass and body morphing based on mouse position, creating an effect where the body of the model follows the mouse
 
-### 2.7. Audio Analysis for Animation Triggers
-
-- [ ]  Audio amplitude analysis to use different sets of mouth shapes based on the loudness or quietness of the VTuber's speech
-- [ ]  Pitch analysis for detecting excitement or screaming
-
-### 2.8. Voice Anonymization
-
-- [ ]  Speech-to-text (STT) conversion to transcribe the streamer's voice into text
-- [ ]  Text-to-speech (TTS) system to vocalize the transcribed text with a synthetic voice, concealing the streamer's real voice
-- [ ]  Various synthetic voice options for customization and personalization
-
-By incorporating the voice anonymization feature, you can cater to a
-wider audience of streamers, including those who are concerned about
-privacy or prefer not to reveal their actual voice. This added
-functionality can make your PNGTuber software even more versatile and
-appealing to a diverse range of users.
 
 3\. Open-Source and Lightweight Approach
 ----------------------------------------
 
 - [x]  Released under an MIT license
-- [ ]  Donation button for financial support through GitHub
-- [ ]  Focus on maintaining a lightweight application without compromising features
+- [x]  Donation button for financial support through GitHub
+- [x]  Focus on maintaining a lightweight application without compromising features
 
 4\. User Interface and Customization
 ------------------------------------
@@ -87,42 +62,9 @@ appealing to a diverse range of users.
 - [ ] Addition of gadgets and a toolbar for more traditional editing
     options
 
-5\. Monetization Strategy
--------------------------
-
-### 5.1. Donations
-
-- [ ] Open-source software with a donation button on GitHub for
-    financial support from users who appreciate the application
-
-### 5.2. Marketplace Platform
-
-- [ ] Create a marketplace platform where users can upload, sell, and
-    purchase custom models, accessories, and other assets for the
-    PNGTuber software
-- [ ] Generate revenue through commission fees on sales made through the
-    platform
-- [ ] Facilitate a thriving community of content creators and artists,
-    contributing to the overall success and popularity of the software
 
-By integrating a marketplace platform, you'll not only be providing a
-means of monetization, but also encouraging a community of creators to
-contribute to and benefit from the software. This approach allows you
-to support the development and maintenance of the software while still
-keeping it open-source and accessible to users.
 
-6\. Conclusion
---------------
-
-This design document provides an overview of the key features and
-functionality for a lightweight and user-friendly PNGTuber software
-application. By focusing on unique features and maintaining a
-lightweight design, the software aims to differentiate itself from
-competitors and provide a versatile solution for content creators. As
-development progresses, user feedback and market trends should be
-considered to further refine and improve the application.
-
-7\. Dependencies
+5\. Dependencies
 ----------------
 
 * **Dear ImGui** - A lightweight and efficient Immediate Mode Graphical User Interface library for creating simple and functional graphical interfaces.
@@ -138,36 +80,93 @@ considered to further refine and improve the application.
 * **ser** - A lightweight and efficient serialization/deserialization library for C++
 * **stb** - A collection of single-file public domain libraries, specifically used in this project for decoding and encoding images in various formats.
 
-8\. TODO
+6\. Build Instructions
+-----------------------
+
+### Windows
+* Clone the source code using GitHub Desktop
+   * You can install Github Desktop from: <https://desktop.github.com/>
+* Build Pocketsphinx
+   * Install CMake from: <https://cmake.org/download/>
+   * In the cloned project, locate the Pocketsphinx copy at `VoiceTuber/3rd-party/pocketsphinx`. Run the following commands in `cmd`:
+```
+cmake -S . -B build
+cmake --build build
+cmake --build build --target install -DCMAKE_INSTALL_PREFIX=bin
+```
+* Build libuv
+    * Assume CMake is installed from the Pocketsphinx sections
+    * In the cloned project, locate the libuv copy at `VoiceTuber/3rd-party/libuv`. Run the following commands in `cmd`:
+```
+$ mkdir -p build
+$ (cd build && cmake .. -DBUILD_TESTING=ON) # generate project with tests
+$ cmake --build build                       # add `-j <n>` with cmake >= 3.12
+```
+*
+    * This steps will build Debug version of libuv, open generated `.sln` file from `VoiceTuber/3rd-party/libuv/libuv.sln` in Visual Studio
+    * Switch Solution Configuration to Release
+    * Build Solution with `Build/Build Solution` menu
+* Build the rest of the project
+    * Open `VoiceTuber.sln` in Visual Studio 2022
+    * Use the menu option `Build/Build Solution`
+### Linux
+* Install dependencies
+```
+sudo apt-get install -y clang pkg-config libsdl2-dev libuv1-dev git cmake
+```
+* Clone the app
+```
+git clone --recurse-submodules https://github.com/team-pp-studio/VoiceTuber.git
+```
+* Build Pocketsphinx
+```
+cd VoiceTuber/3rd-party/pocketsphinx
+cmake -S . -B build
+cmake --build build
+cmake --build build --target install
+cd ../../..
+```
+Last `cmake` command you may need to run with `sudo`.
+
+* Clone and compile the build tool `coddle`
+```
+git clone https://github.com/coddle-cpp/coddle.git && cd coddle && ./build.sh
+```
+* Install `coddle`
+```
+sudo ./deploy.sh
+cd ..
+```
+* Build VoiceTuber
+```
+cd VoiceTuber && coddle
+```
+* Run the application
+```
+./VoiceTuber
+```
+7\. TODO
 --------
 Top Priority
  - [ ] the app crashes on Twitch chat with unstable Internet
  - [ ] implement mouth based on individual images instead of the sprite sheet
  - [ ] implement blink based on individual images
- - [x] highlight the chat if it is disconnected from the Internet
- - [x] allow limiting of frame rate
- - [x] better compatibility for multiple windows
- - [x] rotation slider
- - [x] Hotkeys infomation
- - [x] Physics breaks - cannot reproduce
+
 
 General Priority
 - [ ] remember directory in open/save dialog boxes
 - [ ] search for files in the dialog box
-- [x] Have a spalsh dialog simular as Blender one (Easier initial Project navigtion)
+
 - [ ] Transition to/Add Softbody Phyics
-- [x] Azure TTS
-- [x] (feature) Easing the bounce with a filter, maybe add some 2nd-order filter
-      to have overshooting
+
 - [ ] (feature) support for transparency (Transparency for OBS so users will not need a green/blue background and can use all colors in the PNG model)
 - [ ] twitch extention (triggers for bits)
 - [ ] TikTok companion app
 - [ ] outdoor streaming from the phone wiht PNGTuber overlay
 - [ ] stream directly from VoiceTuber
 
 Feedback
-- [X] We don't clear draws - known issue and according to internet it is Windows issue
-   
+  
 - [ ] Vale don't like tha they can select what mic is being used
 - [ ] Don't expect the placement of stuff (UI UX)
    - [ ] Swap description and value
@@ -184,9 +183,7 @@ Feedback
       it doesn't capture my mouse so it just highlighted the location
       box instead to show where my mouse is and the task bar shows
       what monitor I'm on)
-- [x] have it so you can enter a value for rotation instead of a
-      slider... or at least a mouse tooltip that says "hold ctrl to
-      enter value"
+
 - [ ] different variations of bounce, I like the bounce but I really
       only want the bounce once when I start talking and resetting
       when I stop talking, hell it'd also be nice if I could customize
@@ -231,102 +228,17 @@ Completed
 - [X] REALLY WANTS CLICK AND DRAG - covered in TODO
 - [X] Drag and drop files into the software - coverd in TODO
 - [x] Really wants drag and drop files
-      
-9\. Unorgonized Ideas
----------------------
-
-- [ ] Puppeteer interface with keyboard and mouse
-- [ ] Puppeteer interfacing with the game controller
-- [ ] AI co-streamer
-
-Channel Point/Bit/Chat Ideas.
-
-Vtuber/chat tts affected
-1. Outfit change/hair style change (Vtuber)
-1.A outfit/change on chat tts
-1.B change vtubers/chat tts color (like a multiple or screen rgb/hex code.
-2. Mouth fall off
-3. Throw/fall objects at vtuber/chat
-4. Part of model grows or shrinks
-
-Minigames
-1. Gacha outfit/asset (secret accessories to unlock via gacha)
-1.A claw machine (Credit idea to ValeofHearts)
-2. Take care of chat tts (tamagotchi)
-3. Chat duel? 
-4. Guess the amount (how much is in the jar)
-5.* FISHING MINIGAME (I have no idea, but fishing minigame)
-6.* COOKING/BAKING MINIGAME (Wichit loves cooking minigames.)
-
-extension necessary ideas
-* - items from previous list that may or may not benefit from this
-
-1. Draw the streamer a asset or shirt decal in browser. (will be approved by the streamer before being uploaded.)
-2. Move the vtuber or chat tts anywhere on the screen.
-
-10\. Build Instructions
------------------------
-
-### Windows
-* Clone the source code using GitHub Desktop
-   * You can install Github Desktop from: <https://desktop.github.com/>
-* Build Pocketsphinx
-   * Install CMake from: <https://cmake.org/download/>
-   * In the cloned project, locate the Pocketsphinx copy at `VoiceTuber/3rd-party/pocketsphinx`. Run the following commands in `cmd`:
-```
-cmake -S . -B build
-cmake --build build
-cmake --build build --target install -DCMAKE_INSTALL_PREFIX=bin
-```
-* Build libuv
-    * Assume CMake is installed from the Pocketsphinx sections
-    * In the cloned project, locate the libuv copy at `VoiceTuber/3rd-party/libuv`. Run the following commands in `cmd`:
-```
-$ mkdir -p build
-$ (cd build && cmake .. -DBUILD_TESTING=ON) # generate project with tests
-$ cmake --build build                       # add `-j <n>` with cmake >= 3.12
-```
-*
-    * This steps will build Debug version of libuv, open generated `.sln` file from `VoiceTuber/3rd-party/libuv/libuv.sln` in Visual Studio
-    * Switch Solution Configuration to Release
-    * Build Solution with `Build/Build Solution` menu
-* Build the rest of the project
-    * Open `VoiceTuber.sln` in Visual Studio 2022
-    * Use the menu option `Build/Build Solution`
-### Linux
-* Install dependencies
-```
-sudo apt-get install -y clang pkg-config libsdl2-dev libuv1-dev git cmake
-```
-* Clone the app
-```
-git clone --recurse-submodules https://github.com/team-pp-studio/VoiceTuber.git
-```
-* Build Pocketsphinx
-```
-cd VoiceTuber/3rd-party/pocketsphinx
-cmake -S . -B build
-cmake --build build
-cmake --build build --target install
-cd ../../..
-```
-Last `cmake` command you may need to run with `sudo`.
-
-* Clone and compile the build tool `coddle`
-```
-git clone https://github.com/coddle-cpp/coddle.git && cd coddle && ./build.sh
-```
-* Install `coddle`
-```
-sudo ./deploy.sh
-cd ..
-```
-* Build VoiceTuber
-```
-cd VoiceTuber && coddle
-```
-* Run the application
-```
-./VoiceTuber
-```
-
+- [x] highlight the chat if it is disconnected from the Internet
+ - [x] allow limiting of frame rate
+ - [x] better compatibility for multiple windows
+ - [x] rotation slider
+ - [x] Hotkeys infomation
+ - [x] Physics breaks - cannot reproduce
+ - [x] have it so you can enter a value for rotation instead of a
+      slider... or at least a mouse tooltip that says "hold ctrl to
+      enter value"
+ - [X] We don't clear draws - known issue and according to internet it is Windows issue
+ - [x] Azure TTS
+- [x] (feature) Easing the bounce with a filter, maybe add some 2nd-order filter
+      to have overshooting
+- [x] Have a spalsh dialog simular as Blender one (Easier initial Project navigtion)