Skip to content

Commit

Permalink
Merge pull request #12 from clemenceroumy/doc
Browse files Browse the repository at this point in the history
Doc
  • Loading branch information
clemenceroumy authored Sep 22, 2023
2 parents 02527d2 + 21bd411 commit c18e16c
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 18 deletions.
53 changes: 35 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,44 +6,61 @@

Based on the **HLTB website** https://howlongtobeat.com/

**Next** :
- Possibility to search and add game
- Optimize code to improve battery saving.
HowLongToBeat, but on WearOS.

**Next** :

HowLongToBeat, but on WearOS.
- Retrieve your HLTB games status by category.
- Select a game to start a stopwatch and save your timed session at the end of it.
- See an history of your sessions.
- If an error occurs while sending a session to HLTB, a log is saved locally and you will be able to try sending it later (or upload it manually to HLTB and remove it from the logs).
- Optimize code to improve battery saving.

## Installation

The app is not available through Google Play Store (at least for now).
Here's the steps to follow to get it :

1. Head over to the release page and download the latest release apks.
There's one for the actual wearOS app and an another one for the phone app (needed to logged into your HLTB account, it is mandatory to use the wearOS app).
2. Install the phone app `mobile-HLTBwearOS.apk` on your phone. Once installed, the application is purposely not visible on your phone app list. You can find it in the Settings apps list of your phone, searching for "HLTBWearOS".
3. Install the wearOS app `watch-HLTBwearOS.apk` on your watch. Installing an .apk on a wearOS device can be a bit tricky. I personally use the [Wear OS Tools for windows](https://forum.xda-developers.com/attachments/wearos-tools-v10-rar.5927083/) tools to do so.
Here's the steps to follow to get it :

1. Head over to the release page and download the latest release apks.
There's one for the actual wearOS app and an another one for the phone app (needed to logged into your HLTB account, it is mandatory to use the wearOS app).
2. Install the phone app `mobile-HLTBwearOS.apk` on your phone. Once installed, the application is purposely not visible on your phone app list. You can find it in the Settings apps list of your
phone, searching for "HLTBWearOS".
3. Install the wearOS app `watch-HLTBwearOS.apk` on your watch. Installing an .apk on a wearOS device can be a bit tricky. I personally use
the [Wear OS Tools for windows](https://forum.xda-developers.com/attachments/wearos-tools-v10-rar.5927083/) tools to do so.
4. Have fun beating your games !😁


## Screenshots
## Features

### Login

![Login](./documentation/login_example.gif)

### Display games by categories

![HomePlayingCategory](./documentation/home_playing.png)
![HomeBacklogCategory](./documentation/home_backlog.png)
Retrieve your HLTB games status by category.

| Playing list | Backlog list |
|----------------------------------------------------------|----------------------------------------------------------|
| ![HomePlayingCategory](./documentation/home_playing.png) | ![HomeBacklogCategory](./documentation/home_backlog.png) |

### Launch a gaming session

Select a game to start a stopwatch and save your timed session at the end of it.

![TimedSession](./documentation/saving_time.gif)

### Logs of sessions

See an history of your game sessions.
If an error occurred while sending a session to HLTB, a log is saved locally and you will be able to try sending it from here (or upload it manually to HLTB and remove it from the logs).

![Logs](./documentation/logs.gif)

### Searching and adding games

Search for a game on HLTB. By default, the search is ordered by most popular games.
You can search a game either by vocal or keyboard input.

Add a game from search view. You can add a game several times, as on the website. If you already have the game
in (at least) one of your list, you'll see a check mark on the game item.

| Search Game | Add Game |
|---------------------------------------|-----------------------------------------|
| ![Search](./documentation/search.gif) | ![AddGame](./documentation/addgame.gif) |

Binary file added documentation/addgame.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/saving_time.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/search.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c18e16c

Please sign in to comment.