pk6parse

Extracts data from .pk6 files

Usage no npm install needed!

<script type="module">
  import pk6parse from 'https://cdn.skypack.dev/pk6parse';
</script>

README

pk6parse

Parses a .pk6 file into a javascript object. This also works in the browser; see here for an example.

Installation

To install:

npm install pk6parse

var pk6parse = require('pk6parse');

API

  • pk6parse.parseBuffer(buf, [options])
  • buf (Buffer): A Buffer in .pk6 format
  • options (object): If options.parseNames is set to true, assigns readable names to the returned data in addition to property IDs.
  • Returns (object): An object containing the parsed information from the buffer.
  • pk6parse.parseFile(filepath, [options])
  • filepath (string): The path to a .pk6 file
  • Parses the pk6 data in a given file. This is an alias for:
pk6parse.parseBuffer(require('fs').readFileSync(filepath, options))

While most of the information in the parsed object will be in a readable format, some information (such as move data) will still be represented by an ID Number. This is because the string representation of this data can vary depending on game and language. The data can be exposed by setting options.parseNames to true, or by using these helper functions:

  • pk6parse.assignReadableNames(data)
  • data (object) Parsed data, in the format of data returned by pk6parse.parseBuffer
  • Mutates the given data object by all supported "name" properties to it. For example, the abilityName property will be added based on the existing abilityId property. Note that future updates may support more names than are currently available.
  • Returns (object): The mutated object
  • pk6parse.getPokemonData(dexNo)
  • dexNo (number): The national dex number of the desired species
  • Returns (object): An object containing various information on this species, such as its name, egg groups, etc.
  • pk6parse.getItemData(itemId)
  • itemId (number): The item ID of the desired item
  • Returns (object): An object containing information about the given item
  • pk6parse.getMoveData(moveId)
  • moveId (number): The move ID of the desired move
  • Returns (object): An object containing information about the given move
  • pk6parse.getAbilityData(abilityId)
  • abilityId (number): The ability ID of the desired ability
  • Returns (object): An object containing information about the given ability
  • pk6parse.getNatureData(natureId)
  • natureId (number): The nature ID of the desired nature
  • Returns (object): An object containing information about the given nature
  • pk6parse.getMedalData(medalData)
  • medalData (number): A bitmap representing data on super training medals. In most cases, this will be directly passed from the medalData property which is exposed from a parsed pk6 file.
  • Returns (Array[String]): An array of medal names represented by the bitmap
  • pk6parse.getRibbonData(ribbonData)
  • ribbonData (number): A bitmap representing data on super training medals. In most cases, this will be directly passed from the ribbonData property which is exposed from a parsed pk6 file.
  • Returns (Array[String]): An array of ribbon names represented by the bitmap

Most of the raw data for these functions was collected from Pokeapi, without which this project would have been substantially harder.