/ readme.md
readme.md
1 <!-- /* Copyright 2023-2024 biolithic. All rights reserved. */ --> 2 ## ChatStarr browser extension for computers and mobile devices 2.0.0 3 4 ## Welcome! 5 6 Thank you for downloading and trying this! Written by a single person in the USA, we hope this helps you keep up with chat in small to large live streams. If you have any questions, comment, bugs or ideas on how to make this better, please visit https://www.multistreamchat.com/ and send them there. Thanks! 7 8 9 ## Basic Overview 10 11 Installing this in your browser will enhance the streaming and chatting experience on livestreams on desktop and laptop computers, and on mobile Android devices for the Kiwi browser. 12 13 14 ## How to use this for desktop/laptop usage 15 16 This free browser extension is an add-on or plugin or extension to chromium based browsers such as Google Chrome, Brave Browser, Microsoft Edge, Vivaldi, Epic, Torch, Opera GX Gaming, and others. It can be completely added or removed at any time, and the site will continue to work separately as is. This doesn't change the basic functionality of any website or app. 17 18 19 ## How to use this for Android phones and devices. 20 21 This free extension is an add-on or plugin or extension to mobile Android devices using Kiwi browser. It can be completely added or removed at any time, and the site will continue to work separately separately as is. You can find Kiwi browser in the Google Play Store or F-Droid Store or APKpure.com or at https://kiwibrowser.com/ . Kiwi is based on Google Chrome browser but with the added ability to use browser extensions like on desktop. This provides extra features for the website version in the Kiwi browser, not the app. ChatStarr may work with Samsung browser or other mobile browsers which can install Chrome extensions (plugins). 22 23 24 ## Which websites does it work on now? 25 Live streams on Kick.com, twitch.tv, rumble.com, youtube.com, odysee.com, tiktok.com, noice.com . 26 27 28 ## 🔧 Install it! 29 30 1. Download & extract the [latest🧪version] 31 32 2. _Go to your Browser's Extensions page (chrome://extensions or brave://extensions or similar)_ 33 34 3. _Activate "Developer mode"_ (top right) 35 36 4. _Click the "Load unpacked" button _& Select the extracted folder_ 37 38 39 #### Web browser support 40 |[<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/brave/brave_48x48.png" alt="Brave" width="28px" />](https://brave.com)</br>Brave | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chromium/chromium_48x48.png" alt="Chromium" width="28px" />](https://github.com/chromium/chromium)</br>Chromium | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" />](https://chrome.google.com/webstore/detail/improve-youtube-open-sour/bnomihfieiccainjcjblhegjgglakjdd)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](https://www.microsoft.com/edge)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](https://addons.opera.com/en/extensions/details/install-chrome-extensions/)</br>Opera| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/vivaldi/vivaldi_48x48.png" alt="Vivaldi" width="24px" height="24px" />](https://github.com/ric2b/Vivaldi-browser)</br>Vivaldi | 41 | --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- | 42 | 0.52+ | 49.0+ | 49.0+ | 79.0+ | 44.0+ | 36.0+ | x.x+ | 1.0+ | 43 44 45 ## Does this work on iPhones, iPads, Windows Phones, Firefox, or something you haven't mentioned here? 46 47 No. 48 49 50 ## Tracking/Security 51 52 This extension saves information to your browser locally if you choose such as options/preferences you set, chat that you save, and browser version which you can export out to yourself via CSV file and is deleted when you uninstall the extension. We save none of your options/preferences "in the cloud" at this time. We currently use no tracking or advertising or cookies at this time of 12/2023. This may change and you will be notified if it does. We are currently a very small team and do not have time or resources for large privacy policy scope or legal/public relations/social/customer service policy other than to provide the basic technical features needed to the streamers for their usage. 53 54 55 ## How to get help with using this or questions or issues 56 57 ... coming soon ... 58 This help document might help you: https://github.com/ImprovedTube/YouTube-Extension/discussions/753 59 This help document might help you: https://github.com/ParticleCore/Particle/wiki/Report-a-problem 60 This help document might help you: https://github.com/night/betterttv/issues 61 62 ## Option Menu 63 64 - This extension adds an option menu to the website where you can save options for yourself which will happen on each page load. The options/preferences are saved to your computer and not sent out to the internet. 65 66 67 ## Export / Offline 68 69 - This extension can export chat logs from live streams in CSV form. These can be viewed in a spreadsheet program to view offline if later you do not have a network connection. 70 71 72 ## Be Featured 73 74 - If you use this browser extension in your streaming and would like to be featured on one of our webpages, reach out to us and let us know! Thanks! 75 76 77 ## Source/Funding/Leadership/etc 78 79 This is currently funded/hosted 100% by the creator/developer, who is a person not associated with any live streaming or video/media company in any formal way. This is not funded or associated with any major corporation or any of the streaming platforms listed here. 80 81 82 ## How to help 83 84 - If you have ideas and would like to help in programming, UI design or funding, you may contact us coming soon . Thanks! 85 86 87 ## Source 88 89 - This is released as open-source so that you, if able, can alter this extension yourself and use to your liking or review for anything malicious and remove it if need be. 90 91 92 ## Voice Features 93 94 - This extension provides voice activation features for controlling the live stream chat. These features are optional and can be turned on or off at any time. When the voice activation is turned on, your computer web browser is always listening for you to say certain voice commnds and the goal is hands-free scrolling, searching and manipulation of the live stream chat on your computer. 95 96 97 ## Keybind Features 98 99 - This extension provides keyboard keybind features for controlling the live stream chat. These features are optional and can be turned on or off at any time. When the keybind is turned on, your computer web browser is always listening for you to push certain keybinds and the goal is mouse-free scrolling, searching and manipulation of the live stream chat on your computer. 100 101 102 ## Version A 103 104 - This is released under Google Chrome Manifest version 3 (2022) and may only work with browsers/operating systems updated in 2022 and beyond. 105 106 107 ## Version B 108 109 - This is released in 2023 and version 1.0 is an early access version for mass testing, quality assurance and bug fixing. This extension will be updated in 2023-2024 most likely on Sundays as issues and features are raised by the community and fixed. The latest version will appear on https://www.multistreamchat.com/ . 110 111 112 ## License 113 114 This is released under [GNU 3 license]https://www.gnu.org/licenses/gpl-3.0.en.html . Copyright (c) 2023 biolithic