Skip to content

Commit 46ddee9

Browse files
committed
Fix for first Token Initialization and Readme
1 parent e8e4f81 commit 46ddee9

13 files changed

+131
-19
lines changed

README.md

Lines changed: 107 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,108 @@
11
# playnite-fanatical-plugin
2-
Plugin that imports Fanatical Games in Playnite
2+
Fanatical Plugin integration for Playnite
3+
4+
5+
## Overview
6+
This plugin was written to let you see in the Playnite UI all those owned-but-not-redeemed games that you purchased from Fanatical.
7+
8+
## Features
9+
10+
- See all your (still non-redeemed) games purchased with your existing Fanatical account, as it happens for all your games registered on the varius platforms/stores when they are integrated with Playnite via similar plugins.
11+
12+
![Example of the resulting Playnite grid](Resources/Screenshot_1.png)
13+
14+
- Open in external browser the Order corresponding to a purchased game with Fanatical.
15+
16+
![Example of the resulting Playnite grid](Resources/Screenshot_2.png)
17+
18+
- Experimentally
19+
You can also import the already redemed games, and non-games (Audio, Video...).
20+
21+
![Example of the resulting Playnite grid](Resources/Screenshot_3.png)
22+
23+
24+
Due to the nature of Fanatical Store, this integration does not support tags, startig and installing games, "game time" and other amenities, it just lists owned games.
25+
26+
Refreshing (adding) games happens as often as for the other Playnite libraries.
27+
28+
Currently not supported:
29+
- Removal of games no more in Fanatical.
30+
- Parametric refresh time
31+
32+
# Installation
33+
34+
Installation of the plugin is an easy (standard) procedure, because Playnite supports ad hoc file extensions. The process consists in the following steps:
35+
36+
- Download the release from github (FanaticalLibraryPlugin_XXX.pext)
37+
- Install it by clicking on the file withing windows file explorer (or similar for mac)
38+
39+
After clicking the *.pext file you will see the following dialog appearing in Playnite:
40+
41+
![Plugin installation warning](Resources/Screenshot_4.png)
42+
43+
Playnite will ask to restart:
44+
45+
![Plugin changes needs Playnite restart](Resources/Screenshot_5.png)
46+
47+
After restart you will see the plug-in via the add-on menu (it will be automatically enabled)
48+
49+
![Plugin installation warning](Resources/Screenshot_6.png)
50+
51+
If a "Fanatical Library Integration" is present in the libraries list, you made it! Please note that the plugin status is still disconnected and the list of the games not updated so you will se no new games imported at this point (see next section to make your first connection).
52+
53+
# Accessing your Fanatical Account
54+
55+
To import the Fanatical games in the Playnite DB, the plugin needs to have access to you account.
56+
57+
To do so you have to open the extension settings dialog: you can click _Extensions Settings->Libraries_ list on the Add-ons dialog (see previous screenshot) and select _Fanatical_, or you can also access it in the classical way via the Playnite menu:
58+
59+
![Getting to the Plugin Configuration Dialog](Resources/Screenshot_8.png)
60+
61+
![Plugin COnfiguration](Resources/Screenshot_7.png)
62+
63+
If you're still not authenticated (as it happens the first time you use the plugin), it will be written so just to the right of the _Authenticate_ button. You can re-authenticate even if you are already authenticated (in this case your previous authentication will be invalidated).
64+
65+
If it's the first time you use the plugin, it is recommended to leave all other settings alone, you can always come back to this dialog and change what you want in a second time.
66+
67+
Click the _Authenticate_ button and the internal browser will pop up. Please wait a bit because tha Fanatical page can take some time to load all the resources. After a while the Fanatical login dialog will automatically pop-up:
68+
69+
![Sing-In Dialog](Resources/Screenshot_9.png)
70+
71+
Check the "Keep me singed in" flag, and then proceed normally through all the steps of authentication (also Google and facebook authentication should work if you registered in that way). If the login is succesfull, you will get to the standard _"Welcome back"_ message. Do nothing and after some seconds the browser window will close automatically (some unattended navigation on other fanatical pages can happen before automatic closure).
72+
73+
If the connection was successfull, check the new status of the plugin: written just to the right of the _Authenticate_ button. _"User is authenticated"_ should appear.
74+
75+
You can now close the settings dialog an go for you first games import.
76+
77+
Normally, after the first successfully completed login, another authenticaton will not be needed, because the Fanatical Plugin will remember your authenticated session (as a normal browser would do). The plugin will never store your username and password.
78+
79+
80+
# Updating the game list
81+
82+
To ask Playnite to get the list of all your owned and unredeemed games (or in any case all the games as filtered in you settings) you simply have to use the
83+
84+
![Importing Fanatical Games](Resources/Screenshot_10.png)
85+
86+
The list of games of each integrated library is reloaded any time you open Playnite, so possible new games will be added consequently.
87+
88+
Getting the list of games will be quite fast, but importing all their cover image and metadata will take its time, so Playnite will do that asynchronously (using the standard Metadata downloader).
89+
90+
If, for some reason, the metadata download is interrupted you can alwais restart that via the dedicated menu:
91+
92+
![Updateing Metadata](Resources/Screenshot_11.png)
93+
94+
95+
# Troubleshooting
96+
97+
- If, for some reason, you close the sign in dialog, you are stucked with the opened embedded browser window. To close it simply navigate to on another page. You can also re-open the sign in dialog e retry.
98+
99+
# Issue reporting
100+
I wrote this plugin during my scarce free time (usally at night): no support is granted but you can try :)
101+
102+
Along with your detailed problem description, you may need to attach plugin log files located at the same level of the Playnite executables (note the plugin!).
103+
104+
The right log files are named:
105+
- extensions.log
106+
- playnite.log
107+
108+

Resources/Screenshot_1.png

425 KB
Loading

Resources/Screenshot_10.png

26.7 KB
Loading

Resources/Screenshot_11.png

22 KB
Loading

Resources/Screenshot_2.png

177 KB
Loading

Resources/Screenshot_3.png

29.4 KB
Loading

Resources/Screenshot_4.png

14.3 KB
Loading

Resources/Screenshot_5.png

19.5 KB
Loading

Resources/Screenshot_6.png

67.6 KB
Loading

Resources/Screenshot_7.png

51.5 KB
Loading

0 commit comments

Comments
 (0)