Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mitsunee/flyffu-api-playground

This repository is my personal playground for doing stuff with the Flyff Universe API provided by the game's publisher.
https://github.com/mitsunee/flyffu-api-playground

api flyff flyff-universe playground

Last synced: about 1 month ago
JSON representation

This repository is my personal playground for doing stuff with the Flyff Universe API provided by the game's publisher.

Host: GitHub
URL: https://github.com/mitsunee/flyffu-api-playground
Owner: Mitsunee
License: mit
Created: 2024-09-07T21:58:09.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-10-27T19:50:42.000Z (2 months ago)
Last Synced: 2024-10-28T00:12:48.242Z (2 months ago)
Topics: api, flyff, flyff-universe, playground
Language: TypeScript
Homepage:
Size: 508 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# flyffu-api-playground

This repository is my personal playground for doing stuff with the [Flyff Universe API](https://api.flyff.com) provided by the game's publisher.

## Usage

This repository is intended to be used with Node.js v18 and pnpm 9.x

```
pnpm install
pnpm prepare-cache
```

## Scripts

All scripts have their own built-in help text accessible with `-h` or `--help`

### Monster Search

```
pnpm search-monster
```

This script can be used to find Monsters by name. The script has flags to display or hide the id, level and rank in the result. see `--help` for more information.

### EXP Compare

```
pnpm exp-compare
```

Compare the exp efficiency of a specified selection of monster for a given level range. Monsters are searched for with the same search method as Monster Search, but limited to Small, Normal and Captain overworld monsters.

### EXP Calculator (WIP)

```
pnpm exp-calc
```

This script can be configured with a level range and filter function to determine the mobs for exp comparisons (similar to Exp Compare)

### Tower Quests

```
pnpm tsx src/tower-quests.ts
```

Simple script that finds all Forsaken Tower quests, organizes them by floor and outputs a list with how much exp is earned at each possible level for those floors, as well as how much penya is earned and how many quests are available.

## Cache

Instead of constantly redownloading the same data the `pnpm prepare-cache` script downloads all needed data for monsters and quests at once and stores it in `./data`. Other data such as NPCs and Items are downloaded once on demand and also stored:

```
data
├── monsters.json (list of all monster IDs)
├── quests.json (list of all quest IDs)
├── world.json (data of main overworld)
├── item
| └── {id}.json (individual item data)
├── monster
| ├── {id}.json (individual monster data)
| └── skill
| └── {id}.json (individual skill data)
├── monsters
| └── {slug}.json (pre-filtered monster lists)
├── npc
| └── {id}.json (individual NPC data)
└── quests
└── {id}.json (individual quest data)
```

## Monster Lists

Due to the variety of monster types that may or may not be wanted in specific queries pre-filtered monster lists are created by `prepare-cache` (see above) and available with the `getMonsterList` util: