PalNPM

PalNPM is a Node.js module that provides data and utility functions related to PalWorld. PalNPM is a simple npm package that provides a JSON file allowing users to quickly search for a Pal and access almost all the details about the Pal, including their description.

Installation

npm install palnpm

Usage

const pal = require('palnpm');

// Get an array of Pal details
console.log(pal.content);

// Get a random Pal
console.log(pal.random());

// Get the details of a Pal by its name
try {
  console.log(pal.getPalObject('Anubis'));
} catch (error) {
  console.error(error.message);
}

// Get the name of a Pal by its ID
try {
  console.log(pal.getName(1));
} catch (error) {
  console.error(error.message);
}

// Get the ID of a Pal by its name
try {
  console.log(pal.getId('Anubis'));
} catch (error) {
  console.error(error.message);
}

API

pal.content

An array containing details of various Pals.

pal.random()

Returns a random Pal from the data.

pal.getPalObject(name)

Returns the details of a Pal based on its name.

pal.getName(id)

Returns the name of a Pal based on its ID.

pal.getId(name)

Returns the ID of a Pal based on its name.

Example Return

{
  "id": 100,
  "key": "100",
  "image": "/public/images/100.png",
  "name": "Anubis",
  "wiki": "https://palworld.fandom.com/wiki/Anubis",
  "types": ["ground"],
  "imageWiki": "https://static.wikia.nocookie.net/palworld/images/2/21/Anubis_menu.png/",
  "suitability": [
    { "type": "grounding", "level": 1 },
    { "type": "snatching", "level": 2 },
    { "type": "transporting", "level": 3 }
  ],
  "drops": ["Bone", "Large Pal Soul", "Innovative Technical Manual"],
  "aura": {
    "name": "Guardian of the Desert",
    "description": "When fighting together, applies Ground damage to the player's attacks. Sometimes dodges attacks with a high-speed sidestep while in battle."
  },
  "description": "Once seen as a symbol of nobility, and an idol for those who shunned wealth and power. Yet over time, this Pal became a token of death."
}

API or Features

PalNPM offers the following features:

• Access Pal details through a simple JSON file.
• Retrieve information such as Pal name, ID, image URL, types, suitability, drops, aura, and description.

Contributing

If you'd like to contribute to PalNPM, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and submit a pull request.

License

This project is licensed under the MIT License.

Acknowledgements

Special thanks to the PalWorld community for providing valuable information about Pals.