kass/matteo-the-prestige
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Updated README and help text in the_presige

Browse Source 
Updated all of the help text for the commands to match the text in the readme and updated the readme, fixing a few spelling/grammar errors and removing the section about and all references to the now disabled pickup game funtionality.
This commit is contained in:
Genderdruid 2020-12-28 08:05:19 -08:00
parent 62a96521c5
commit 96a0a8a38e
2 changed files with 23 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -5,7 +5,7 @@ blaseball, blaseball, is back! in an unofficial capacity.
custom players, custom teams, custom leagues (that last one is coming soon™) all in discord!
we've also got things like player idolization, custom team creation, easy setup for your teams to play against each other, and quick pick-up games featuring any players you like, all powered by this bot and onomancer.
we've also got things like custom team creation, easy setup for your teams to play against each other, and player idolization, all powered by this bot and onomancer.
accepting pull requests, check the issues for to-dos.
@ -14,7 +14,7 @@ accepting pull requests, check the issues for to-dos.
### team commands:
- m;saveteam
- saves a team to the database allowing it to be used for games. send this command at the top of a list, with entries seperated by new lines (shift+enter in discord, or copy+paste from notepad).
- saves a team to the database allowing it to be used for games. send this command at the top of a list, with entries separated by new lines (shift+enter in discord, or copy+paste from notepad).
- the first line of the list is your team's name (cannot contain emoji).
- the second line is your team's icon and slogan, this should begin with an emoji followed by a space, followed by a short slogan.
- the next lines are your batters' names in the order you want them to appear in your lineup, lineups can contain any number of batters between 1 and 12.
@ -27,13 +27,13 @@ accepting pull requests, check the issues for to-dos.
- m;searchteams [searchterm]
- shows a paginated list of all teams whose names contain the given search term.
- m;deleteteam [teamname]
- allows you to delete the team with the provided name if you are the owner of it, gives a conformation first to prevent accidental deletions. if it isn't letting you delete your team, you probably created it before teams having owners was a thing, contact xvi and xie can assign you as the owner.
- allows you to delete the team with the provided name if you are the owner of it, gives a confirmation first to prevent accidental deletions. if it isn't letting you delete your team, you probably created it before teams having owners was a thing, contact xvi and xie can assign you as the owner.
### player commands:
- m;showplayer [name]
- displays any name's stars, there's a limit of 70 characters. that should be *plenty*. note: if you want to lookup a lot of different players you can do it on onomancer instead of spamming this command a bunch and clogging up discord: https://onomancer.sibr.dev/reflect
- m;idolize [name]
- records any name as your idol, mostly for fun but also can be used for pickup games.
- records any name as your idol, mostly for fun.
- m;showidol
- displays your idol's name and stars.
@ -43,12 +43,10 @@ accepting pull requests, check the issues for to-dos.
- the away team's name.
- the home team's name.
- and finally, optionally, the number of innings, which must be greater than 2 and less than 31. if not included it will default to 9.
- m;setupgame
- begins setting up a 3-inning pickup game. pitchers, lineups, and team names are given during the setup process by anyone. idols are easily signed up via emoji during the process. the game will start automatically after the setup is completed.
### other commands:
- m;help [command]
- shows the instuctions from here for given command. if no command is provided, it will instead provide a list of all of the commands that instructions can be provided for.
- shows the instructions from here for given command. if no command is provided, it will instead provide a list of all of the commands that instructions can be provided for.
- m;credit
- shows artist credit for matteo's avatar.
- m;roman [number]

36
the_prestige.py
View File

