V2 for the Orchid bot, officially moved here - v1 on GitHub.
- TypeScript 100%
| custom_modules | ||
| src | ||
| .gitignore | ||
| env.d.ts | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| validDids.json | ||
Orchid
Gracefully connect your Bluesky account to any Discord channel
Getting Started
To start, please invite the bot to your server using this URL. Once it has successfully joined, use the /connect command to subscribe to a user!
Commands
<> indicates required, [] indicates optional
| Command Name | Description | Usage |
|---|---|---|
/botinfo |
(global) Display information about Orchid | /botinfo |
/account connect |
Connect your BlueSky account | /connect <handle> [embed provider] [replies] [message] [regex] |
/account delete |
Disconnect your BlueSky account | /disconnect <handle> |
/help |
Display help page | /help |
/list |
Display subscribed users in channel | /list |
Self-Hosting
Prerequisites
NodeJS (v18.19.0+) & NPM must be installed. Once installed, please globally install typescript for convenience:
npm i --global typescript
Now that that's out of the way, let's get to it.
Setting Up
Clone this repository:
git clone https://git.kyanoxia.com/kyanoxia/orchid-v2.git
Travel into that directory:
cd orchid
Install Dependencies:
npm i
Create your environment variables:
touch .env
Start the bot:
npm run dev
Environment Variables
| Variable Name | Description |
|---|---|
token |
Your discord bot token |
clientID |
Your discord bot Client ID |
clientSecret |
Your discord bot Client ID |
If you are unfamiliar with creating environment variables, please refer to this page.