diff options
| -rw-r--r-- | README.md | 57 | ||||
| -rw-r--r-- | TODO.md | 21 |
2 files changed, 40 insertions, 38 deletions
@@ -1,42 +1,30 @@ # Wiimmfi Watcher -Wiimmfi Watcher is an Android application that allows you to watch Mario Kart Wii gameplay by simply entering your friend code. This application can be found on the Google Play Store [here!](https://play.google.com/store/apps/details?id=me.brysonsteck.wiimmfiwatcher) This app can be used in English, German, French, Italian and Japanese. +Wiimmfi Watcher is an unofficial Android application that allows you to watch Mario Kart Wii gameplay by simply entering your friend code. This application can be found on the Google Play Store [here!](https://play.google.com/store/apps/details?id=me.brysonsteck.wiimmfiwatcher) This app can be used in several different languages. This application is currently being maintained by myself out of love for Mario Kart Wii and appreciation for the developers of Wiimmfi. I am in no way affiliated with Wiimmfi or any of the Wiimmfi developers. ## Screenshots - - - - - - - - - + + + + + + + + + ## Download -You can visit the Google Play Store to download the most recent and stable version (link goes here once approved). You are also free to clone the repository and download the source code for the most stable release in the Releases tab if you would like to build it from scratch. +You can visit the Google Play Store to download the most recent and stable version [here!](https://play.google.com/store/apps/details?id=me.brysonsteck.wiimmfiwatcher) You are also free to clone the repository and download the source code for the most stable release in the Releases tab if you would like to build it from scratch. -## Feedback +## Feedback and Bugs This is officially my first project and Google Play app that I'm maintaining, so if you have any feedback about my work, I would love to hear it! You can create an issue tagged "feedback", or you can fill out this [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSd6qCONAP2tsbHPgzu_CdZcHVHL5nx7q0XFqrVfExEc84kqUQ/viewform). I also have a section in my TODO list under "Features I would like to add" for things I am already considering adding to future releases. -## Bugs - -If you found any bugs in the `master` branch (i. e. the most recent Google Play release), **PLEASE READ MY [TODO LIST](https://github.com/brysonsteck/wiimmfi-watcher/blob/dev/TODO.md) FIRST** to make sure that the bug you found isn't something I'm already aware of. Once you have made sure of that, you can then create an issue or fill out this [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSd6qCONAP2tsbHPgzu_CdZcHVHL5nx7q0XFqrVfExEc84kqUQ/viewform). - -## Devices - -Wiimmfi Watcher has been officially tested and confirmed to work on the following devices: -* x86_64 emulated Pixel 4 (Android 5.0.2) by brysonsteck -* x86_64 emulated Pixel 4 (Android 11) by brysonsteck -* x86_64 emulated Nexus 7 (Android 10) by brysonsteck -* x86_64 emulated Nexus 10 (Android 10) by brysonsteck -* x86_64 emulated Nexus 7 (Android 5.0.2) by brysonsteck -* x86_64 emulated Nexus 10 (Android 5.0.2) by brysonsteck +Additionally, If you find any bugs in the app (the `master` branch contains the same code as the latest release), you can create an issue here on GitHub or fill out the Google Form linked before in a similar manner. Please only submit bugs that pertain to the [most recent release.](https://github.com/brysonsteck/wiimmfi-watcher/releases) ## Donations @@ -44,7 +32,7 @@ This application is completely free, ad-less and open source. That means that no If you'd like to donate to this project, I'd ask that you first [donate to Wiimmfi.](https://wiimmfi.de/donate) This app nor my 3,069+ hours of fun on their service would not be possible without them. -Once you donate to them or you choose not to (why?? :( ), then here are ways you can donate to me: +Once you donate to them or you choose not to (why?? :( how sad), then here are ways you can donate to me: * [PayPal](https://www.paypal.com/donate/?business=steck.bryson%40gmail.com&item_name=Bryson+Steck¤cy_code=USD&Z3JncnB0=) * Bitcoin: 1Kbnp5JMTKd7a3Zs2WWm2JMCjfVb5tpcky * Litecoin: LRboJVNzoJCjXHmwN6RQgyvYEQjjaFzEA7 @@ -52,6 +40,23 @@ Once you donate to them or you choose not to (why?? :( ), then here are ways you Please note that donations are **NOT** required and does **NOT** add or remove functionality from the app. +## License + +© 2021 Bryson Steck. Wiimmfi Watcher is licensed under the [GPL-3.0](LICENSE). + +Wiimmfi Watcher is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +Wiimmfi Watcher is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with Wiimmfi Watcher. If not, see <https://www.gnu.org/licenses/>. + ## Credits Wiimmfi Watcher is made possible by the following: @@ -1,27 +1,24 @@ # TODO These are issues in Wiimmfi Watcher I am at least aware of. Please **DO NOT** submit a bug report on the Google Form or an issue here on GitHub if it is mentioned on this list, unless you found a way that the bug can crash the app. -## Completed For Release 1.1.3 -* Added language translations for Korean, Portuguese and Spanish. -* Fixed a bug where the error message that appears does not disappear when clicking on a recent friend code. -* Added a new dialog between searching for a friend code and the watcher screen. -* Fixed a bug where the internal Java error on the watcher screen wouldn't show after pressing the refresh button at least once. -* Fixed a bug where the final button of the recent friend codes wouldn't show if it reached past the bottom of the screen, especially with devices that have the software navigation bar. -* Fixed a bug in the English version of the app where the "License" portion of the about page was not formatted correctly. +### Completed For Release 1.1.4 +* Added an updater to make sure subsequent releases are up to date -## Working On +### Working On +* Implement the updater into the UI * Create a better looking header for the watcher activity * Add 'sections' I guess??? -* Adding the option to toggle dark mode manually so older devices can have that privledge as well +* Remove requirement of reading todo list before submitting issues -## Aware Of -* The about page causes part of the screen to get cut off as the animation plays (only if there are not a lot of recent friend codes present) -* The navigation menu in Dark Mode is messed up +### Aware Of +* The about fragment causes part of the screen to get cut off as the animation plays when returning to the main fragment (only if there are a few recent friend codes) +* The navigation menu in Dark Mode is messed up (colors) * The selected player detail text and icon is black * The highlight color is barely visible * Pressing the watch or refresh buttons cause the app to hang until refreshing is completed. * Working with threads should fix this * Adding a dialog helps make it look like the app is working for now +* Adding the option to toggle dark mode manually so older devices can have that privledge as well # Features I would like to add * The watcher activity does not refresh automatically like the official website does |