@ -53,7 +53,7 @@ class RomanCommand(Command):
class IdolizeCommand(Command):
name = "idolize"
template = "m;idolize [name]"
description = "Records any name as your idol, used elsewhere. There's a limit of 70 characters. That should be *plenty*."
description = "Records any name as your idol, mostly for fun. There's a limit of 70 characters. That should be *plenty*."
async def execute(self, msg, command):
if (command.startswith("meme")):
@ -94,7 +94,7 @@ class ShowIdolCommand(Command):
class ShowPlayerCommand(Command):
name = "showplayer"
template = "m;showplayer [name]"
description = "Displays any name's stars in a nice discord embed."
description = "Displays any name's stars in a nice discord embed, there's a limit of 70 characters. That should be *plenty*. Note: if you want to lookup a lot of different players you can do it on onomancer instead of spamming this command a bunch and clogging up discord: https://onomancer.sibr.dev/reflect"
async def execute(self, msg, command):
player_name = json.loads(ono.get_stats(command.split(" ",1)[1]))
@ -103,10 +103,10 @@ class ShowPlayerCommand(Command):
class StartGameCommand(Command):
name = "startgame"
template = "m;startgame [away] [home] [innings]"
description ="""To start a game with premade teams, use this command at the top of a list, with lines seperated by newlines (shift+enter in discord, or copy+paste from notepad)
- the first line is the away team's name
- the second is the home team's name
- optionally, the third is the number of innings, which must be greater than 2."""
description ="""Starts a game with premade teams made using saveteam, use this command at the top of a list followed by each of these in a new line (shift+enter in discord, or copy+paste from notepad):
- the away team's name.
- the home team's name.
- and finally, optionally, the number of innings, which must be greater than 2 and less than 31. if not included it will default to 9."""
async def execute(self, msg, command):
if config()["game_freeze"]:
@ -177,13 +177,13 @@ class SetupGameCommand(Command):
class SaveTeamCommand(Command):
name = "saveteam"
template = "m;saveteam [name] [slogan] [players]"
description = """To save an entire team, send this command at the top of a list, with lines seperated by newlines (shift+enter in discord, or copy+paste from notepad)
- the first line of the list is your team's name (cannot contain emoji)
- the second is your team's slogan
- the rest of the lines are your players' names
- the last player is designated your pitcher
if you did it correctly, you'll get a team embed with a prompt to confirm. Hit the 👍 and it'll be saved."""
description = """Saves a team to the database allowing it to be used for games. Send this command at the top of a list, with entries separated by new lines (shift+enter in discord, or copy+paste from notepad).
- the first line of the list is your team's name (cannot contain emoji).
- the second line is your team's icon and slogan, this should begin with an emoji followed by a space, followed by a short slogan.
- the next lines are your batters' names in the order you want them to appear in your lineup, lineups can contain any number of batters between 1 and 12.
- the final line is your pitcher's name.
if you did it correctly, you'll get a team embed with a prompt to confirm. hit the 👍 and it'll be saved."""
async def execute(self, msg, command):
if db.get_team(command.split("\n")[0]) == None:
save_task = asyncio.create_task(save_team_batch(msg, command))
@ -195,7 +195,7 @@ if you did it correctly, you'll get a team embed with a prompt to confirm. Hit t
class ShowTeamCommand(Command):
name = "showteam"
template = "m;showteam [name]"
description = "You can view any saved team with this command"
description = "Shows information about any saved team."
async def execute(self, msg, command):
team_name = command.strip()
@ -212,7 +212,7 @@ class ShowTeamCommand(Command):
class ShowAllTeamsCommand(Command):
name = "showallteams"
template = "m;showallteams"
description = "This displays a paginated list of all teams available for `startgame`"
description = "Shows a paginated list of all teams available for games which can be scrolled through."
async def execute(self, msg, command):
list_task = asyncio.create_task(team_pages(msg, games.get_all_teams()))
@ -221,7 +221,7 @@ class ShowAllTeamsCommand(Command):
class SearchTeamsCommand(Command):
name = "searchteams"
template = "m;searchteams [searchterm]"
description = "Displays paginated list of all teams whose names contain `searchterm`"
description = "Shows a paginated list of all teams whose names contain the given search term."
async def execute(self, msg, command):
search_term = command.strip()
@ -242,7 +242,7 @@ class CreditCommand(Command):
class HelpCommand(Command):
name = "help"
template = "m;help [command]"
description = "Displays a list of all commands, or the description of the given command if one is present."
description = "Shows the instructions from the readme for a given command. If no command is provided, we will instead provide a list of all of the commands that instructions can be provided for."
async def execute(self, msg, command):
query = command.strip()
@ -262,7 +262,7 @@ class HelpCommand(Command):
class DeleteTeamCommand(Command):
name = "deleteteam"
template = "m;deleteteam [name]"
description = "Deletes a team. Only works if you're the one who made it in the first place, and yes, we do check."
description = "Allows you to delete the team with the provided name if you are the owner of it, Gives a confirmation first to prevent accidental deletions. If it isn't letting you delete your team, you probably created it before teams having owners was a thing, contact xvi and xie can assign you as the owner."
async def execute(self, msg, command):
team_name = command.strip()