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
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
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/
```json
{
"id": string,
"name": string,
"setPiece": [number],
"sets": {
"goblet": string,
"plume": string,
"circlet": string,
"flower": string,
"sands": string
```typescript
interface Artifact {
id: string,
name: string,
setPiece: [number],
sets: {
goblet?: string,
plume?: string,
circlet?: string,
flower?: string,
sands?: string
},
"bonuses": [string],
"rarity": [number],
"domain": string
bonuses: [string],
rarity: [number],
domain?: string
}
```
### /api/character/
```json
{
"id": string,
"name": string,
"rarity": number,
"weapon": {
"id": string,
"name": string
```typescript
interface Character {
id: string,
name: string,
rarity: number,
weapon: {
id: string,
name: string
},
"stats": {
"hp": number,
"atk": number,
"def": number
stats: {
hp: number,
atk: number,
def: number
},
"ascensions": [
ascensions: [
{
"items": [
items: [
{
"item": Item,
"amount": number
item: Item,
amount: number
}
],
"mora": number
mora: number
}
],
"material": {
"material": [Item]
material: {
material: [Item]
},
"book": [Item],
"boss": {
"id": string,
"name": string
book: [Item],
boss: {
id: string,
name: string
},
"element": Element,
"builds": Build.roles
element: Element,
builds: Build.roles
}
```
### /api/items/
```json
```typescript
// ITEM
{
"id": string,
"name": string,
"day": [string]?,
"rarity": number?,
"parent": string?
interface Item {
id: string,
name: string,
day?: [string],
rarity?: number,
parent?: string
}
```
### /api/weapons
```json
```typescript
// WEAPON
{
"name": string,
"id": string,
"rarity": number,
"atk": number,
"secondary": string,
"type": {
"id": string,
"name": string
interface Weapon {
name: string,
id: string,
rarity: number,
atk: number,
secondary: string,
type: {
id: string,
name: string
},
"source": string,
"ascension": [
source: string,
ascension: [
{
"items": [
items: [
{
"item": Item,
"amount": number
item: Item,
amount: number
}
],
"mora": number
mora: number
}
],
"extras": {
"id": string,
"name": string,
"type": string,
"rarity": number,
"description": string,
"skill": {
"name": string?,
"description": string?
extras: {
id: string,
name: string,
type: string,
rarity: number,
description: string,
skill: {
name?: string,
description?: string
},
"secondary": {
"name": string?,
"stats": [null|float]?
secondary: {
name?: string,
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/
```json
```typescript
// BUILD
{
"roles": [
interface Build {
roles: [
{
"name": string
"recommended": boolean,
"weapons": [Weapon],
"artifacts": [[string]],
"mainStats": {
"sands": [string],
"goblet": [string],
"circlet": [string]
name: string
recommended: boolean,
weapons: [{
id: string,
refine?: number
}],
artifacts: [[string]],
mainStats: {
sands: [string],
goblet: [string],
circlet: [string]
},
"substats": [string],
"talent": [string],
"tip": string,
"note": string
substats: [string],
talent: [string],
tip: string,
note: string
}
]
}
```
### /api/domains/
```json
```typescript
// DOMAIN
{
"id": string,
"domains": [
interface Domain {
id: string,
domains: [
{
"s": number,
"id": string,
"name": string,
"ar": number,
"level": number,
"reward": {
"adventureExp": string,
"mora": string,
"friendship": string
s: number,
id: string,
name: string,
ar: number,
level: number,
reward: {
adventureExp: string,
mora: string,
friendship: string
},
"monsters": [
monsters: [
{
"id": string,
"name": string,
"count": number
id: string,
name: string,
count: number
}
],
"disorder": [string]
disorder: [string]
}
],
"artifacts": [string]
artifacts: [string]
}
```
### /api/elements/
```json
```typescript
// ELEMENT
{
"id": string,
"name": string,
"simpleName": string,
"color": number,
interface Element {
id: string,
name: string,
simpleName: string,
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
- /upcoming : Shows the events that are confirmed and upcoming
```json
```typescript
// EVENT
{
"name": string,
"pos": string,
"image": string,
"start": string,
"end": string,
"color": string,
"zoom": string?,
"url": string?,
"showOnHome": boolean?,
"timezoneDependent": boolean?
interface Event {
name: string,
pos?: string,
image?: string,
start: string,
end: string,
color?: string,
zoom?: string,
url?: string,
showOnHome?: boolean,
timezoneDependent?: boolean
}
```