# Birb
Source: https://docs.astrobirb.dev/Birb



Birb is built with staff teams in mind. Helping you manage tasks, leaves, and staff operations.

<Columns>
  <Card title="Bot" icon="user-robot" href="/bot">
    Read about the bots features & how-to-dos
  </Card>

  <Card title="Website" icon="desktop" href="/website">
    Read about the websites feature & how-to-dos.
  </Card>
</Columns>


# Bot
Source: https://docs.astrobirb.dev/bot

The discord app is the primary way on how you manage your staff team, with 50+ commands to fully take advantage of Birb.

<Columns>
  <Column>
    <Card title="Features" icon="sparkles" href="/infractions-bot">
      View our bots features.
    </Card>
  </Column>

  <Column>
    <Card title="Help" icon="hands-helping">
      View frequently asked questions & tidbits.
    </Card>
  </Column>
</Columns>


# Frequent Questions
Source: https://docs.astrobirb.dev/frequent-questions

Frequently asked questions.

| Question                                     | Answers                                                                                                                                                                                                                                                                                                                                                                                   |
| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Is Birb a paid service?                      | Yes, we are more lenient though on locked features.                                                                                                                                                                                                                                                                                                                                       |
| How can I "partner" / "affiliate" with Birb? | While this a thing inside the 'ER:LC' community, and we have a large following from that community.<br />We do not partake in engaging in mass partnerships for the sake of growth, we would<br />rather have the partnership actually mean something.                                                                                                                                    |
| Will there be a dashboard?                   | There is a dashboard that's in development. Over 2 years, we've gone through multiple prototypes but were never able to stick the landing. <br />However, this time we've created something that can be finished, but the question is 'When?' <br />The dashboard is being worked on by one person, and that one person has a life, so development is quite slow. <br />There is no ETA." |
| Can I become a developer?                    | You can contribute to Birb @ [Open Source](https://github.com/bugsbirb/Birb). Keep in mind we have the right to deny your pull request, even if it adds a lot of content.<br />We advise not vibe coding, it creates issues in the long run and becomes a problem.                                                                                                                        |
| How can I become staff?                      | You will be notified next time the staff applications are open in our discord server.                                                                                                                                                                                                                                                                                                     |
| How do I report staff?                       | You can report a staff member in the discord server, go to [#get-support](https://discord.com/channels/1092976553752789054/1328460590120702094) and open a management ticket.                                                                                                                                                                                                             |

## Subscriptions

| Question                                      | Answers                                                                                                                                                                                                                                             |
| :-------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| How to link my discord account to patreon?    | [Follow this guide](https://support.patreon.com/hc/en-gb/articles/212052266-Getting-Discord-access)                                                                                                                                                 |
| How do I get premium?                         | [Subscribe here](https://www.patreon.com/checkout/AstroBirb?rid=22855340\&vanity=11440929)                                                                                                                                                          |
| How do I get Whitelabel?                      | [Subscribe here](https://www.patreon.com/checkout/AstroBirb?rid=22733636\&vanity=11440929)                                                                                                                                                          |
| Is premium worth it?                          | It depends. The bot is hardly locked down, so maybe you don't need it at all if you don't use certain feature,<br />but there some big features that are locked down by premium (e.g Infraction Demotions, Forum management and modmail categories) |
| Why do you lock down features behind premium? | Running the website, bot, and other services behind the scenes is expensive. If we are actively losing money, there's no incentive to keep Birb operational.                                                                                        |
| What does Whitelabel do?                      | The whitelabel subscription allows you to have a bot run by us, the benefits of this is that events & tasks ran by Birb will run faster. <br />This means your daily questions or leaves will show up much quicker.                                 |


# Infractions
Source: https://docs.astrobirb.dev/infractions-bot

Punish staff members using action workflows, Roblox integration and more.

Infractions allow you to manage your staff members more efficiently, which also integrates well with other established modules such as *Quota* and *Staff Database*.

<Frame>
  <img alt="Image" />
</Frame>

## How to setup

### Approval

<Steps>
  <Step title="Infraction Settings">
    <Frame>
      <img alt="Image" />
    </Frame>

    On the infractions settings page, press the \`infraction approval\` button, this will bring up a menu.
  </Step>

  <Step title="Approval Settings">
    <Frame>
      <img alt="Image" />
    </Frame>

    On the approval settings, select a channel *(required)*, and if you want select a Approval Ping *(optional)* use the Approval Ping drop-down.

    * Channel: This is the channel the approval message with be sent to.
    * Approval Ping: People with this role will be pinged, with the message sent to the channel.<br />
  </Step>
</Steps>

### Actions & Types

<Steps>
  <Step title="Infraction Settings">
    <Frame>
      <img alt="Image" />
    </Frame>

    On the infractions settings page, press the \`Infraction Types\` button, this will bring up a menu.
  </Step>

  <Step title="Infraction Types Menu">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click 'Add'!
  </Step>

  <Step title="Infraction Type Modal">
    <Frame>
      <img alt="Image" />
    </Frame>

    Name your infraction type.
  </Step>

  <Step title="Infraction Types Menu">
    <Frame>
      <img alt="Image" />
    </Frame>

    1. Send to channel: Deviates from your original set infraction channel.
    2. Required Permissions: Elevates permissions for the type.
    3. Use Hierarchy (PREMIUM): Requires the Hierarchy configuration, will allow for demotions with the Hierarchy feature.
    4. Remove Roles: Using discord roles, it'll prompt a role dropdown. Any role selected in the configuration will be removed from a staff member.
    5. Give Roles: Using discord roles, it'll prompt a role dropdown. Any role selected in the configuration will be given to the staff member.
    6. Escalate: If the action hits a threshold of X, it'll escalate to another infraction type.
  </Step>
</Steps>

### Commands

| Command              | Permissions | Purpose<br />                                                                                         |
| -------------------- | ----------- | ----------------------------------------------------------------------------------------------------- |
| /infraction issue    | Admin       | This is how you infract people using the bot, currently the primary way of infracting people.         |
| /infraction view     | Admin       | This allows you to view, manage & void infractions.                                                   |
| /infraction list     | Admin       | This allows you to list of infractions based on staff members or global & expired/voided infractions. |
| /infraction multiple | Admin       | This is how you infract multi people at once using the bot.                                           |

### Variables

| Variable           | Value                                 |
| ------------------ | ------------------------------------- |
| `{staff.name}`     | The targets name.                     |
| `{staff.mention}`  | The targets mention. (@User)          |
| `{staff.avatar}`   | The targets avatar.                   |
| `{author.mention}` | The authors mention. (@User)          |
| `{author.avatar}`  | The authors avatar.                   |
| `{author.name}`    | The authors name.                     |
| `{action}`         | The type of infraction that was used. |
| `{reason}`         | The reason for the infraction.        |
| `{notes}`          | What was noted on the infraction.     |


# Infractions
Source: https://docs.astrobirb.dev/infractions-website

Punish staff members using action workflows, Roblox integration and more.

Infractions allow you to manage your staff members more efficiently, which also integrates well with other established modules such as *Quota* and *Staff Database*.

<Frame>
  <img alt="Image" />
</Frame>

## How to void/delete an infraction

<Steps>
  <Step title="Infractions Page">
    <Frame>
      <img alt="Image" />
    </Frame>

    On the infractions page, hover over an infraction you want to void, and click.
  </Step>

  <Step title="Voiding it">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click the red button, it'll prompt you whether you want to void, say yes.
  </Step>
</Steps>

## How to edit an infraction

<Steps>
  <Step title="Infractions Page">
    <Frame>
      <img alt="Image" />
    </Frame>

    On the infractions page, hover over an infraction you want to edit, and click.
  </Step>

  <Step title="Editing the infraction">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click the edit button, the button that is being pointed at with 3 arrows.
  </Step>

  <Step title="The Prompt">
    <Frame>
      <img alt="Image" />
    </Frame>

    Fill out the details that you want to change, and hit submit!
  </Step>
</Steps>


# Modules
Source: https://docs.astrobirb.dev/modules

Our bot is modular, you can disable/enable modules if you aren't using them.

## How to enable & disable a module

<Steps>
  <Step title="Most importantly, run the configuration command /config.">
    <Frame>
      <img alt="Image" />
    </Frame>
  </Step>

  <Step title="Config Menu & Click on Modules">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click on the module select option within in the Config Menu.
  </Step>

  <Step title="Selecting the modules">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click on the modules dropdown option, for the modules you want to select them.
  </Step>

  <Step title="Click anywhere else.">
    <Frame>
      <img alt="Image" />
    </Frame>

    Now click anywhere else but the dropdown menu, it should prompt a `Modules Saved` popup.

    The module is now the module is enabled!
  </Step>
</Steps>


# Permissions
Source: https://docs.astrobirb.dev/permissions

We have a permission system that relies on discord roles, it dictates what commands you can and cannot use.

## Setup Permissions

<Steps>
  <Step title="Most importantly, run /config.">
    <Frame>
      <img alt="Image" />
    </Frame>
  </Step>

  <Step title="Config Menu & Click on permissions.">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click on the permissions select option within in the Config Menu.
  </Step>

  <Step title="Select the staff role & admin role.">
    <Frame>
      <img alt="Image" />
    </Frame>

    Select the staff role & admin role that fits the description. If you can't see the role on the dropdown list, remember you can search inside the dropdown box. 
  </Step>

  <Step title="Finish">
    <Frame>
      <img alt="Image" />
    </Frame>

    Your permissions menu should look like this!
  </Step>
</Steps>


# Promotions
Source: https://docs.astrobirb.dev/promotions

Promote people using automated role Hierarchies.

Promotions allows you to promote people up the ranks more easily, Birb automatically calculates which role should come next, and applies those changes. These Hierarchies can be grouped into different departments.

<Frame>
  <img alt="Image" />
</Frame>


# Setup
Source: https://docs.astrobirb.dev/setup

This is a general overview of the setup progress.

## Step 1 - Permissions

<Steps>
  <Step title="Most importantly, run /config.">
    <Frame>
      <img alt="Image" />
    </Frame>
  </Step>

  <Step title="Config Menu & Click on permissions.">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click on the permissions select option within in the Config Menu.
  </Step>

  <Step title="Select the staff role & admin role.">
    <Frame>
      <img alt="Image" />
    </Frame>

    Select the staff role & admin role that fits the description. If you can't see the role on the dropdown list, remember you can search inside the dropdown box. 
  </Step>

  <Step title="Finish">
    <Frame>
      <img alt="Image" />
    </Frame>

    Your permissions menu should look like this!
  </Step>
</Steps>

## Step 2 - Modules

<Steps>
  <Step title="Most importantly, run the configuration command /config.">
    <Frame>
      <img alt="Image" />
    </Frame>
  </Step>

  <Step title="Config Menu & Click on Modules">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click on the module select option within in the Config Menu.
  </Step>

  <Step title="Selecting the modules">
    <Frame>
      <img alt="Image" />
    </Frame>

    Click on the modules dropdown option, for the modules you want to select them.
  </Step>

  <Step title="Click anywhere else.">
    <Frame>
      <img alt="Image" />
    </Frame>

    Now click anywhere else but the dropdown menu, it should prompt a `Modules Saved` popup.

    The module is now the module is enabled!
  </Step>
</Steps>

# Step 3 - The End

> You've successfully set up the bot (hopefully), you can now click on other modules and set them up.
>
> Read specific setups for modules in the [documentation](https://docs.astrobirb.dev).


# Tickets
Source: https://docs.astrobirb.dev/tickets

Create communication channels for your members to ask questions.

Tickets allows people to ask questions and enquiries about your server. Birb allows you to manage the ticket channel with commands & button which makes it easy to use.

<Frame>
  <img alt="Image" />
</Frame>


# Variables
Source: https://docs.astrobirb.dev/variables

These are the variables for custom embed handling.

## Global Variables

<Tabs>
  <Tab title="Guild">
    | Variable                     | Description          |
    | ---------------------------- | -------------------- |
    | `{guild.name}`               | Server name          |
    | `{guild.id}`                 | Server ID            |
    | `{guild.icon}`               | Server icon URL      |
    | `{guild.banner}`             | Server banner URL    |
    | `{guild.member_count}`       | Member count         |
    | `{guild.created_at}`         | Server creation date |
    | `{guild.description}`        | Server description   |
    | `{guild.boost_tier}`         | Boost/premium tier   |
    | `{guild.boost_count}`        | Number of boosts     |
    | `{guild.role_count}`         | Number of roles      |
    | `{guild.channel_count}`      | Number of channels   |
    | `{guild.emoji_count}`        | Number of emojis     |
    | `{guild.verification_level}` | Verification level   |
    | `{guild.vanity_url}`         | Vanity invite URL    |
  </Tab>

  <Tab title="Roles">
    | Variable           | Description                                  |
    | ------------------ | -------------------------------------------- |
    | `{X.mention}`      | Role mention                                 |
    | `{X.name}`         | Role name                                    |
    | `{X.id}`           | Role ID                                      |
    | `{X.color}`        | Role color                                   |
    | `{X.position}`     | Role hierarchy position                      |
    | `{X.member_count}` | Number of members with the role              |
    | `{X.hoisted}`      | Whether the role is hoisted (`Yes`/`No`)     |
    | `{X.mentionable}`  | Whether the role is mentionable (`Yes`/`No`) |
    | `{X.created_at}`   | Role creation date                           |
  </Tab>

  <Tab title="Members">
    | Variable           | Description                              |
    | ------------------ | ---------------------------------------- |
    | `{X.mention}`      | Member mention                           |
    | `{X.display_name}` | Member display name                      |
    | `{X.id}`           | Member ID                                |
    | `{X.name}`         | Member global name                       |
    | `{X.tag}`          | Member's primary guild tag               |
    | `{X.avatar}`       | Avatar URL                               |
    | `{X.created_at}`   | Account creation date                    |
    | `{X.joined_at}`    | Server join date                         |
    | `{X.top_role}`     | Member's highest role                    |
    | `{X.role_count}`   | Number of roles (excluding @everyone)    |
    | `{X.boosting}`     | Whether boosting the server (`Yes`/`No`) |
    | `{X.bot}`          | Whether the member is a bot (`Yes`/`No`) |
    | `{X.status}`       | Online status                            |
  </Tab>

  <Tab title="Channel">
    | Variable               | Description                 |
    | ---------------------- | --------------------------- |
    | `{channel.name}`       | Channel name                |
    | `{channel.id}`         | Channel ID                  |
    | `{channel.mention}`    | Channel mention             |
    | `{channel.topic}`      | Channel topic               |
    | `{channel.category}`   | Parent category name        |
    | `{channel.jump_url}`   | Link to jump to the channel |
    | `{channel.nsfw}`       | Whether the channel is NSFW |
    | `{channel.slowmode}`   | Slowmode delay              |
    | `{channel.position}`   | Channel position            |
    | `{channel.created_at}` | Channel creation date       |
  </Tab>

  <Tab title="Tools">
    | Variable                     | Description                       |
    | ---------------------------- | --------------------------------- |
    | `{date}`                     | Current date (`YYYY-MM-DD`)       |
    | `{time}`                     | Current time (`HH:MM:SS`)         |
    | `{year}`                     | Current year                      |
    | `{timestamp}`                | Current Unix timestamp            |
    | `{timestamp.short_time}`     | Discord short time timestamp      |
    | `{timestamp.long_time}`      | Discord long time timestamp       |
    | `{timestamp.short_date}`     | Discord short date timestamp      |
    | `{timestamp.long_date}`      | Discord long date timestamp       |
    | `{timestamp.short_datetime}` | Discord short date+time timestamp |
    | `{timestamp.long_datetime}`  | Discord long date+time timestamp  |
    | `{timestamp.relative}`       | Discord relative timestamp        |
    | `{newline}`                  | Line break                        |
    | `{blank}`                    | Zero-width space                  |
  </Tab>
</Tabs>

## Module Variables

<Tabs>
  <Tab title="Infraction">
    | Variable       | Description                                         |
    | -------------- | --------------------------------------------------- |
    | `{action}`     | Infraction action type                              |
    | `{reason}`     | Infraction reason                                   |
    | `{notes}`      | Infraction notes                                    |
    | `{expiration}` | Expiration date (relative)                          |
    | `{new.x}`      | X applies to any variable from the roles section.   |
    | `{previous.x}` | X applies to any variable from the roles section.   |
    | `{staff.x}`    | X applies to any variable from the members section. |
    | `{author.x}`   | X applies to any variable from the members section. |
  </Tab>

  <Tab title="Promotion">
    | Variable          | Description                                       |
    | ----------------- | ------------------------------------------------- |
    | `{newrank}`       | Mention of the new rank role                      |
    | `{previous_rank}` | Mention of the previous rank role                 |
    | `{reason}`        | Promotion reason                                  |
    | `{notes}`         | Promotion notes                                   |
    | `{promotion.id}`  | Promotion's random string ID                      |
    | `{new.x}`         | X applies to any variable from the roles section. |
    | `{previous.x}`    | X applies to any variable from the roles section. |
  </Tab>

  <Tab title="Feedback">
    | Variable     | Description     |
    | ------------ | --------------- |
    | `{feedback}` | Feedback        |
    | `{rating}`   | Feedback rating |
  </Tab>

  <Tab title="Suggestions">
    | Variable       | Description          |
    | -------------- | -------------------- |
    | `{suggestion}` | Suggestion text      |
    | `{image}`      | Suggestion image URL |
    | `{upvotes}`    | Number of upvotes    |
    | `{downvoters}` | Number of downvotes  |
    | `{reason}`     | Suggestion reason    |
  </Tab>
</Tabs>

## `X` Variables

X marks a placeholder prefix, replace it with the prefix given in each module (new, previous, staff, author, etc.) to form the actual variable, e.g. `{X.mention}` → `{staff.mention}`.


# Website
Source: https://docs.astrobirb.dev/website

The website is our interactive a way to manage your staff team.

<Columns>
  <Column>
    <Card title="Features" icon="sparkles" href="/infractions-bot">
      View our websites features.
    </Card>
  </Column>

  <Column>
    <Card title="Help" icon="hands-helping">
      View frequently asked questions & tidbits.
    </Card>
  </Column>
</Columns>