Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unfloned/rebar-discord-auth
https://github.com/unfloned/rebar-discord-auth
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/unfloned/rebar-discord-auth
- Owner: unfloned
- Created: 2024-05-13T11:33:47.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-07T09:14:22.000Z (7 months ago)
- Last Synced: 2024-06-07T10:38:18.241Z (7 months ago)
- Language: TypeScript
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Discord Auth for Rebar Framework
this plugin allows a user to login and automatically register on your server with an discord ID.
they are required using discord
## Features
- Login and automatically register with Discord.
- Whitelist and server check with [Discord Integration](https://github.com/unfloned/rebar-discord)
## Requires
- [Rebar Framework](https://github.com/Stuyk/rebar-altv)
optional:
- [Discord Integration](https://github.com/unfloned/rebar-discord) when in config file is set:
- SERVER_ID or
- WHITELIST_ROLE_ID
## API
if you need to listen for when a player is successfully logged in you can use the `discord-auth-api`
```ts
import * as alt from 'alt-server';
import { useRebar } from '@Server/index.js';
const Rebar = useRebar();
const api = Rebar.useApi();
function handleLogin(player: alt.Player) {}
async function init() {
// Get the API
const auth = api.getAsync('discord-auth-api');
// Hook in your event
auth.onLogin(handleLogin);
}
init();
```
## Installation
Preparation
Before you can use the OAuth token you need to create a Discord application.
To create a new application you need to:
- Open the Discord Developer Portal and login with your discord account
- Click the "New Application" button on the top right
- Fill in your applications name and click on create
- Go to "OAuth2" and then "General"
- Click on "Add Redirect", enter http://127.0.0.1 and click "Save Changes" in the bottom bar
- Copy the "CLIENT ID" on the top - it will be needed for the next step
From the main directory of your `Rebar` Framework.
```
git clone https://github.com/unfloned/rebar-discord-auth.git src/plugins/discord-auth
```
check `server/config.ts` to fill up all information needed, like CLIENT_ID from Developer Portal.
That's it.
if you wish to save the plugin in your own repository, go to `src/plugins/discord-auth` folder and delete the `.git` folder.
### Usage with [rebar-character-select](https://github.com/Stuyk/rebar-character-select)
just change from `auth-api` to `discord-auth-api` in `rebar-character-select/server/index.ts` line 223 and 224.