Skip to content

Commit 16dcebd

Browse files
authored
Add /get-api-url to help message (#274)
1 parent 7193d04 commit 16dcebd

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

src/discord-cluster-manager/cogs/leaderboard_cog.py

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,7 @@ def __init__(self, bot: "ClusterBot"):
377377
name="get-submission", description="Retrieve one of your past submissions"
378378
)(self.get_submission_by_id)
379379

380+
380381
# --------------------------------------------------------------------------
381382
# | HELPER FUNCTIONS |
382383
# --------------------------------------------------------------------------
@@ -726,3 +727,44 @@ async def get_submission_by_id(
726727
msg += "\n"
727728

728729
await send_discord_message(interaction, msg, ephemeral=True, file=file)
730+
731+
# Help
732+
@with_error_handling
733+
async def get_help(
734+
self,
735+
interaction: discord.Interaction,
736+
):
737+
help_message = """
738+
# Leaderboard Commands Help
739+
740+
## Basic Commands
741+
- `/get-api-url` \
742+
- For popcorn-cli users, get the API URL
743+
- `/leaderboard list` \
744+
- View all active leaderboards
745+
- `/leaderboard help` \
746+
- Show this help message
747+
- `/leaderboard show <leaderboard_name>` \
748+
- View all submissions for a leaderboard
749+
- `/leaderboard show-personal <leaderboard_name>` \
750+
- View your submissions for a leaderboard
751+
752+
## Submission Commands
753+
- `/leaderboard submit ranked <leaderboard_name> <script>` \
754+
- Submit a ranked run for a leaderboard
755+
- `/leaderboard submit test <leaderboard_name> <script>` \
756+
- Test your submission without affecting rankings
757+
- `/leaderboard get-submission <submission_id>` \
758+
- Retrieve one of your past submissions
759+
760+
## Task Information
761+
- `/leaderboard task <leaderboard_name>` \
762+
- Get reference code for a leaderboard
763+
- `/leaderboard template <leaderboard_name> <language>` \
764+
- Get a starter template for a task
765+
766+
## Documentation
767+
For more detailed information, visit our documentation:
768+
https://gpu-mode.github.io/discord-cluster-manager/docs/intro/
769+
"""
770+
await send_discord_message(interaction, help_message, ephemeral=True)

0 commit comments

Comments
 (0)