Skip to content

Commit

Permalink
update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
UncleGoogle committed May 4, 2020
1 parent 369a91a commit 6ed448b
Showing 1 changed file with 11 additions and 35 deletions.
46 changes: 11 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# GOG Galaxy 2.0 integartion for Osu!

**State**: Alpha

## Installation
_Currently not available_

Download asset `osu_v{}.zip` from [releases][1] and upack to:
- Windows: `%localappdata%\GOG.com\Galaxy\plugins\installed`
Expand All @@ -18,48 +15,27 @@ _Requires `python3.6` or higher_
4. `inv dist` # this will forcelly restart Galaxy


## Notes to myself

### Auth:
API v2
https://osu.ppy.sh/docs/index.html#authentication
## Features:
- total time played
- import achievements (medals)*
- import friend recommendations
- friends online status*
- install
- play

Flow:
- `authentication` -> `NextStep` -> auth/authorize osu api
- redirect to own server where oauth grant_type `code` included as URL param is exchanged to `referesh_token`
- redirect to dummy URI specified in `NextStep` params with credentials in URL
\* works but Galaxy does not use imported data (probably will be fixed in the future)

API v1
just generate api key
## Notes to myself:

### Local game:
- install: https://osu.ppy.sh/home/download (both windows and mac)
- need to implement OSCompability
- download and run installer behalf the user
- launch: just open exe
- can be osu opened with logged-in user?

### Games data:
game played (UserStatistics -> play_time) https://osu.ppy.sh/docs/index.html#userstatistics

### Last time played
? ideas:
### Last time played:
- recently played (24h only) (v1): https://github.com/ppy/osu-api/wiki#recently-played
- https://osu.ppy.sh/api/v2/users/{user_id}/recent_activity
- unofficial api: https://github.com/osufx/osuapi-extended/wiki#stat
- check what does mean exactly

### Achievements:
so called "medals"
don't see in API, but can be parsed from user profile https://osu.ppy.sh/users/<user_id>
Or there is endpoint for `notifications`:

https://osu.ppy.sh/home/notifications?unread=1
response:

```
{"notifications":[{"id":64586606,"name":"user_achievement_unlock","created_at":"2020-03-26T19:58:37+00:00","object_type":"user","object_id":16517116,"source_user_id":null,"is_read":false,"details":{"slug":"all-intro-halftime","title":"Slowboat","user_id":16517116,"username":null,"cover_url":"https:\/\/assets.ppy.sh\/medals\/web\/all-intro-halftime.png","achievement_id":128}},{"id":64586605,"name":"user_achievement_unlock","created_at":"2020-03-26T19:58:37+00:00","object_type":"user","object_id":16517116,"source_user_id":null,"is_read":false,"details":{"slug":"mania-secret-meganekko","title":"A meganekko approaches","user_id":16517116,"username":null,"cover_url":"https:\/\/assets.ppy.sh\/medals\/web\/mania-secret-meganekko.png","achievement_id":54}}],"stacks":[{"category":"user_achievement_unlock","cursor":null,"name":"user_achievement_unlock","object_type":"user","object_id":16517116,"total":2}],"timestamp":"2020-03-26T20:12:03+00:00","types":[{"cursor":{"id":64586606},"name":null,"total":2},{"cursor":{"id":64586606,"type":"beatmapset"},"name":"beatmapset","total":0},{"cursor":{"id":64586606,"type":"build"},"name":"build","total":0},{"cursor":{"id":64586606,"type":"channel"},"name":"channel","total":0},{"cursor":{"id":64586606,"type":"forum_topic"},"name":"forum_topic","total":0},{"cursor":{"id":64586606,"type":"news_post"},"name":"news_post","total":0},{"cursor":{"id":64586606,"type":"user"},"name":"user","total":2}],"unread_count":2,"notification_endpoint":"wss:\/\/notify.ppy.sh"}
```

### Friends:

- user info with presence (id, username, avatar_url, is_online) https://osu.ppy.sh/docs/index.html#usercompact
Expand Down

0 comments on commit 6ed448b

Please sign in to comment.