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

updated README.md

Browse Source 
added better organization and rewrote many of the command descriptions for formatting consistency and clarity
This commit is contained in:
Genderdruid 2020-12-27 12:38:46 -08:00
parent 8348521f12
commit 4338e7cd7e
1 changed files with 36 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -5,51 +5,48 @@ blaseball, blaseball, is back! in an unofficial capacity.
custom players, custom teams, custom leagues (that last one is coming soon™) all in discord! custom players, custom teams, custom leagues (that last one is coming soon™) all in discord!
we've also got things like player idolization, easy setup for quick pick-up games featuring any players you like (including those not on a team), and onomancer lookup we've also got things like player idolization, easy setup for quick pick-up games featuring any players you like (including those not on a team), and onomancer lookup
accepting pull requests, check the issues for to-dos accepting pull requests, check the issues for to-dos
## commands: (literally everything here is case sensitive, and can be prefixed with either m; or m!) ## commands: (literally everything here is case sensitive, and can be prefixed with either m; or m!)
- m;idolize [name] - team commands:
- records any name as your idol, used elsewhere. there's a limit of 70 characters. that should be *plenty*. - 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 lines seperated by newlines (shift+enter in discord, or copy+paste from notepad)
- m;showidol - the first line of the list is your team's name (cannot contain emoji)
- displays your idol's name and stars in a nice discord embed. - the second is your team's slogan, this should begin with an emoji followed by a space
- the next lines are your batters' names in the order you want them to appear in your lineup, minimum batters: 1, maximum batters: 12
- m;showplayer [name] - the final line is your pitcher
- displays any name's stars in a similar embed. - if you did it correctly, you'll get a team embed with a prompt to confirm. hit the 👍 and it'll be saved
- m;showteam [name]
- m;setupgame - shows information about any saved team
- begins setting up a 3-inning pickup game. pitchers, lineups, and team names are given during the setup process by anyone able to type in that channel. idols are easily signed up via emoji during the process. the game will start automatically after setup. - m;showallteams
- shows a paginated list of all teams available for games
- m;saveteam - m;searchteams [searchterm]
- 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) - displays paginated list of all teams whose names contain the given string
- 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.
- m;showteam [name] - player commands:
- you can view any saved team with this command - m;showplayer [name]
- displays any name's stars, there's a limit of 70 characters. that should be *plenty*
- m;idolize [name]
- records any name as your idol, used elsewhere
- m;showidol
- displays your idol's name and stars
- m;showallteams - game commands:
- this displays a paginated list of all teams available for `startgame` - m;startgame
- starts a game with premade teams, use this command at the top of a list followed by, each in a new line:
- m;searchteams [searchterm] - the away team's name
- displays paginated list of all teams whose names contain `searchterm` - 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 this 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 able to type in that channel. idols are easily signed up via emoji during the process. the game will start automatically after setup.
- m;startgame - other commands:
- to start a game with premade teams, use this command at the top of a list as above - m;credit
- the first line is the away team's name - shows artist credit for matteo's avatar
- the second is the home team's name
- the third is the number of innings, which must be greater than 2. - m;roman [number]
- converts any natural number less than 4,000,000 into roman numerals, this one is just for fun
- m;credit
- shows artist credit for matteo's avatar.
- m;roman [number]
- converts any natural number less than 4,000,000 into roman numerals. this one is just for fun.