Merge pull request #163 from crimsobot/cringo-housekeeping

Formatting, embed, help text updates

crimsobot/cogs/cringo.py

@@ -109,11 +109,13 @@ def generate_join_test_message_embed(self) -> discord.Embed:
             title='Welcome to **CRINGO!**',
             descr='\n'.join([
                 'Match the emojis called to the emojis on your card.',
-                'If you see a match, type the column and row of the match!',
-                'Type `.<letter><number>` or `. <letter><number>`.',
+                'If you see a match, type the letter and number of the match!',
                 'You can put in multiple matches separated by a space!',
-                'For example: `.a1 b2 c4` or `. b4 c3`. Only use one period!',
-                'Missed a match on a previous turn? No problem! Put it in anyway.',
+                '',
+                'For example: `.a1 b2 c4` or `. b4 c3`',
+                '',
+                'Only use one period!',
+                'Missed a match on a previous turn? No problem! Put it in.',
                 "You'll still get your points (but with a lower multiplier).",
                 'Need to leave the game? Type `.leave` during a round.',
             ]),
@@ -159,7 +161,7 @@ def generate_join_already_playing_embed(self, who: discord.Member) -> discord.Em
     def generate_join_success_embed(self, who: discord.Member) -> discord.Embed:
         embed = c.crimbed(
             title='',
-            descr=f'**{who}** has joined the game!',
+            descr=f'**{who.name}** has joined the game!',
             color_name='green',
             thumb_name=''
         )
@@ -183,7 +185,7 @@ def remove_from_game(self, user: discord.User) -> discord.Embed:
         CringoGame.all_players.discard(user.id)
         embed = c.crimbed(
             title=None,
-            descr=f'{user} has left the game.',
+            descr=f'**{user.name}** has left the game.',
             color_name='yellow',
         )
 
@@ -193,11 +195,11 @@ def get_scoreboard(self, *, game_finished: bool = False) -> CringoScoreboard:
         scoreboard_rows = []
         sorted_players = sorted(self.players, key=lambda item: item.score, reverse=True)
         for player in sorted_players:
-            coin_display = 'zero' if self.cursed else round(player.winnings, 2)
+            coin_display = 0.00 if self.cursed else round(player.winnings, 2)
             if game_finished:
-                row = f'{player.user} · **{player.score}** points · **\u20A2{coin_display}**'
+                row = f'{player.user.name} · **{player.score}** points · **\u20A2{coin_display:.2f}**'
             else:
-                row = f'{player.user} · **{player.score}** points'
+                row = f'{player.user.name} · **{player.score}** points'
 
             scoreboard_rows.append(row)
 
@@ -227,7 +229,7 @@ async def send_cards(self) -> None:
                 CringoGame.all_players.discard(player.user.id)
                 embed = c.crimbed(
                     title=None,
-                    descr=f'{player.user} has left the game.',
+                    descr=f'{player.user.name} has left the game.',
                     color_name='yellow',
                 )
 
@@ -410,12 +412,19 @@ def __init__(self, bot: CrimsoBOT):
     @commands.group(aliases=['suffer'], invoke_without_command=True, brief='A quirky take on bingo.')
     @commands.max_concurrency(1, commands.BucketType.channel)
     async def cringo(self, ctx: commands.Context) -> None:
-        """A peculiar blend of slots and bingo that is totally not a ripoff of a popular 1990s PC game.
-        Points are awarded for matches [10], lines [100], and full card [1000].
-        The earlier you get a match, line, or full card, the higher the multiplier!
-        Everyone is awarded a handsome amount of crimsoCOIN for playing.
-        The more players in a game, the more crimsoCOIN everyone wins - assuming you don't get unlucky...
-        Play regular >cringo, >cringo mega, or >cringo mini!
+        """A peculiar blend of slots and bingo.
+        Totally not a ripoff of a popular 1990s PC game.
+
+        Points are awarded for:
+         - matches [10]
+         - lines [100]
+         - full card [1000]
+
+        The earlier you score, the higher the multiplier.
+        Higher score = more crimsoCOIN at the end.
+        More players = higher crimsoCOIN multiplier.
+
+        Play >cringo, >cringo mega, or >cringo mini!
         """
 
         # Fallback to regular four-line Cringo! if no command is provided, retains prior functionality
@@ -424,11 +433,13 @@ async def cringo(self, ctx: commands.Context) -> None:
     @cringo.command(name='mega')
     @commands.max_concurrency(1, commands.BucketType.channel)
     async def mega(self, ctx: commands.Context) -> None:
+        """A giant 6x6 board!"""
         await CringoGame(ctx, card_size=6).start()
 
     @cringo.command(name='mini')
     @commands.max_concurrency(1, commands.BucketType.channel)
     async def mini(self, ctx: commands.Context) -> None:
+        """A ridiculous 2x2 board!"""
         await CringoGame(ctx, card_size=2).start()
 
     @cringo.group(name='lb', aliases=['clb'], invoke_without_command=True)

crimsobot/utils/cringo.py

@@ -276,22 +276,6 @@ def line_score(direction: str, index: int = 0) -> bool:
             player.full_card = 1
 
 
-async def cringo_scoreboard(players: List[CringoPlayer], cursed: bool = False, game_finished: bool = False) -> str:
-    """Unpack the player objects to get something that can be sorted and displayed."""
-
-    scoreboard_rows = []
-    for player in players:
-        coin_display = 'zero' if cursed else player.winnings  # y'all dumb motherfuckers want a rounding error?
-        if game_finished:
-            row = f'{player.user} · **{player.score}** points · **{coin_display}** coin'
-        else:
-            row = f'{player.user} · **{player.score}** points'
-
-        scoreboard_rows.append(row)
-
-    return '\n'.join(scoreboard_rows)
-
-
 async def cringo_stats(player: CringoPlayer, won: bool) -> None:
     stats = await CringoStatistic.get_by_discord_user(player.user)  # type: CringoStatistic
 
@@ -333,7 +317,7 @@ async def cringo_stat_embed(user: DiscordUser) -> Embed:
         )
     else:
         embed = c.crimbed(
-            title='CRINGO! stats for {}'.format(user),
+            title=f'CRINGO! stats for {user.name}',
             descr=None,
             thumb_name='jester',
             footer='Since {d.year}-{d.month:02d}-{d.day:02d} · Regular CRINGO! only'.format(d=s.created_at),