estym/Drunk-Venti-Api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated README.md

Browse source
This commit is contained in:
Evann Regnault 2022-08-02 02:28:54 +02:00
parent a975842907
commit 8ec4f756f5
1 changed files with 131 additions and 128 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

259
README.md
View file

@ -1,6 +1,6 @@
# Drunk-Venti-Api # Drunk-Venti-Api
This project was made to create an unofficial API for [paimon.moe](https://paimon.moe) to make a connection with my bot [Drunk Venti](../Drunk-Venti-Rust) This project was made to create an unofficial API for [paimon.moe](https://paimon.moe) to make a connection with my bot **Drunk Venti**.
## DISCLAIMER ## DISCLAIMER
This project runs codes that is remotely fetch from MadeBaruna's Paimon.moe repository, which is absolutely **UNSAFE** ! This project runs codes that is remotely fetch from MadeBaruna's Paimon.moe repository, which is absolutely **UNSAFE** !
@ -20,116 +20,116 @@ Every single one of the following endpoints have the following queries :
### /api/artifacts/ ### /api/artifacts/
```json ```typescript
{ interface Artifact {
"id": string, id: string,
"name": string, name: string,
"setPiece": [number], setPiece: [number],
"sets": { sets: {
"goblet": string, goblet?: string,
"plume": string, plume?: string,
"circlet": string, circlet?: string,
"flower": string, flower?: string,
"sands": string sands?: string
}, },
"bonuses": [string], bonuses: [string],
"rarity": [number], rarity: [number],
"domain": string domain?: string
} }
``` ```
### /api/character/ ### /api/character/
```json ```typescript
{ interface Character {
"id": string, id: string,
"name": string, name: string,
"rarity": number, rarity: number,
"weapon": { weapon: {
"id": string, id: string,
"name": string name: string
}, },
"stats": { stats: {
"hp": number, hp: number,
"atk": number, atk: number,
"def": number def: number
}, },
"ascensions": [ ascensions: [
{ {
"items": [ items: [
{ {
"item": Item, item: Item,
"amount": number amount: number
} }
], ],
"mora": number mora: number
} }
], ],
"material": { material: {
"material": [Item] material: [Item]
}, },
"book": [Item], book: [Item],
"boss": { boss: {
"id": string, id: string,
"name": string name: string
}, },
"element": Element, element: Element,
"builds": Build.roles builds: Build.roles
} }
``` ```
### /api/items/ ### /api/items/
```json ```typescript
// ITEM // ITEM
{ interface Item {
"id": string, id: string,
"name": string, name: string,
"day": [string]?, day?: [string],
"rarity": number?, rarity?: number,
"parent": string? parent?: string
} }
``` ```
### /api/weapons ### /api/weapons
```json ```typescript
// WEAPON // WEAPON
{ interface Weapon {
"name": string, name: string,
"id": string, id: string,
"rarity": number, rarity: number,
"atk": number, atk: number,
"secondary": string, secondary: string,
"type": { type: {
"id": string, id: string,
"name": string name: string
}, },
"source": string, source: string,
"ascension": [ ascension: [
{ {
"items": [ items: [
{ {
"item": Item, item: Item,
"amount": number amount: number
} }
], ],
"mora": number mora: number
} }
], ],
"extras": { extras: {
"id": string, id: string,
"name": string, name: string,
"type": string, type: string,
"rarity": number, rarity: number,
"description": string, description: string,
"skill": { skill: {
"name": string?, name?: string,
"description": string? description?: string
}, },
"secondary": { secondary: {
"name": string?, name?: string,
"stats": [null|float]? stats?: [null|float]
}, },
"atk": [null|float] atk: [null|float]
} }
} }
``` ```
@ -143,68 +143,71 @@ The following endpoints works a bit differently with no search endpoint
### /api/builds/ ### /api/builds/
```json ```typescript
// BUILD // BUILD
{ interface Build {
"roles": [ roles: [
{ {
"name": string name: string
"recommended": boolean, recommended: boolean,
"weapons": [Weapon], weapons: [{
"artifacts": [[string]], id: string,
"mainStats": { refine?: number
"sands": [string], }],
"goblet": [string], artifacts: [[string]],
"circlet": [string] mainStats: {
sands: [string],
goblet: [string],
circlet: [string]
}, },
"substats": [string], substats: [string],
"talent": [string], talent: [string],
"tip": string, tip: string,
"note": string note: string
} }
] ]
} }
``` ```
### /api/domains/ ### /api/domains/
```json ```typescript
// DOMAIN // DOMAIN
{ interface Domain {
"id": string, id: string,
"domains": [ domains: [
{ {
"s": number, s: number,
"id": string, id: string,
"name": string, name: string,
"ar": number, ar: number,
"level": number, level: number,
"reward": { reward: {
"adventureExp": string, adventureExp: string,
"mora": string, mora: string,
"friendship": string friendship: string
}, },
"monsters": [ monsters: [
{ {
"id": string, id: string,
"name": string, name: string,
"count": number count: number
} }
], ],
"disorder": [string] disorder: [string]
} }
], ],
"artifacts": [string] artifacts: [string]
} }
``` ```
### /api/elements/ ### /api/elements/
```json ```typescript
// ELEMENT // ELEMENT
{ interface Element {
"id": string, id: string,
"name": string, name: string,
"simpleName": string, simpleName: string,
"color": number, color: number,
} }
``` ```
@ -218,19 +221,19 @@ Finally, the following endpoints do not fit in one of the previous categories
- /current : Shows the events actually going in the game - /current : Shows the events actually going in the game
- /upcoming : Shows the events that are confirmed and upcoming - /upcoming : Shows the events that are confirmed and upcoming
```json ```typescript
// EVENT // EVENT
{ interface Event {
"name": string, name: string,
"pos": string, pos?: string,
"image": string, image?: string,
"start": string, start: string,
"end": string, end: string,
"color": string, color?: string,
"zoom": string?, zoom?: string,
"url": string?, url?: string,
"showOnHome": boolean?, showOnHome?: boolean,
"timezoneDependent": boolean? timezoneDependent?: boolean
} }
``` ```