diff --git a/README.md b/README.md index 24c4463..c4aa2a6 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,53 @@ -# gamer_updater +# Gamer Updater -A new Flutter project. +A Flutter application for tracking game version updates via RSS feeds.
+The idea is to track updates to games you might have previously played
+To simply know how much you might be missing and whether you would have new content to look forward to -## Getting Started +![](git_static/screenshot.jpg) -This project is a starting point for a Flutter application. +## Features -A few resources to get you started if this is your first Flutter project: +- Game version tracking +- Automatic version checking through RSS feeds +- Last played date tracking +- Custom version regex patterns +- Thumbnails! -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +## Setup -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +1. Clone repository +2. Install Flutter +3. Run `flutter pub get` +4. Run `flutter run` + +## Usage + +Add games by providing: +- Name +- RSS feed URL +- Version regex pattern +- Optional game image + +## Example + +If we wanted to track the versions of Rimworld we would enter the rss feed as: +https://store.steampowered.com/feeds/news/app/294100/?cc=HR&l=english + +And the version regex pattern as: +`Update (\d+\.\d+\.\d+)` + +Seeing as their posts usually follow this convention: +Update 1.5.4104 released +... +Update 1.4.3704 released + +In theory the rss link can be any link at all and the version regex can be anything at all
+The regex is simply ran on the entirety of the contents of the get request to the rss link
+Which means we can also simply search html
+But it is not as reliable as the rss because of all the additional shit + +Currently the thumbnails must be manually added + +They can also be any image at all but the cards are designed to fit the thumbnails from the game update pages: +![](git_static/thumbnails.png) diff --git a/git_static/screenshot.jpg b/git_static/screenshot.jpg new file mode 100644 index 0000000..cc22189 Binary files /dev/null and b/git_static/screenshot.jpg differ diff --git a/git_static/thumbnails.png b/git_static/thumbnails.png new file mode 100644 index 0000000..ab59018 Binary files /dev/null and b/git_static/thumbnails.png differ