Update README.md

This commit is contained in:
Genderdruid 2021-01-02 21:47:38 -08:00
parent cda703bfae
commit ccac199304

View File

@ -13,23 +13,48 @@ 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:
- m;saveteam - 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). - 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:
- the first line of the list is your team's name (cannot contain emoji). - 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. - 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. - 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.
- the final line is your pitcher's name. - 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.
- 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 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.
- 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:
-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:
- 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:
- 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]
- 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] - m;showteam [name]
- shows information about any saved team. - shows information about any saved team.
- m;showallteams - m;showallteams
- shows a paginated list of all teams available for games which can be scrolled through. - 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;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.
### player commands: ### player commands:
- m;showplayer [name] - m;showplayer [name]