zhetadelta/sim16
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

updated the readme and wordings in the_prestige

Browse source 
added all of the new commands to the readme, added an FAQ, and updated wording of a few things in a few places.
This commit is contained in:
Genderdruid 2021-02-04 08:08:38 -08:00
parent 2a19e47b5f
commit b5ae156120
2 changed files with 45 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -9,6 +9,16 @@ if you would like to add matteo to your server to be able to set up teams and ga
accepting pull requests, check the issues for to-dos.
## FAQ (this FAQ is a work in progress and will be expanded over time):
- Q: Why have the teams in my league played an uneven amount of games/why are some teams not scheduled for games for some weeks?
- A: Scheduling algorithms are really hard and the way xvi chose to do it involves some teams having byes for some series of the season, it'll even out by the end so every team plays the same amount of games.
- Q: My league stopped playing randomly and I don't know why, what should I do?
- A: There were probably server issues or a patch went out, use the startleague command again and things should resume from where they left off.
- Q: What should I do if my question isn't answered by this FAQ, this readme, or the help text for the commands, or I find a bug?
- A: Please submit your issue or bug to this form and Artemis will pass it along if it's something we can do anything about. https://forms.gle/PjbpfT46yuMDGca46
## commands: (everything here is case sensitive, and can be prefixed with either m; or m!)
### team commands:
@ -19,28 +29,35 @@ accepting pull requests, check the issues for to-dos.
- the second line is the team's icon and slogan, generally this is an emoji followed by a space, followed by a short slogan.
- the third line must be blank.
- 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.
- then another blank line seperating your batters and your pitchers.
- then another blank line separating your batters and your pitchers.
- the final lines are the names of the pitchers in your rotation, rotations can contain any number of pitchers between 1 and 8.
- if you did it correctly, you'll get a team embed with a prompt to confirm. hit the 👍 and your team will be saved!
- m;deleteteam [teamname] \(requires team ownership)
- m;deleteteam [teamname] (requires team ownership)
- allows you to delete the team with the provided name. you'll get an embed with a confirmation to prevent accidental deletions. hit the 👍 and your team will be deleted.
- m;import
- imports an onomancer collection as a new team. you can use the new onomancer simsim setting to ensure compatibility. similarly to saveteam, you'll get a team embed with a prompt to confirm, hit the 👍 and your team will be saved!
#### editing (all of these commands require ownership and exact spelling of the team name):
- m;addplayer batter/pitcher [team name] \[player name]
- m;replaceplayer [team name] [player to remove] [player to add]
- replaces a player on your team with a new player. if there are multiple copies of the same player on a team this will only replace the first one. use this command at the top of a list with entries separated by new lines:
- the name of the team you want to replace the player on.
- the name of the player you want to remove from the team.
- the name of the player you want to replace them with.
- m;addplayer batter/pitcher [team name] [player name]
- adds a new player to the end of your team, either in the lineup or the rotation depending on which version you use. use addplayer batter or addplayer pitcher at the top of a list with entries separated by new lines:
- the name of the team you want to add the player to.
- the name of the player you want to add to the team.
- m;moveplayer [team name] \[player name] [new lineup/rotation position number]
- moves a player within your lineup or rotation. if you want to instead move a player from your rotation to your lineup or vice versa, use m;swapsection instead. use this command at the top of a list with entries separated by new lines:
- m;moveplayer (batter/pitcher) [team name] [player name] [new lineup/rotation position number]
- moves a player within your lineup or rotation. if you want to instead move a player from your rotation to your lineup or vice versa, use m;swapsection instead.
- you can optionally specify batter or pitcher if you have a player in both your rotation and lineup and you want to move a specific one. you don't need to include it if you only have one copy of the player on your team.
- use this command at the top of a list with entries separated by new lines:
- the name of the team you want to move the player on.
- the name of the player you want to move.
- the position you want to move them too, indexed with 1 being the first position of the lineup or rotation. all players below the specified position in the lineup or rotation will be pushed down.
- m;swapsection [team name] \[player name]
- m;swapsection [team name] [player name]
- swaps a player from your lineup to the end of your rotation or your rotation to the end of your lineup. use this command at the top of a list with entries separated by new lines:
- the name of the team you want to swap the player on.
- the name of the player you want to swap.
- m;removeplayer [team name] \[player name]
- m;removeplayer [team name] [player name]
- removes a player from your team. if there are multiple copies of the same player on a team this will only delete the first one. use this command at the top of a list with entries separated by new lines:
- the name of the team you want to remove the player from.
- the name of the player you want to remove.
@ -86,26 +103,34 @@ accepting pull requests, check the issues for to-dos.
### league commands
- all of these commands are for leagues that have already been started. to start a league, click the 'create a league' button on the website and fill out the info for your league there, then use the m;claimleague command in discord to set yourself as the owner.
- commissioner commands (all of these except for m;claimleague require ownership of the specified league):
- m;claimleague [leaguename]
- m;claimleague [league name]
- sets yourself as the owner of an unclaimed league created on the website. make sure to do this as soon as possible since if someone does this before you, you will not have access to the league.
- m;addleagueowner [leaguename]
- m;addleagueowner [league name]
- use this command at the top of a list of @mentions, with entries separated by new lines, of people you want to have owner powers in your league.
- m;startleague [leaguename] --queue #/-q # --noautopostseason
- m;startleague [league name] --queue #/-q # --noautopostseason
- send this command with the number of games per hour you want on the next line, minimum 1 (one game every hour), maximum 12 (one game every 5 minutes, uses spillover rules).
- starts the playing of league games at the pace specified, by default will play the entire season and the postseason unless an owner pauses the league with the m;pauseleague command.
- if you use the --queue #/-q # flag, the league will only play # series' at a time before automatically pausing until you use this command again.
- if you use the --queue #/-q # flag, the league will only play # series' at a time before automatically pausing until you use this command again, by default it will play the entire season unless stopped.
- if you use the --noautopostseason flag, instead of starting automatically, the league will pause at the end of the regular season and not start the postseason until you use this command again.
- m;pauseleague [leaguename]
- m;pauseleague [league name]
- pauses the specified league after the current series finishes until the league is started again with m;startleague.
- m;leagueseasonreset [league name]
- completely scraps the given league's current season, resetting everything to day 1 of the current season. make sure to use m;startleague again to restart the season afterwards.
- general commands (all of these can be used by anyone):
- m;leaguestandings [leaguename] --season #/-s #
- m;leaguestandings [league name] --season #/-s #
- displays the current standings for the specified league.
- by default this will display the standings for the current season but if the --season #/-s # flag is set it will instead display the standings for the #th season instead for viewing historical standings.
- m;leaguewildcard [leaguename]
- m;leaguewildcard [league name]
- displays the wild card standings for the specified league. if the league doesn't have wild cards, it will instead tell you that.
- m;leagueschedule [leaguename]
- m;leagueschedule [league name]
- displays the upcoming schedule for the specified league. shows the current series and the next three series after that for every team.
- m;teamchedule [league name] [team name]
- displays the upcoming schedule for the specified team within the specified league. shows the current series and the next six series after that for the given team.
- m;leagueleaders [league name] [stat]
- displays a league's leaders in the given stat.
- the currently available starts are:
- for batters: avg (batting average), slg (slugging percentage), obp (on-base percentage), ops (on-base plus slugging).
- for pitchers era (earned run average), whip (walks and hits per innings pitched), kper9 (strikeouts per 9 innings), bbper9 (walks per 9 innings), kperbb (strikeout to walk ratio).
### 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

