From c07fe5337c72946ccc7e7ef661ab1e5637018f15 Mon Sep 17 00:00:00 2001 From: Tommy Chow Date: Sun, 21 Aug 2022 05:37:14 -0400 Subject: [PATCH] Update README.md - Removed FAQ section - Revised descriptions - Compressed screenshots - Removed Android screenshots (to reduce vertical size) - Updated Frosty logo - Updated alts - Added issues section [skip ci] --- README.md | 135 +++++++++++++++++++----------------------------------- 1 file changed, 46 insertions(+), 89 deletions(-) diff --git a/README.md b/README.md index f53a98b1..1a756774 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,71 @@

- - Frosty Logo + + The Frosty rounded logo.

Frosty

- A Twitch client for iOS and Android with - BTTV, - FFZ, and - 7TV support. Built with + A mobile + Twitch + client for iOS and Android with + 7TV, BTTV, + and + FFZ + support. Built with Flutter.

CI Issues Last Commit License Release

- + Apple App Store Badge - + Google Play Store Badge @@ -72,10 +73,10 @@

- + Buy Me A Coffee @@ -84,54 +85,32 @@

Followed Streams Categories Section Search Section - Channel (Video/Chat) View - Emote Menu - Settings Section

## Motivation -A major problem with the official Twitch app for many users is that emotes and badges from services such as [BetterTTV (BTTV)](https://chrome.google.com/webstore/detail/betterttv/ajopnjidmegmdimjlfnijceegpefgped), [FrankerFaceZ (FFZ)](https://chrome.google.com/webstore/detail/frankerfacez/fadndhdgpmmaapbmfcknlfgcflmmmieb), and [7TV](https://chrome.google.com/webstore/detail/7tv/ammjkodgmmoknidbanneddgankgfejfh) are not officially supported. Twitch is unaffiliated with these services, hence why they haven't been integrated officially. - -As a result, the millions of users of these services have an unideal viewing experience on the official Twitch app. In the stream chat, only text is positioned where emotes should be (imagine only being able to see :emoji_code: rather than the emojis themselves). - -Frosty aims to bring these emotes and other general quality of life features to **both iOS and Android**. +The official Twitch mobile app doesn't support emotes from [7TV](https://chrome.google.com/webstore/detail/7tv/ammjkodgmmoknidbanneddgankgfejfh), [BetterTTV (BTTV)](https://chrome.google.com/webstore/detail/betterttv/ajopnjidmegmdimjlfnijceegpefgped), and [FrankerFaceZ (FFZ)](https://chrome.google.com/webstore/detail/frankerfacez/fadndhdgpmmaapbmfcknlfgcflmmmieb) — third-party services and extensions for Twitch used by millions of viewers and many top channels. This results in a poor mobile chat experience since only emote codes render rather than their image or GIF counterpart. ## Features -- Support for BetterTTV, FrankerFaceZ, and 7TV emotes and badges +- Support for 7TV, BetterTTV, and FrankerFaceZ emotes and badges - Browse followed streams, top streams, and top categories - Autocomplete for emotes and user mentions - Light, dark, and black (OLED) themes @@ -146,7 +125,9 @@ Frosty aims to bring these emotes and other general quality of life features to - Sleep timer - And more... -## Development Setup +For a more detailed overview, visit [frostyapp.io](https://www.frostyapp.io/). + +## Development setup 1. Go to the [Twitch dev console](https://dev.twitch.tv/login) and register a new application to retrieve a **Client ID** and **Client Secret**. @@ -159,44 +140,20 @@ Frosty aims to bring these emotes and other general quality of life features to 5. Choose an emulator or device and run the app! > **Note** -> +> > Frosty uses [MobX](https://mobx.netlify.app/) for state management. Please refer to the documentation about code generation, otherwise your changes within MobX stores may not be applied. > **Warning** -> +> > I built Frosty while learning Flutter, so some of the code may not be optimal. I'm working on refactoring, documenting, and cleaning up various parts as much as I can. -## Frequently Asked Questions (FAQ) +## Feature requests and issues -### Can I change the quality of the stream? +If you have a feature request, found a bug, or have a general issue, you can submit it [here](https://github.com/tommyxchow/frosty/issues/new/choose) on the issues tab. Doing so makes it easier for me to keep track of them and makes it publicly visible for others to review. -Unfortunately, quality options aren't available through the native player and rely on an "auto" setting. There is no official API for getting the live stream URLs, so specific quality options are not possible currently. - -### Why do some animations and scrolling appear to be janky? - -Due to the side effects of the Flutter framework, there may be some stutter and jank on the first installation and launch. - -After using and moving around the app for a bit, the jank will be mitigated through shader warmup/caching and should be minimal on subsequent launches. Watching a stream with a fast chat for a few minutes should resolve it. - -### Why is there a delay between the stream and chat? - -On Android, there should be no delay. Try refreshing the player if there is a delay. - -On iOS, there is a delay of around 15 seconds due to the native player, so unfortunately it's out of my control. As a workaround, Frosty has a message delay option that lets you set the delay (in seconds) before each message is rendered. - -### Why are some GIF emotes either slow or very fast? - -This seems to be caused by the Flutter framework itself (see [here](https://github.com/flutter/flutter/issues/24804) and [here](https://github.com/flutter/flutter/issues/29130)). - -### Why is feature "X" from Twitch not in the app as well? - -I'm limited to what is available in the [Twitch API](https://dev.twitch.tv/docs/api/reference), so certain features from the Twitch web or mobile app (e.g., voting on predictions and category viewer count) are sadly not available at the moment. - -Other features related to ad-blocking or utilizing private APIs will likely not be implemented officially because they would violate Twitch's terms of service. My highest priority currently is staying on the app stores and focusing on making features for those builds. - -### Where can I report a bug or request a new feature? - -You can open a new issue [here](https://github.com/tommyxchow/frosty/issues) with the appropriate labels (e.g., "bug" or "feature request") and I'll take a look at it. +> **Note** +> +> I work on Frosty in my free time and take occasional breaks, so I may not respond immediately. ## Donate