Palworld Paldex API

First Palworld API

Info   |    Technologies   |    How to   |    Functionalities   |    Contribute   |    License

:rocket: Info

This is the first Palworld API, it's a simple API to get all Palworld Paldex data.

:family: Breeding

The breeding.rank can be used to calculate the children for two parents:

$$ \text{Child Rank} = \lfloor \frac{\text{ParentA Rank} + \text{ParentB Rank} + 1}{2} \rfloor $$

"The game will then pick the Pal with the closest power to that average. [...] The 'tie breaker' (since 1015 is equal distance between 1010 and 1020) just comes down to the which Pal [has the lower breeding.order number].

~ https://palworld.fandom.com/wiki/Breeding

For example, if you have Penkin (Breed Power = 520) and breed it with Vanwyrm Cryst (Breed Power = 620) you get a child with a Breed Power of 570:

$$ \text{Child Rank} = \lfloor \frac{520 + 620 + 1}{2} \rfloor = 570 $$

The pal with the nearest distance to 570 is Anubis, so if you breed Penkin with Vanwym Cryst you'd get Anubis. Some pals can only be bred if their parents are both of the type of the offspring. This is marked by the breeding.child_eligble flag.

The breeding power data was taken from @dini.rfl's Google Docs Sheet

:computer: Technologies

This project was developed following this technologies:

• bun
• Prettier
• ElysiaJS
• VS Code
• Typescript
• elasticlunr

:information_source: How To

To clone this application you will need Git + bun. Run in terminal:

##### Clone this repo #####

# https
$ git clone https://github.com/mlg404/palworld-paldex-api.git

# ssh
$ git clone git@github.com:mlg404/palworld-paldex-api.git

##### Access this repo #####
$ cd palworld-paldex-api

##### Install dependencies #####
$ bun install

##### Run the application #####
$ bun start

You also can run it easily with Docker:

docker-compose up

After that, just choose your favorite API client and make a request to http://localhost:3000.

You can pass some query params to the request, like http://localhost:3000?page=1&limit=10&name=Relaxaurus.

All query params are optional, but you can use them to filter the results.

*This api provides full text search with Elasticlunr, so you can search for any term in the Palworld Paldex.

:mag_right: Functionalities

See the current features!

• ElysiaJS for fast and easy API development;
• Elasticlunr for fast and easy full text search;
• useCase's structure for better code organization;
• typescript for better code quality;
• typesafety for better code quality;
• Docker

:stars: Upcoming features

• Error handling
• Eslint and Prettier
• Tests

:test_tube: Testing

Testing is a crucial part of maintaining the quality and reliability of the Palworld Paldex API. This section explains how to run the tests and provides a brief overview of the testing setup.

Running the Tests

To ensure that the API functions as expected, follow these steps to run the tests:

$ bun test

This will run all the automated tests and display the results.

Types of Tests (WIP)

The testing suite includes the following types of tests:

• Unit Tests: These tests cover individual functions and components to ensure they behave as expected in isolation.

Test Coverage

We aim to cover as much of the codebase as possible with our tests to maintain high standards of quality and reliability. Test coverage metrics are regularly updated and can be viewed in the test reports.

Continuous Integration

WIP

Contributing to Tests

Contributions to improve or add tests are always welcome. If you're interested in contributing, please follow the guidelines in the Contribute section.

:busts_in_silhouette: Contribute

• Fork this repository;
• Create one branch with your feature: git checkout -b my-feature;
• Commit your alterations: git commit -m 'feat: My new feature';
• Push to your branch: git push origin my-feature.

Open a pull request with your branch. After pull request merge, you should delete your branch.

:memo: License

This project is under MIT license. See LICENSE for more information.

Made with 💙 by Victor Eyer :wave: Get in touch!

This project was created using bun init in bun v1.0.25. Bun is a fast all-in-one JavaScript runtime.

:wrench: Projects that make use of palworld-paldex-api

• Paldex - is a Kotlin Multiplatform app (KMM) built with Compose Multiplatform to retrieve Palworld game information
• Discord Bot Using this API
• Mobile APP - PalPad