Closed DanielOhrin closed 1 year ago
/api: allows a user to use their own API key, which will increase the amount of times they can use the bot in a minute.
/server || /status: Displays general information about the server. Is it online? How many players are online?
/stats: shows all available information on a player in one embed. Example: balance, realm points, etc.
Make it known that if you have your own API key stored with the bot, you do not have to specify a player when using commands such as /bal to see your own balance.
/koth: Display all information available about the Koth
running: type: boolean description: Whether the event is running capping_id: type: string format: uuid description: UUID of the player capping optional: true capping_name: type: string description: Name of the player capping optional: true time_until_start: type: integer format: int64 description: Milliseconds until the event starts open: type: boolean description: Whether the event is open cap_time: type: integer format: int64 description: Milliseconds until the event ends cap_time_max: type: integer format: int64 description: Number of milliseconds the player has to cap to win the event examples: response: value: status: running: false time_till_start: 43546331 cap_time: 0 cap_time_max: 900000 open: false
/lms: (Low Priority) display information about LMS event
players: type: object description: Players in the event (uuid to name) next_loot_time: type: integer format: int64 description: Millisecond timestamp of the next loot drop running: type: boolean description: Whether the event is running cap_time: type: integer format: int64 description: Milliseconds the event has been capped last_man: type: string format: uuid description: UUID of the last man standing last_man_name: type: string description: Name of the last man standing examples: response: value: running: true next_loot_time: 0 players: {} cap_time: 0
/bal and /top OR /leaderboard(s):
operationId: economy/balance security:
MONEY
, AP
, DWARF_POINTS
, FISHING_POINTS
, FAIRY_POINTS
'
schema:
type: string
example: MONEYname: account_id in: query description: Economy account ID schema: type: string format: uuid example: a4f368c7-c83c-4f5d-b199-4f7385b066c1 responses: '200': description: OK headers: X-Rate-Limit: description: calls per minute allowed by the user schema: type: integer format: int32 X-Rate-Limit-Remaining: description: calls remaining in the current rate limit window schema: type: integer format: int32 content: application/json: schema: type: object properties: account_id: type: string format: uuid description: Economy account ID leaderboard_position: type: integer description: Economy account leaderboard position balance: type: string description: Economy account balance account_name: type: string description: Economy account name examples: response: value: account_id: a4f368c7-c83c-4f5d-b199-4f7385b066c1 leaderboard_position: 229, balance: '1020146.05' account_name: UltraDev '400': description: Query invalid or too long '401': description: Missing or invalid API key '429': description: Too many requests '500': description: Internal server error
/economy/top: get: summary: Economy leaderboard description: Get the top 10 players on an economy leaderboard operationId: economy/top security:
MONEY
, AP
, DWARF_POINTS
, FISHING_POINTS
, FAIRY_POINTS
'
schema:
type: string
example: MONEY
responses:
'200':
description: OK
headers:
X-Rate-Limit:
description: calls per minute allowed by the user
schema:
type: integer
format: int32
X-Rate-Limit-Remaining:
description: calls remaining in the current rate limit window
schema:
type: integer
format: int32
content:
application/json:
schema:
type: object
properties:
top:
type: array
items:
type: object
properties:
account_id:
type: string
format: uuid
description: Economy account ID
balance:
type: string
description: Economy account balance
account_name:
type: string
description: Economy account name
examples:
response:
value:
top:
/bah: properties: start_time: type: integer format: int64 description: Millisecond timestamp of when the auctionhouse starts, shown when the auctionhouse is closed next_bid: type: string description: The next bid amount current_bid: type: string description: The current bid amount current_bidder: type: string format: uuid description: The UUID of the current bidder current_bidder_name: type: string description: The name of the current bidder end_time: type: integer format: int64 description: Millisecond timestamp of when the auctionhouse ends examples: response: value: start_time: 0 next_bid: 0 current_bid: 0 current_bidder: 00000000-0000-0000-0000-000000000000 current_bidder_name: 'TODO: Improve this example' end_time: 0 '400': description: Query invalid or too long '401': description: Missing or invalid API key '429': description: Too many requests '500': description: Internal server error
/alliance (/a for alias): Group of sub-commands, such as /a who. /a info, etc.
/alliance: get: summary: Alliance info description: Get information on an alliance operationId: alliance security:
Done!
Some features we will want to have:
When a player uses /bal player, it will show the player's head and IGN as the profile of the embed... OR keep MidnightSky as the embed, and just include their head as a picture and build a decent-looking embed that way.
Allow people to use the following commands: /suggest: Suggests a new feature for the bot to the developer. /help: For now, just dump all commands and what they do. /bal: Returns the current balance of that player.
ADD MORE SUGGESTIONS AS COMMENTS