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

Update README.md

Browse Source
This commit is contained in:
Genderdruid 2021-01-03 14:28:11 -08:00
parent cb167e2464
commit 56b5d9f45f
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,60 +1,59 @@
# matteo-the-prestige # matteo-the-prestige
# simsim discord bot # 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, all powered by this bot and onomancer. 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!
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 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. accepting pull requests, check the issues for to-dos.
## commands: (everything here is case sensitive, and can be prefixed with either m; or m!) ## commands: (everything here is case sensitive, and can be prefixed with either m; or m!)
### team commands: ### team commands:
#### creation and deletion: #### creation and deletion:
- m;saveteam - m;saveteam
- 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: - 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 (cannot contain emoji). - the team's name.
- the team's icon and slogan, generally this is an emoji followed by a space, followed by a short slogan. - the team's icon and slogan, generally this is an emoji followed by a space, followed by a short slogan.
- a blank line. - a blank line.
- the batters' names in the order you want them to appear in your lineup, each in its own line. lineups can contain any number of batters between 1 and 12. - 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. - 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. - 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 it correctly, you'll get a team embed with a prompt to confirm. hit the 👍 and it'll be saved. - 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] - m;deleteteam [teamname] (requires team ownership)
- allows you to delete the team with the provided name. requires team ownership. gives a confirmation first to prevent accidental deletions. - 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 - m;import
- imports an onomancer collection as a new team. you can use the new onomancer simsim setting to ensure compatibility. - 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): #### editing (all of these commands require ownership of the team used):
- m;addplayer batter/pitcher [team name] [player name] - m;addplayer batter/pitcher [team name] [player name]
- adds a new player to the end of your team, either in the lineup or 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: - 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 team you want to add the player to.
-the name of the player you want to add to the team. -the name of the player you want to add to the team.
- m;moveplayer [team name] [player name] [new lineup/rotation position number] - m;moveplayer [team name] [player name] [new lineup/rotation position number]
- changes the position of a player in the lineup and rotation. use this command at the top of a list with each of these in a new line: - 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 team you want to move the player on.
- the name of the player you want to move. - 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. - 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 the lineup to rotation or rotation to lineup. use this command at the top of a list followed by each of these in a new line: - 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 team you want to swap the player on.
- the name of the player you want to swap. - 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 lineup or rotation. if there are multiple copies of the same player on a team this will delete the first one. use this command at the top of a list with each of these in a new line: - 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 team you want to remove the player from.
- the name of the player you want to remove. - the name of the player you want to remove.
#### viewing and searching: #### viewing and searching:
- m;showteam [name] - m;showteam [name]
- shows information about any saved team. - 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;showallteams
- shows a paginated list of all teams available for games which can be scrolled through.
- m;searchteams [searchterm] - m;searchteams [searchterm]
- shows a paginated list of all teams whose names contain the given search term. - shows a paginated list of all teams whose names contain the given search term.
- m;showallteams
- shows a paginated list of all teams available for games which can be scrolled through.
### player commands: ### player commands:
- m;showplayer [name] - m;showplayer [name]
@ -66,14 +65,15 @@ accepting pull requests, check the issues for to-dos.
### game commands: ### game commands:
- m;startgame - 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: - starts a game with premade teams made using saveteam. provide's a link to the website where you can watch the game. use this command at the top of a list with each of these in a new line after:
- the away team's name. - the away team's name.
- the home team's name. - the home team's name.
- 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.
### other commands: ### other commands:
- m;help [command] - 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 - m;credit
- shows artist credit for matteo's avatar. - shows artist credit for matteo's avatar.
- m;roman [number] - m;roman [number]