From 4338e7cd7e1d152f6d1ca0463930ca08f65300f2 Mon Sep 17 00:00:00 2001 From: Genderdruid Date: Sun, 27 Dec 2020 12:38:46 -0800 Subject: [PATCH] updated README.md added better organization and rewrote many of the command descriptions for formatting consistency and clarity --- README.md | 75 ++++++++++++++++++++++++++----------------------------- 1 file changed, 36 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 8456fe9..ffb46ea 100644 --- a/README.md +++ b/README.md @@ -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! - - 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 + ## commands: (literally everything here is case sensitive, and can be prefixed with either m; or m!) -- m;idolize [name] - - records any name as your idol, used elsewhere. there's a limit of 70 characters. that should be *plenty*. - -- m;showidol - - displays your idol's name and stars in a nice discord embed. - -- m;showplayer [name] - - displays any name's stars in a similar embed. - -- 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;saveteam - - 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. +- 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 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, 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 + - the final line is 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] + - shows information about any saved team + - m;showallteams + - shows a paginated list of all teams available for games + - m;searchteams [searchterm] + - displays paginated list of all teams whose names contain the given string -- m;showteam [name] - - you can view any saved team with this command +- player commands: + - 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 - - this displays a paginated list of all teams available for `startgame` - -- m;searchteams [searchterm] - - displays paginated list of all teams whose names contain `searchterm` +- game commands: + - m;startgame + - starts a game with premade teams, use this command at the top of a list followed by, each in a new line: + - 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 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 - - to start a game with premade teams, use this command at the top of a list as above - - the first line is the away team's name - - the second is the home team's name - - the third is the number of innings, which must be greater than 2. - -- 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. +- other commands: + - 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