diff --git a/README.md b/README.md index 6e5ff86..c04dbac 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # 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 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 +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'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. @@ -16,38 +16,38 @@ accepting pull requests, check the issues for to-dos. #### 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 each of these in a new line: - - your team's name (cannot contain emoji). - - your team's icon and slogan, this should begin with an emoji followed by a space, followed by a short slogan. - - your 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. + - 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: + - the team's name (cannot contain emoji). + - the team's icon and slogan, generally this is an emoji followed by a space, followed by a short slogan. - a blank line. - - your 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 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. + - 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 it correctly, you'll get a team embed with a prompt to confirm. hit the 👍 and it'll be saved. - 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. requires team ownership. + - allows you to delete the team with the provided name. requires team ownership. gives a confirmation first to prevent accidental deletions. - m;import - imports an onomancer collection as a new team. you can use the new onomancer simsim setting to ensure compatibility. -#### editing: --m;addplayer batter/pitcher [team name] [player name] - - adds a new player to your team, either in the lineup or rotation. requires team ownership. use addplayer batter of addplayer pitcher, depending on where you want them added to, at the top of a list with each of these in a new line: +#### 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 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: -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;move [team name] [player name] [new lineup/rotation position number] - - changes the position of a player in the lineup and rotation. requires team ownership. use this command at the top of a list with each of these in a new line: +- 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: - 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. - [ASK WHAT THIS DOES TO THE REST OF THE TEAM, PUSHES THEM DOWN?] - m;swapsection [team name] [player name] - - swaps a player from the lineup to rotation or rotation to lineup. requires team ownership. use this command at the top of a list followed by each of these in a new line: + - 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: - the name of the team you want to swap the player on. - the name of the player you want to swap. - [ASK XVI ABOUT WHERE THEY GO SPECIFICALLY, POTENTIALLY EDIT CODE DESCRIPTION WITH ANSWER TOO] - m;removeplayer [team name] [player name] - [POINT OUT INCONSISTENT NAME IN CODE AND ALSO MAKE SURE THIS WORKS CORRECTLY WITH MULTIPLE INSTANCES OF THE SAME PLAYER AND MAKE SURE IT CHECKS IF THEY'RE THE LAST PLAYER] + - 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: - 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: - m;showteam [name] - shows information about any saved team. @@ -66,10 +66,10 @@ accepting pull requests, check the issues for to-dos. ### 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: + - 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: - 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. ### other commands: - m;help [command]