1.0.0 • Published 5 years ago

pokered-game-database v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 years ago

Generation 1 Pokemon Game Database

Travis (.org) Scrutinizer Build Scrutinizer Code Climate Code Climate Code Climate Depfu GitHub issues GitHub pull requests GitHub last commit GitHub GitHub code size in bytes GitHub repo size in bytes npm bundle size GitHub package version

This is essentially a javascript database of the internals of the Pokemon Generation 1 games. Basically sprites, event flags, character mappings, world events, etc... are all in here.

This was originally developed for Pokered Save Editor but is being broken apart into it's own published module as part of code cleanup and refactoring. It's sibling pokered-mon-database is the same but focuses on actual Pokemon data and items not specific to the games.

Build Files

There are two files, one is called PokeredGameDB.browser.js which can run in most javascript engines including web browsers. It bundles all dependencies and NodeJS mechanics together into a single UMD file. Important: PokeredGameDB.browser.js requires PokeredMonDB.browser.js to be loaded seperately before!

The other is PokeredGameDB.node.js which is much smaller, packing only the project files together and expecting to run in a NodeJS-like enviroment. It auto links to PokeredMonDB.node.js so there's no need to worry with other files.

What can you expect to find?

  • Event Pokemon from events around the world
  • Game Event Flags
  • Hidden Items and Coins
  • All maps with full detail
  • All missables
  • Random names 7 characters or less for nickname generation
  • Map Next Script Number
  • All Sprites
  • All Pokemon that make a starter candidate
  • All 3 official starters
  • All text codes and their corresponding english translation (Codex 0x00-0xFF)
  • All Towns in correct internal order
  • All Trades including non-playable trades
  • All trainers
  • More are being added

There are also methods to obtain a random starter or starter candidate and/or random names.

Some of these are inter-linked to one another as needed including linkage to pokered-mon-database such as with event Pokemon.

Usage

  • Get the name of the 1st initial move of a random starter candidate

db.getRandomStarterCandidate().initial[0].name == "Tackle"

  • Get the base attack of the first ever event Pokemon in the world

db.eventPokemon[0].pokemon.baseAttack == 100

  • Get the Bank # the map of the 2nd town is in within the cartridge

db.towns[1].name.bank == 6

  • Get the text code for the letter "a"

db.textCodes.texta.ind == 160

NPM Releases

The NPM releases only contain those 2 build files to cut space. Test pages and build instructions noted below can be used from the GitHub repo.

Building

To build yourself just issue these 2 commands

  1. npm install
  2. npm run build

Test Page

A test page exists which opens the PokeredGameDB.browser.js file in a web browser for inspection along with it's dependency PokeredMonDB.browser.js properly loaded before.

License

License Apache 2.0

Basically do whatever you want as long as you credit me back

Contributing

Contributions welcome, just fork and send pull request

1.0.0

5 years ago