https://github.com/rorro/uncle

A Discord bot to help you manage your OSRS clan
https://github.com/rorro/uncle

discord discordjs hacktoberfest typescript

Last synced: 7 days ago
JSON representation

A Discord bot to help you manage your OSRS clan

• Host: GitHub
• URL: https://github.com/rorro/uncle
• Owner: rorro
• License: mit
• Created: 2022-04-29T11:17:11.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T23:03:34.000Z (2 months ago)
• Last Synced: 2024-08-29T00:22:32.288Z (2 months ago)
• Topics: discord, discordjs, hacktoberfest, typescript
• Language: TypeScript
• Homepage:
• Size: 450 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


### **Uncle**

## ![Uncle](https://imgur.com/Ovj9FtF.png)

I am the official Uncle of the Legacy OSRS Clan






#### Suggestions and bugs

Have a suggestion or a bug to report? [Click here to create a issue.](https://github.com/rorro/uncle/issues)




#### Some notes

This project does some very clan specific things that you will need to heavily modify or comform to, to be able to use the code as is. For this we use the Google Workspace APIs, so you will need to setup access credentials. Find the link in the instructions for running the project. You might also need to configure some variables in `src/config.ts` so it matches your own server if you are going to host this bot for your own clan.




#### Running the project

1. Create a .env.development file in the root folder of the project folder and add the following to it.

```

DISCORD_TOKEN={discord_bot_token}

CLIENT_ID={discord_bot_id}

CLIENT_SECRET={discord_bot_secret}

GUILD_ID={guild_id}

APPLICATION_MANAGER_ROLE={role_id}

STAFF_ROLE={role_id}

MEMBER_ROLE={role_id}

PROTECTOR_ROLE={role_id}

BULWARK_ROLE={role_id}

JUSTICIAR_ROLE={role_id}

DIARY_SHEETS_FOLDER={google_drive_folder_id}

DIARY_SHEET={google_sheets_sheet_id}

LEADERBOARD_SHEET={google_sheets_sheet_id}

SPLITS_SHEET={google_sheets_sheet_id}

URL=localhost

PORT=7373

SITE_URL=localhost

SITE_PORT=3000

```

2. For some commands to work, you will need to create access credentials for Google Workspace APIs. Follow [this link](https://developers.google.com/workspace/guides/create-credentials) and create a service account. After creating a servie account, download the credentials as a JSON file, rename the file to `unclebot-credentials.json` and add it to the root folder of the project.

3. Run the project using `npm i` and then `npm run dev`




#### Related projects

[Uncle Dashboard](https://github.com/rorro/uncle-dashboard) - A dashboard to change settings, schedule messages and more.