feat: add Roblox social provider (#1249)

* Implemented Roblox social provider + documentation + icon for builder * linter didn't like my svg and some of my other formatting * and now the linter is finally happy * made discord scope option overwrite default scopes, this way I dont need to have a users' email * Revert "made discord scope option overwrite default scopes, this way I dont need to have a users' email" This reverts commit 35b29e7957935ca2c777772a6a88dfa67015ed7b. --------- Co-authored-by: Bereket Engida <86073083+Bekacru@users.noreply.github.com>
2025-12-10 12:27:44 +00:00 · 2025-02-14 11:11:50 +01:00
parent 047d677966
commit e647040b14
4 changed files with 158 additions and 0 deletions
--- a/docs/content/docs/authentication/roblox.mdx
+++ b/docs/content/docs/authentication/roblox.mdx
@@ -0,0 +1,51 @@
+---
+title: Roblox
+description: Roblox provider setup and usage.
+---
+
+<Steps>
+    <Step> 
+        ### Get your Roblox Credentials
+        Get your Roblox credentials from the [Roblox Creator Hub](https://create.roblox.com/dashboard/credentials?activeTab=OAuthTab).
+
+        Make sure to set the redirect URL to `http://localhost:3000/api/auth/callback/roblox` for local development. For production, you should set it to the URL of your application. If you change the base path of the auth routes, you should update the redirect URL accordingly.
+        
+        <Callout type="info">
+            The Roblox API does not provide email addresses. As a workaround, the user's `email` field uses the `preferred_username` value instead.
+        </Callout>
+    </Step>
+
+  <Step>
+        ### Configure the provider
+        To configure the provider, you need to import the provider and pass it to the `socialProviders` option of the auth instance.
+
+        ```ts title="auth.ts"  
+        import { betterAuth } from "better-auth" 
+        
+        export const auth = betterAuth({
+            socialProviders: {
+                roblox: { // [!code highlight]
+                    clientId: process.env.ROBLOX_CLIENT_ID, // [!code highlight]
+                    clientSecret: process.env.ROBLOX_CLIENT_SECRET, // [!code highlight]
+                }, // [!code highlight]
+            },
+        })
+        ```
+    </Step>
+       <Step>
+        ### Sign In with Roblox 
+        To sign in with Roblox, you can use the `signIn.social` function provided by the client. The `signIn` function takes an object with the following properties:
+        - `provider`: The provider to use. It should be set to `roblox`.
+
+        ```ts title="auth-client.ts"  
+        import { createAuthClient } from "better-auth/client"
+        const authClient =  createAuthClient()
+        
+        const signIn = async () => {
+            const data = await authClient.signIn.social({
+                provider: "roblox"
+            })
+        }
+        ```
+    </Step>
+</Steps>