Skip to content

Commit

Permalink
[Docs] Add bot usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Pythonic-Rainbow committed Sep 11, 2024
1 parent d2d600b commit bc329a7
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
For bot usage please see [here](docs/bot_usage_EN.md)
---

## [👉Please join our Discord 请加入我们的Discord](https://discord.gg/N5P2uJD)

## 👇Clan War Standard 部落战标准规定
Expand Down
23 changes: 23 additions & 0 deletions docs/bot_usage_EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Terminology
* Person: An actual person. A person can have multiple accounts.
* Account: A single account in the game, identified by the tag e.g. #2QLGU8XY. An account may not be in the clan.
* Member: An account that is in the clan.

* Alias: Shorthand for specifying an account. An account can have multiple aliases, but an alias can only belong to one account. Aliases are case-insensitive.
* Main: The main account of a Person. A person will have exactly 1 Main.
* Alt: An alternative account of a Person. A person can have multiple alts.

```mermaid
classDiagram
Person "1" --> "1" Main
Person "1" --> "*" Alt
Account "1" --> "*" Alias
Account <|-- Main
Account <|-- Alt
class Account {
is in clan: "Member"
}
```

0 comments on commit bc329a7

Please sign in to comment.