From b2cc5680d6e4d0975be1bc3fc8189f083d3c1b53 Mon Sep 17 00:00:00 2001 From: "Karina J. Kwiatek" Date: Wed, 4 Sep 2024 00:28:07 +0200 Subject: [PATCH 1/2] Add more detail to setup instructions --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a33311..1bb2ac0 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ 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`. @@ -25,6 +25,8 @@ For development, see `script/requirements.txt` - 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. @@ -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 From f7870b05d2d466b9cac73bb75989b939cb9d11e7 Mon Sep 17 00:00:00 2001 From: "Karina J. Kwiatek" Date: Wed, 4 Sep 2024 00:29:39 +0200 Subject: [PATCH 2/2] Add description to `/stats` --- src/sr/discord_bot/commands/stats.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/sr/discord_bot/commands/stats.py b/src/sr/discord_bot/commands/stats.py index 4b0c87b..4107e53 100644 --- a/src/sr/discord_bot/commands/stats.py +++ b/src/sr/discord_bot/commands/stats.py @@ -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]