Skip to content

Commit

Permalink
Merge pull request #37 from srobo/docs/improve-setup-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
raccube authored Sep 3, 2024
2 parents 668a7b6 + f7870b0 commit 64c9b3b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,16 @@ For development, see `script/requirements.txt`

# Discord server set-up instructions

- ensure the `@everyone` role cannot see any channels by default.
- Ensure the `@everyone` role cannot see any channels by default.
- Create a role named `Verified` which can see the base channels (i.e. #general)
- Create a role named `Unverified Volunteer` which can see the volunteer onboarding channel.
- Create a role named `Blueshirt`.
- Create a role named `Team Supervisor`.
- Create a new channel category called `welcome`, block all users from reading this category in its permissions.
- Create channel categories called `Team Channels` and `Team Voice Channels`.
- Create a channel named `#blog`, block all users from sending messages in it.
- Set a Blueshirt password using `/passwd tla:SRZ new_password:`
- Make sure that the SRbot role is at the top of the role list (it can only assign roles below its own)
- Create teams using the `/team new` command.

And voilà, any new users should automatically get their role assigned once they enter the correct password.
Expand All @@ -36,5 +38,5 @@ And voilà, any new users should automatically get their role assigned once they
3. Copy `.env` and fill it out with the application token and guild ID. In order to get the guild ID, you will need to enable developer mode in Discord's settings. Once enabled, right click the guild (server) in the sidebar and click `Copy Server ID`.
4. `pip install .`
5. `python -m sr.discord_bot`
6. In the server settings, ensure the `/join` command cannot be used by the `Verified` role
6. In the server settings, ensure the `/join` command can be used by `@everyone` but cannot be used by the `Verified` role
7. Ensure the `/passwd` commands can only be used by `Blueshirt`s
3 changes: 2 additions & 1 deletion src/sr/discord_bot/commands/stats.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ def __eq__(self, comp: object) -> bool:
@app_commands.guild_only()
@app_commands.default_permissions()
class Stats(app_commands.Group):
pass
def __init__(self) -> None:
super().__init__(description="Posts team member statistics")


@app_commands.command(name='post') # type:ignore[arg-type]
Expand Down

0 comments on commit 64c9b3b

Please sign in to comment.