Patreon Integration Setup

This guide helps you integrate Patreon authentication into your Ren'Py game.

1. Create a Patreon Client

Go to Patreon Developer Portal and click Create Client. Fill in the fields as follows:

• App Name: Your game’s name
• Description: Short message shown during login
• App Category: Choose any
• Redirect URIs: http://127.0.0.1:6167/auth
• Client API Version: 2
• Other fields can be left empty

After creation, copy your Client ID.

2. Add to Your Game

Add this line to your options.rpy:

define PATREON_CLIENT_ID = "<YOUR_CLIENT_ID>"

Replace <YOUR_CLIENT_ID> with your actual Client ID.

Patreon Files

From the downloaded archive, copy the patreon_auth folder into your game directory:

MyGame/game/patreon_auth

Add a Login Button

You can trigger the login with:

PatreonAuth(PATREON_CLIENT_ID)

Example:

textbutton _("Auth with Patreon") action PatreonAuth(PATREON_CLIENT_ID)

3. Accessing User Info

After login, user data is saved in:

persistent.PATREON_USER_DATA

Example - get user’s full name:

persistent.PATREON_USER_DATA.get("data").get("attributes").get("full_name")

More fields: User API Reference

4. Add Extra Scopes (e.g., Email) (optional)

Edit patreon_auth/PatreonAuth.rpy and update the scope:

scope = "identity identity[email]"

Also update the fields requested in on_success_auth:

user = client.get_user_data({
  "fields[user]": "full_name,image_url,email"
})

More info: Scopes Reference

5. Check Patreon Tier

To check if the user is a patron of your game:

1. Open the tier edit page on Patreon
2. Get the Tier ID from the URL:
   Example:
   URL: https://www.patreon.com/membership/1234567
   ID: 1234567

Define your tier list:

define PATREON_TIERS = ["1234567", "2345678", "3456789"]

Then check membership like this:

included = persistent.PATREON_USER_DATA.get("included", [])
my_tiers = list(filter(lambda data: data.get("id") in PATREON_TIERS, included))

If subscribed, my_tiers will be a non-empty list of tier info.

[{ 'id': '1234567', 'type': 'tier', 'attributes': { 'amount_cents': 300, 'title': 'My Tier for $3' }}]

More info: Member API Reference

6. Refreshing Data

To manually update user data (example code, may need testing):

client = PatreonClient(persistent.PATREON_TOKENS.get("access_token"))
user = client.get_user_data({
  "fields[user]": "full_name,image_url",
  "fields[tier]": "title,amount_cents",
  "include": "memberships.currently_entitled_tiers"
})
persistent.PATREON_USER_DATA = user
renpy.restart_interaction()

7. Token Expiration

Patreon tokens expire after about 1 month.

• You can refresh them manually — see Token Refresh Guide
• Or ask the user to log in again

return "http://localhost:" + str(webserver.PORT) + self.callback_url

return "http://127.0.0.1:" + str(webserver.PORT) + self.callback_url