Update README.md
This commit is contained in:
Genderdruid
parent
eb449ac05a
commit
9edf746ca2
89
README.md
89
README.md
|
|
@ -1,7 +1,7 @@
|
|||
# matteo-the-prestige
|
||||
# sim16 + discord bot: baseball simulation
|
||||
|
||||
Sim16 is a discord and website based online baseball simulator, every name has randomly generated stats which you can use to make custom teams and custom leagues, all created and set up in discord and watchable at http://sim16.Genderdruid.space!
|
||||
Sim16 is a discord and website based online baseball simulator, every name has randomly generated stats which you can use to make custom teams and custom leagues, all created and set up in discord and watchable at http://sim16.Sakimori.space!
|
||||
|
||||
If you would like to add matteo to your server to be able to set up teams and games, you can do so with this link: https://discord.com/api/oauth2/authorize?client_id=789956166796574740&permissions=388160&scope=bot
|
||||
|
||||
|
|
@ -13,32 +13,32 @@ Accepting pull requests, check the issues for to-dos, if you have an idea for an
|
|||
|
||||
|
||||
# Table of Contents
|
||||
* [FAQ](https://github.com/Genderdruid/matteo-the-prestige#faq-this-faq-is-a-work-in-progress-and-will-be-expanded-over-time)
|
||||
* [Commands](https://github.com/Genderdruid/matteo-the-prestige#commands-everything-here-is-case-sensitive-and-can-be-prefixed-with-either-m-or-m)
|
||||
- [Team Commands](https://github.com/Genderdruid/matteo-the-prestige#team-commands)
|
||||
- [Creation and deletion](https://github.com/Genderdruid/matteo-the-prestige#creation-and-deletion)
|
||||
- [Editing](https://github.com/Genderdruid/matteo-the-prestige#editing-all-of-these-commands-require-ownership-and-exact-spelling-of-the-team-name)
|
||||
- [Viewing and Searching](https://github.com/Genderdruid/matteo-the-prestige#viewing-and-searching)
|
||||
- [Game Commands](https://github.com/Genderdruid/matteo-the-prestige#game-commands)
|
||||
- [Individual Game Commands](https://github.com/Genderdruid/matteo-the-prestige#individual-game-commands)
|
||||
- [Tournament Commands](https://github.com/Genderdruid/matteo-the-prestige#obl-commands)
|
||||
- [OBL Commands](https://github.com/Genderdruid/matteo-the-prestige#obl-commands)
|
||||
- [League Commands](https://github.com/Genderdruid/matteo-the-prestige#league-commands)
|
||||
- [Draft Commands](https://github.com/Genderdruid/matteo-the-prestige#draft-commands)
|
||||
- [Player Commands](https://github.com/Genderdruid/matteo-the-prestige#player-commands)
|
||||
- [Other Commands](https://github.com/Genderdruid/matteo-the-prestige#other-commands)
|
||||
* [Weathers](https://github.com/Genderdruid/matteo-the-prestige#weathers)
|
||||
* [Patreon](https://github.com/Genderdruid/matteo-the-prestige#patreon)
|
||||
* [Attribution](https://github.com/Genderdruid/matteo-the-prestige#attribution)
|
||||
* [FAQ](https://github.com/Sakimori/matteo-the-prestige#faq-this-faq-is-a-work-in-progress-and-will-be-expanded-over-time)
|
||||
* [Commands](https://github.com/Sakimori/matteo-the-prestige#commands-everything-here-is-case-sensitive-and-can-be-prefixed-with-either-m-or-m)
|
||||
- [Team Commands](https://github.com/Sakimori/matteo-the-prestige#team-commands)
|
||||
- [Creation and deletion](https://github.com/Sakimori/matteo-the-prestige#creation-and-deletion)
|
||||
- [Editing](https://github.com/Sakimori/matteo-the-prestige#editing-all-of-these-commands-require-ownership-and-exact-spelling-of-the-team-name)
|
||||
- [Viewing and Searching](https://github.com/Sakimori/matteo-the-prestige#viewing-and-searching)
|
||||
- [Game Commands](https://github.com/Sakimori/matteo-the-prestige#game-commands)
|
||||
- [Individual Game Commands](https://github.com/Sakimori/matteo-the-prestige#individual-game-commands)
|
||||
- [Tournament Commands](https://github.com/Sakimori/matteo-the-prestige#obl-commands)
|
||||
- [OBL Commands](https://github.com/Sakimori/matteo-the-prestige#obl-commands)
|
||||
- [Draft Commands](https://github.com/Sakimori/matteo-the-prestige#draft-commands)
|
||||
- [League Commands](https://github.com/Sakimori/matteo-the-prestige#league-commands)
|
||||
- [Player Commands](https://github.com/Sakimori/matteo-the-prestige#player-commands)
|
||||
- [Other Commands](https://github.com/Sakimori/matteo-the-prestige#other-commands)
|
||||
* [Weathers](https://github.com/Sakimori/matteo-the-prestige#weathers)
|
||||
* [Patreon](https://github.com/Sakimori/matteo-the-prestige#patreon)
|
||||
* [Attribution](https://github.com/Sakimori/matteo-the-prestige#attribution)
|
||||
|
||||
## FAQ:
|
||||
- Q: I'm trying to make a league on the website but when I click the 'submit' button it doesn't do anything and doesn't give an error message.
|
||||
- Q: I'm trying to make a league on the website but when I click the 'submit' button it doesn't do anything and doesn't give an error message.
|
||||
A: This is a known issue, to avoid it make sure you have an even number of divisions and subleagues and an equal number of teams in each division. These are all requirements for a league and sometimes if some of them aren't met the submit button will fail silently. If you're still having this issue after doing all of this correctly please submit a bug report via the form.
|
||||
|
||||
- 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.
|
||||
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: Why aren't all the teams playing on every day of my league/why do teams have an uneven amount of games played in my league?
|
||||
- Q: Why aren't all the teams playing on every day of my league/why do teams have an uneven amount of games played in my league?
|
||||
A: Scheduling algorithms are hard and due to how this one was coded, sometimes teams have bye weeks and rest for some games the season, this should all even out by the end of the season and each team will play the same number of games.
|
||||
|
||||
- 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?
|
||||
|
|
@ -94,7 +94,7 @@ Accepting pull requests, check the issues for to-dos, if you have an idea for an
|
|||
- m;showallteams
|
||||
- Shows a paginated list of all teams available for games which can be scrolled through.
|
||||
|
||||
[Return to the top](https://github.com/Genderdruid/matteo-the-prestige#matteo-the-prestige)
|
||||
[Return to the top](https://github.com/Sakimori/matteo-the-prestige#matteo-the-prestige)
|
||||
|
||||
### Game Commands:
|
||||
#### Individual Game Commands:
|
||||
|
|
@ -110,10 +110,11 @@ Accepting pull requests, check the issues for to-dos, if you have an idea for an
|
|||
- m;randomgame
|
||||
- Starts a 9-inning game between 2 entirely random teams. Embrace chaos!
|
||||
#### Tournament Commands:
|
||||
- m;starttournament --rounddelay #, --bestof #, --finalsbestof #
|
||||
- Starts a randomly seeded tournament with the provided teams, automatically adding byes as necessary. All series have a 5 minute break between games. The current default format is best of 5 until the finals which are best of 7 but this can be adjusted by adding the bestof and finalsbestof flags.
|
||||
- m;starttournament --rounddelay #, --bestof #, --finalsbestof #, --seeding
|
||||
- Starts a randomly seeded tournament with the provided teams, automatically adding byes as necessary. All series have a 5 minute break between games. The current default format is teams seeded randomly best of 5 until the finals which are best of 7 but this can be adjusted by adding the bestof and finalsbestof flags.
|
||||
- The --rounddelay is optional, if used, # must be between 1 and 120 and it'll set the delay between rounds to be # minutes. If not included it will default to 10.
|
||||
- Use this command at the top of a list with entries separated by new lines:
|
||||
- The --seeding flag changes the seeding of the tournament, currently there is only one option '--seeding stars' which seeds the teams based on average primary attribute stars instead of randomly. This is currently the only option but more may be added in the future.
|
||||
Use this command at the top of a list with entries separated by new lines:
|
||||
- The name of the tournament.
|
||||
- The name of each participating team on its own line.
|
||||
#### OBL Commands:
|
||||
|
|
@ -127,6 +128,18 @@ Accepting pull requests, check the issues for to-dos, if you have an idea for an
|
|||
- Displays a trophy case with all teams that the given team has won points from.
|
||||
- m;oblstandings
|
||||
- Displays the 15 teams with the most OBL points in this meta-season.
|
||||
#### Draft Commands
|
||||
- m;startdraft
|
||||
- Starts a draft with an arbitrary number of participants. Use this command at the top of a list with entries separated by new lines:
|
||||
- For each participant's entry you need three lines:
|
||||
- Their discord @
|
||||
- Their team name
|
||||
- Their team slogan
|
||||
- Post this with all three of these things for all participants and the draft will begin.
|
||||
- The draft will begin once all participants have given a 👍 and will proceed in the order that participants were entered. Each participant will select 12 hitters and 1 pitcher from a pool of 20 random players which will refresh automatically when it becomes small.
|
||||
- m;draft [name]
|
||||
- Use this on your turn during a draft to pick your player.
|
||||
- You can also just use a 'd' instead of the full command.
|
||||
#### 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):
|
||||
|
|
@ -156,22 +169,10 @@ Accepting pull requests, check the issues for to-dos, if you have an idea for an
|
|||
- 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).
|
||||
#### Draft Commands
|
||||
- m;startdraft
|
||||
- Starts a draft with an arbitrary number of participants. Use this command at the top of a list with entries separated by new lines:
|
||||
- For each participant's entry you need three lines:
|
||||
- Their discord @
|
||||
- Their team name
|
||||
- Their team slogan
|
||||
- Post this with all three of these things for all participants and the draft will begin.
|
||||
- The draft will begin once all participants have given a 👍 and will proceed in the order that participants were entered. Each participant will select 12 hitters and 1 pitcher from a pool of 20 random players which will refresh automatically when it becomes small.
|
||||
- m;draft [name]
|
||||
- Use this on your turn during a draft to pick your player.
|
||||
- You can also just use a 'd' instead of the full command.
|
||||
- for batters: avg (batting average), slg (slugging percentage), obp (on-base percentage), ops (on-base plus slugging), home runs, walks drawn.
|
||||
- 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), eramin (players with the worst earned run average).
|
||||
|
||||
[Return to the top](https://github.com/Genderdruid/matteo-the-prestige#matteo-the-prestige)
|
||||
[Return to the top](https://github.com/Sakimori/matteo-the-prestige#matteo-the-prestige)
|
||||
|
||||
### Player Commands:
|
||||
- m;showplayer [name]
|
||||
|
|
@ -181,7 +182,7 @@ Accepting pull requests, check the issues for to-dos, if you have an idea for an
|
|||
- m;showidol
|
||||
- Displays your idol's name and stars in a discord embed.
|
||||
|
||||
[Return to the top](https://github.com/Genderdruid/matteo-the-prestige#matteo-the-prestige)
|
||||
[Return to the top](https://github.com/Sakimori/matteo-the-prestige#matteo-the-prestige)
|
||||
|
||||
### Other Commands:
|
||||
- m;help [command]
|
||||
|
|
@ -191,7 +192,7 @@ Accepting pull requests, check the issues for to-dos, if you have an idea for an
|
|||
- m;roman [number]
|
||||
- Converts any natural number less than 4,000,000 into roman numerals, this one is just for fun.
|
||||
|
||||
[Return to the top](https://github.com/Genderdruid/matteo-the-prestige#matteo-the-prestige)
|
||||
[Return to the top](https://github.com/Sakimori/matteo-the-prestige#matteo-the-prestige)
|
||||
|
||||
## Weathers
|
||||
- All current simsim weathers are listed here with a short description of their effects except for the most recent weathers whose effects remain a mystery.
|
||||
|
|
@ -210,7 +211,7 @@ Accepting pull requests, check the issues for to-dos, if you have an idea for an
|
|||
- Tornado 🌪: Current patch weather, its effects will be revealed when new weathers are added.
|
||||
- Torrential Downpour ⛈: Current patch weather, its effects will be revealed when new weathers are added.
|
||||
|
||||
[Return to the top](https://github.com/Genderdruid/matteo-the-prestige#matteo-the-prestige)
|
||||
[Return to the top](https://github.com/Sakimori/matteo-the-prestige#matteo-the-prestige)
|
||||
|
||||
## Patreon!
|
||||
|
||||
|
|
@ -230,4 +231,4 @@ these folks are helping me a *ton* via patreon, and i cannot possibly thank them
|
|||
|
||||
Twemoji is copyright 2020 Twitter, Inc and other contributors; code licensed under [the MIT License](http://opensource.org/licenses/MIT), graphics licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)
|
||||
|
||||
[Return to the top](https://github.com/Genderdruid/matteo-the-prestige#matteo-the-prestige)
|
||||
[Return to the top](https://github.com/Sakimori/matteo-the-prestige#matteo-the-prestige)
|
||||
|
|
|
|||
Loading…
Reference in a new issue