LICENCE.md + README.md
This commit is contained in:
parent
2a31aebb00
commit
a975842907
2 changed files with 261 additions and 0 deletions
21
LICENCE.md
Normal file
21
LICENCE.md
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2022 Evann (Estym) Regnault
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
240
README.md
Normal file
240
README.md
Normal file
|
|
@ -0,0 +1,240 @@
|
||||||
|
# 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)
|
||||||
|
|
||||||
|
## DISCLAIMER
|
||||||
|
This project runs codes that is remotely fetch from MadeBaruna's Paimon.moe repository, which is absolutely **UNSAFE** !
|
||||||
|
|
||||||
|
I however am willing to make such a risky thing as I have trust in his project.
|
||||||
|
|
||||||
|
Run it at your own risks.
|
||||||
|
|
||||||
|
## Endpoints - /api/
|
||||||
|
|
||||||
|
Every single one of the following endpoints have the following queries :
|
||||||
|
- / : List all the valid names
|
||||||
|
- /search/[name] : Search the nearest valid names according to you search query
|
||||||
|
- /[name] : Get infos about the searched object
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### /api/artifacts/
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": string,
|
||||||
|
"name": string,
|
||||||
|
"setPiece": [number],
|
||||||
|
"sets": {
|
||||||
|
"goblet": string,
|
||||||
|
"plume": string,
|
||||||
|
"circlet": string,
|
||||||
|
"flower": string,
|
||||||
|
"sands": string
|
||||||
|
},
|
||||||
|
"bonuses": [string],
|
||||||
|
"rarity": [number],
|
||||||
|
"domain": string
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### /api/character/
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": string,
|
||||||
|
"name": string,
|
||||||
|
"rarity": number,
|
||||||
|
"weapon": {
|
||||||
|
"id": string,
|
||||||
|
"name": string
|
||||||
|
},
|
||||||
|
"stats": {
|
||||||
|
"hp": number,
|
||||||
|
"atk": number,
|
||||||
|
"def": number
|
||||||
|
},
|
||||||
|
"ascensions": [
|
||||||
|
{
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"item": Item,
|
||||||
|
"amount": number
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"mora": number
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"material": {
|
||||||
|
"material": [Item]
|
||||||
|
},
|
||||||
|
"book": [Item],
|
||||||
|
"boss": {
|
||||||
|
"id": string,
|
||||||
|
"name": string
|
||||||
|
},
|
||||||
|
"element": Element,
|
||||||
|
"builds": Build.roles
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### /api/items/
|
||||||
|
|
||||||
|
```json
|
||||||
|
// ITEM
|
||||||
|
{
|
||||||
|
"id": string,
|
||||||
|
"name": string,
|
||||||
|
"day": [string]?,
|
||||||
|
"rarity": number?,
|
||||||
|
"parent": string?
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### /api/weapons
|
||||||
|
```json
|
||||||
|
// WEAPON
|
||||||
|
{
|
||||||
|
"name": string,
|
||||||
|
"id": string,
|
||||||
|
"rarity": number,
|
||||||
|
"atk": number,
|
||||||
|
"secondary": string,
|
||||||
|
"type": {
|
||||||
|
"id": string,
|
||||||
|
"name": string
|
||||||
|
},
|
||||||
|
"source": string,
|
||||||
|
"ascension": [
|
||||||
|
{
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"item": Item,
|
||||||
|
"amount": number
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"mora": number
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"extras": {
|
||||||
|
"id": string,
|
||||||
|
"name": string,
|
||||||
|
"type": string,
|
||||||
|
"rarity": number,
|
||||||
|
"description": string,
|
||||||
|
"skill": {
|
||||||
|
"name": string?,
|
||||||
|
"description": string?
|
||||||
|
},
|
||||||
|
"secondary": {
|
||||||
|
"name": string?,
|
||||||
|
"stats": [null|float]?
|
||||||
|
},
|
||||||
|
"atk": [null|float]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
The following endpoints works a bit differently with no search endpoint
|
||||||
|
|
||||||
|
- / : Lists all the valid names
|
||||||
|
- /[name] : Get infos about the searched object
|
||||||
|
|
||||||
|
### /api/builds/
|
||||||
|
|
||||||
|
```json
|
||||||
|
// BUILD
|
||||||
|
{
|
||||||
|
"roles": [
|
||||||
|
{
|
||||||
|
"name": string
|
||||||
|
"recommended": boolean,
|
||||||
|
"weapons": [Weapon],
|
||||||
|
"artifacts": [[string]],
|
||||||
|
"mainStats": {
|
||||||
|
"sands": [string],
|
||||||
|
"goblet": [string],
|
||||||
|
"circlet": [string]
|
||||||
|
},
|
||||||
|
"substats": [string],
|
||||||
|
"talent": [string],
|
||||||
|
"tip": string,
|
||||||
|
"note": string
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
### /api/domains/
|
||||||
|
|
||||||
|
```json
|
||||||
|
// DOMAIN
|
||||||
|
{
|
||||||
|
"id": string,
|
||||||
|
"domains": [
|
||||||
|
{
|
||||||
|
"s": number,
|
||||||
|
"id": string,
|
||||||
|
"name": string,
|
||||||
|
"ar": number,
|
||||||
|
"level": number,
|
||||||
|
"reward": {
|
||||||
|
"adventureExp": string,
|
||||||
|
"mora": string,
|
||||||
|
"friendship": string
|
||||||
|
},
|
||||||
|
"monsters": [
|
||||||
|
{
|
||||||
|
"id": string,
|
||||||
|
"name": string,
|
||||||
|
"count": number
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"disorder": [string]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"artifacts": [string]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### /api/elements/
|
||||||
|
```json
|
||||||
|
// ELEMENT
|
||||||
|
{
|
||||||
|
"id": string,
|
||||||
|
"name": string,
|
||||||
|
"simpleName": string,
|
||||||
|
"color": number,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Finally, the following endpoints do not fit in one of the previous categories
|
||||||
|
|
||||||
|
### /api/events/
|
||||||
|
|
||||||
|
- / : Shows all the events known to date
|
||||||
|
- /current : Shows the events actually going in the game
|
||||||
|
- /upcoming : Shows the events that are confirmed and upcoming
|
||||||
|
|
||||||
|
```json
|
||||||
|
// EVENT
|
||||||
|
{
|
||||||
|
"name": string,
|
||||||
|
"pos": string,
|
||||||
|
"image": string,
|
||||||
|
"start": string,
|
||||||
|
"end": string,
|
||||||
|
"color": string,
|
||||||
|
"zoom": string?,
|
||||||
|
"url": string?,
|
||||||
|
"showOnHome": boolean?,
|
||||||
|
"timezoneDependent": boolean?
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Technologies
|
||||||
|
|
||||||
|
- NextJS
|
||||||
|
- Redis
|
||||||
Loading…
Reference in a new issue