7
the_prestige.py
View file

@ -787,7 +787,8 @@ class StartLeagueCommand(Command):
name = "startleague"
template = "m;startleague [league name]\n[games per hour]"
description = """Optional flags for the first line: `--queue X` or `-q X` to play X number of series before stopping; `--noautopostseason` will pause the league before starting postseason.
Plays a league with a given name, provided that league has been saved on the website. The games per hour sets how often the games will start. (e.g. GPH 2 will start games at X:00 and X:30)"""
Starts games from a league with a given name, provided that league has been saved on the website and has been claimed using claimleague. The games per hour sets how often the games will start (e.g. GPH 2 will start games at X:00 and X:30). By default it will play the entire season followed by the postseason and then stop but this can be customized using the flags.
Not every team will play every series, due to how the scheduling algorithm is coded but it will all even out by the end."""
async def execute(self, msg, command):
if config()["game_freeze"]:
@ -883,7 +884,7 @@ class LeagueDisplayCommand(Command):
class LeagueLeadersCommand(Command):
name = "leagueleaders"
template = "m;leagueleaders [league name]\n[stat name/abbreviation]"
description = "Displays a league's leaders in the given stats. A list of the allowed stats can be found on the github readme."
description = "Displays a league's leaders in the given stat. A list of the allowed stats can be found on the github readme."
async def execute(self, msg, command):
if league_exists(command.split("\n")[0].strip()):
@ -952,7 +953,7 @@ class LeagueWildcardCommand(Command):
class LeaguePauseCommand(Command):
name = "pauseleague"
template = "m;pauseleague [league name]"
description = "Tells a currently running league to stop running automatically after the current series."
description = "Tells a currently running league to stop running after the current series."
async def execute(self, msg, command):
league_name = command.strip()