Merge pull request #116 from Genderdruid/master
Updated the readme with all the features of the new patch and cleaned up some other parts
This commit is contained in:
commit
3899041536
77
README.md
77
README.md
|
@ -1,35 +1,59 @@
|
|||
# matteo-the-prestige
|
||||
# simsim discord bot
|
||||
|
||||
blaseball, blaseball, is back! in an unofficial capacity. this is completely unaffiliated with the game band
|
||||
blaseball, blaseball, is back! in an unofficial capacity. this project is completely unaffiliated with the game band.
|
||||
|
||||
custom players, custom teams, custom leagues (that last one is coming soon™) all set up in discord and watchable at https://simsim.sibr.dev
|
||||
we have custom players (generated by onomancer), custom teams, custom leagues (that last one is coming soon™), all set up in discord and watchable at https://simsim.sibr.dev!
|
||||
|
||||
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.
|
||||
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
|
||||
|
||||
accepting pull requests, check the issues for to-dos.
|
||||
|
||||
|
||||
## commands: (everything here is case sensitive, and can be prefixed with either m; or m!)
|
||||
|
||||
### team commands:
|
||||
|
||||
#### creation and deletion:
|
||||
- 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 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.
|
||||
- saves a team to the database allowing it to be used for games. use this command at the top of a list with each of these in a new line after:
|
||||
- the team's name.
|
||||
- the team's icon and slogan, generally this is an emoji followed by a space, followed by a short slogan.
|
||||
- a blank line.
|
||||
- the batters' names in the order you want them to appear in your lineup, each on its own line. lineups can contain any number of batters between 1 and 12.
|
||||
- a blank line.
|
||||
- the pitchers' names in the order you want them to appear in your rotation. rotations can contain any number of pitchers between 1 and 8.
|
||||
- if you did everything 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)
|
||||
- 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 of the team used):
|
||||
- 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 each of these in a new line after:
|
||||
-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]
|
||||
- changes the position of 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 each of these in a new line after:
|
||||
- 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]
|
||||
- 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 followed by each of these in a new line after:
|
||||
- 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]
|
||||
- removes a player from your lineup or rotation. 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 each of these in a new line after:
|
||||
- the name of the team you want to remove the player from.
|
||||
- the name of the player you want to remove.
|
||||
|
||||
#### viewing and searching:
|
||||
- m;showteam [name]
|
||||
- shows information about any saved team.
|
||||
- m;showallteams
|
||||
- shows a paginated list of all teams available for games which can be scrolled through.
|
||||
- shows the lineup, rotation, and slogan of any saved team in a discord embed with primary stat star ratings for all of the players. this command has fuzzy search so you don't need to type the full name of the team as long as you give enough to identify the team you're looking for.
|
||||
- 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 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.
|
||||
- m;import
|
||||
- imports an onomancer collection as a new team. you can use the new onomancer simsim setting to ensure compatibility.
|
||||
- m;showallteams
|
||||
- shows a paginated list of all teams available for games which can be scrolled through.
|
||||
|
||||
### player commands:
|
||||
- m;showplayer [name]
|
||||
|
@ -40,15 +64,26 @@ accepting pull requests, check the issues for to-dos.
|
|||
- displays your idol's name and stars.
|
||||
|
||||
### game commands:
|
||||
- m;startgame
|
||||
- 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:
|
||||
- m;startgame --day # or -d #
|
||||
- starts a game with premade teams made using saveteam. provides a link to the website where you can watch the game.
|
||||
- the --day/-d is optional, if used it'll force the game to use the #th spot in each team's rotations. if this number is larger than the number of pitchers in one or both of the teams' rotations it'll wrap around. if it is not used pitchers will be chosen randomly from the teams' rotations.
|
||||
- use this command at the top of a list with each of these in a new line after:
|
||||
- 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.
|
||||
- optionally, the number of innings, which must be greater than 2 and less than 31. if not included it will default to 9.
|
||||
- this command has fuzzy search so you don't need to type the full name of the team as long as you give enough to identify the team you're looking for.
|
||||
- m;randomgame
|
||||
- starts a 9-inning game between 2 entirely random teams. embrace chaos!
|
||||
- m;starttournament --rounddelay #
|
||||
- starts a randomly seeded tournament with up to 64 provided teams, automatically adding byes as nescesary. all rounds are best of 5 until the finals which is best of 7. all series have a 5 minute break between games.
|
||||
- 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 each of these in a new line after:
|
||||
- the name of the tournament.
|
||||
- the name of each participating team on its own line.
|
||||
|
||||
### other commands:
|
||||
- m;help [command]
|
||||
- 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.
|
||||
- shows instructions for a 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]
|
||||
|
|
Loading…
Reference in New Issue
Block a user