KeySAVCoreJS

This is a library for all your Pokémon Generation 6 and 7 breaking needs. It has support for exporting data from Powersaves backups/backups from digital copies, main files as well as battle videos. Basically, this is the logic part of KeySAV2 rewritten. Data is returned in the form of an object containing all relevant information about the Pokémon.

TypeScript definition files are provided and an API documentation is available.

Credits

Original exploit by Kaphotics and OmegaDonut used with permission. Thank you for all your hard work!

History

Originally I forked the KeySAV2 project to add some features, since then I refactored the code multiple times, extracted this code from the interface logic, ported it to JavaScript and have eventually rewritten it.

License

All code is Copyright 2014-2017 Tobias "Copper Phosphate" Zimmermann and distributed under the terms of the MIT license.
The Pokémon character names, stats and other data is Copyright 2002-2017 Pokémon, Copyright 1995-2017 Nintendo/Creatures Inc./GAME FREAK Inc.

Index

Classes

Interfaces

Type aliases

Stats

Variables

eggnames

Type aliases

Stats

Stats: object[][]

Variables

eggnames

eggnames: string[] = ["タマゴ", "Egg", "Œuf", "Uovo", "Ei", "", "Huevo", "알", "蛋", "蛋"]

Functions

base64Encode

base64Encode(arr: Uint8Array): string

- Defined in util.ts:416
Parameters
- arr: Uint8Array
Returns string

breakKey

breakKey(break1: Uint8Array, break2: Uint8Array): Promise<string>

- Defined in save-breaker.ts:160
Create a new key for the given saves.

The two saves should satisfy the following:
- Save 1 has six Pokémon in the first six slots of box one. After saving the game was reset and saved again.
- Save 2 has the same Pokémon moved to box 2. It was not saved twice.
If the second save was also saved twice, an old-style key will be created rather than a new-style key. This means that only one of the save slots in a save will be decrypted and the user will need to save twice on every save that should be dumped later.

After creation the key will be stored in the global key store.
Parameters
- break1: Uint8Array
  
  The first save
- break2: Uint8Array
  
  The second save
Returns Promise<string>

"CREATED_NEW" if a new-style key was created, "CREATED_OLD" if an old-style key was created

breakSavOrBv

breakSavOrBv(file1: Uint8Array, file2: Uint8Array): Promise<object>

- Defined in breaker.ts:77
Create or upgrade a key with the given files.

Both files must be of the same type (battle video or save) and satisfy the requirements outlined in the relevant breakKey function.

Parameters
- file1: Uint8Array
  
  The first file to use
- file2: Uint8Array
  
  The second file to use
Returns Promise<object>

clear

clear(src: Uint8Array, offset: number, length: number): void
clear(src: Uint8Array): void

- Defined in util.ts:300
Parameters
- src: Uint8Array
- offset: number
- length: number
Returns void
- Defined in util.ts:301
Parameters
- src: Uint8Array
Returns void

copy

copy(src: Uint8Array, off1: number, dest: Uint8Array, off2: number, length: number): void

- Defined in util.ts:105
Parameters
- src: Uint8Array
- off1: number
- dest: Uint8Array
- off2: number
- length: number
Returns void

createBuffer

createBuffer(arr: Uint8Array | Uint16Array | Uint32Array): Buffer

- Defined in util.ts:87
Parameters
- arr: Uint8Array | Uint16Array | Uint32Array
Returns Buffer

createDataView

createDataView(arr: any): DataView

- Defined in util.ts:83
Parameters
- arr: any
Returns DataView

createNoKeyError

createNoKeyError(stamp: string, isSav: boolean): Error

- Defined in key-store.ts:128
Parameters
- stamp: string
- isSav: boolean
Returns Error

createNotStoredKeyError

createNotStoredKeyError(stamp: string, isSav: boolean): Error

- Defined in key-store.ts:136
Parameters
- stamp: string
- isSav: boolean
Returns Error

createUint16Array

createUint16Array(arr: any): Uint16Array

- Defined in util.ts:95
Parameters
- arr: any
Returns Uint16Array

createUint32Array

createUint32Array(arr: any): Uint32Array

- Defined in util.ts:100
Parameters
- arr: any
Returns Uint32Array

createUint8Array

createUint8Array(arr: any): Uint8Array

- Defined in util.ts:91
Parameters
- arr: any
Returns Uint8Array

decodeUnicode16LE

decodeUnicode16LE(arr: Uint8Array, offset: number, length: number): string

- Defined in util.ts:54
Parameters
- arr: Uint8Array
- offset: number
- length: number
Returns string

empty

empty(src: Uint8Array, offset: number, length: number): boolean
empty(src: Uint8Array): boolean

- Defined in util.ts:270
Parameters
- src: Uint8Array
- offset: number
- length: number
Returns boolean
- Defined in util.ts:271
Parameters
- src: Uint8Array
Returns boolean

encodeUnicode16LE

encodeUnicode16LE(str: string): Uint8Array

- Defined in util.ts:67
Parameters
- str: string
Returns Uint8Array

getKeyStore

getKeyStore(): KeyStore

- Defined in key-store.ts:91
Return the global key store.

Returns KeyStore

The global key store.

getStampAndKindFromKey

getStampAndKindFromKey(arr: Uint8Array, size: number): object

- Defined in key-store.ts:104
Extract the stamp and key variation (save or battle video) from the first 0x18 bytes of a key and the file size.

Parameters
- arr: Uint8Array
  
  The first 0x18 byteo of the key
- size: number
  
  The complete size of the key file
Returns object

an object containing the stamp for the key and the kind: 0 for saves, 1 for battle videos

getStampBv

getStampBv(arr: Uint8Array, off: number): string

- Defined in util.ts:427
Parameters
- arr: Uint8Array
- off: number
Returns string

getStampSav

getStampSav(arr: Uint8Array, off: number): string

- Defined in util.ts:423
Parameters
- arr: Uint8Array
- off: number
Returns string

load

load(input: Uint8Array): Promise<SaveReader>

- Defined in save-breaker.ts:25
Create and return a [[SaveReader]] for the given save file. The type of the file is automatically recognized and keys are retrieved from the global key store if neccessary.

Parameters
- input: Uint8Array
  
  The battle video to load
Returns Promise<SaveReader>

A promise for the created [[SaveReader]]

loadAllStats

loadAllStats(): Promise<Calculator>

- Defined in calculator.ts:145
Returns Promise<Calculator>

loadGen6Stats

loadGen6Stats(): Promise<Calculator>

- Defined in calculator.ts:133
Returns Promise<Calculator>

loadGen7Stats

loadGen7Stats(): Promise<Calculator>

- Defined in calculator.ts:139
Returns Promise<Calculator>

loadLocalization

loadLocalization(language: string): Promise<LocalizationLanguage>

- Defined in localization.ts:217
Parameters
- language: string
Returns Promise<LocalizationLanguage>

loadSavOrBv

loadSavOrBv(file: Uint8Array): Promise<object>

- Defined in breaker.ts:13
Load a given file. The file may be either a battle video or a save file.

The appropriate key will be retrieved from the global keystore if possible, otherwise an error will be thrown.

Parameters
- file: Uint8Array
  
  The file to load.
Returns Promise<object>

next(seed: any): number

- Defined in lcrng.ts:12
Advance the linear congruential PRNG with the given seed. The parameters are hardcoded to what is used in the Pokémon games.

Parameters
- seed: any
  
  The seed to advance
Returns number

The next seed

pad4

pad4(n: number): string

- Defined in util.ts:408
Parameters
- n: number
Returns string

pad5

pad5(n: number): string

- Defined in util.ts:412
Parameters
- n: number
Returns string

promisify

promisify<T>(fn: function): function
promisify<T, A1>(fn: function): function
promisify<T, A1, A2>(fn: function): function
promisify<T, A1, A2, A3>(fn: function): function
promisify<T, A1, A2, A3, A4>(fn: function): function
promisify<T, A1, A2, A3, A4, A5>(fn: function): function
promisify<T, A1, A2, A3, A4, A5, A6>(fn: function): function
promisify<T, A1, A2, A3, A4, A5, A6, A7>(fn: function): function

- Defined in util.ts:374
Type parameters
- T
Parameters
- fn: function
  - - (cb: function): void
    - Parameters
      - cb: function
        
        (err: Error, res?: T): void
        
        Parameters
        
        err: Error
        
        Optional res: T
        
        Returns void
      Returns void
Returns function
- - (): Promise<T>
  - Returns Promise<T>
- Defined in util.ts:375
Type parameters
- T
- A1
Parameters
- fn: function
  - - (arg1: A1, cb: function): void
    - Parameters
      - arg1: A1
      - cb: function
        
        (err: Error, res?: T): void
        
        Parameters
        
        err: Error
        
        Optional res: T
        
        Returns void
      Returns void
Returns function
- - (arg1: A1): Promise<T>
  - Parameters
    - arg1: A1
    Returns Promise<T>
- Defined in util.ts:376
Type parameters
- T
- A1
- A2
Parameters
- fn: function
  - - (arg1: A1, arg2: A2, cb: function): void
    - Parameters
      - arg1: A1
      - arg2: A2
      - cb: function
        
        (err: Error, res?: T): void
        
        Parameters
        
        err: Error
        
        Optional res: T
        
        Returns void
      Returns void
Returns function
- - (arg1: A1, arg2: A2): Promise<T>
  - Parameters
    - arg1: A1
    - arg2: A2
    Returns Promise<T>
- Defined in util.ts:379
Type parameters
- T
- A1
- A2
- A3
Parameters
- fn: function
  - - (arg1: A1, arg2: A2, arg3: A3, cb: function): void
    - Parameters
      - arg1: A1
      - arg2: A2
      - arg3: A3
      - cb: function
        
        (err: Error, res?: T): void
        
        Parameters
        
        err: Error
        
        Optional res: T
        
        Returns void
      Returns void
Returns function
- - (arg1: A1, arg2: A2, arg3: A3): Promise<T>
  - Parameters
    - arg1: A1
    - arg2: A2
    - arg3: A3
    Returns Promise<T>
- Defined in util.ts:382
Type parameters
- T
- A1
- A2
- A3
- A4
Parameters
- fn: function
  - - (arg1: A1, arg2: A2, arg3: A3, arg4: A4, cb: function): void
    - Parameters
      - arg1: A1
      - arg2: A2
      - arg3: A3
      - arg4: A4
      - cb: function
        
        (err: Error, res?: T): void
        
        Parameters
        
        err: Error
        
        Optional res: T
        
        Returns void
      Returns void
Returns function
- - (arg1: A1, arg2: A2, arg3: A3, arg4: A4): Promise<T>
  - Parameters
    - arg1: A1
    - arg2: A2
    - arg3: A3
    - arg4: A4
    Returns Promise<T>
- Defined in util.ts:385
Type parameters
- T
- A1
- A2
- A3
- A4
- A5
Parameters
- fn: function
  - - (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5, cb: function): void
    - Parameters
      - arg1: A1
      - arg2: A2
      - arg3: A3
      - arg4: A4
      - arg5: A5
      - cb: function
        
        (err: Error, res?: T): void
        
        Parameters
        
        err: Error
        
        Optional res: T
        
        Returns void
      Returns void
Returns function
- - (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5): Promise<T>
  - Parameters
    - arg1: A1
    - arg2: A2
    - arg3: A3
    - arg4: A4
    - arg5: A5
    Returns Promise<T>
- Defined in util.ts:388
Type parameters
- T
- A1
- A2
- A3
- A4
- A5
- A6
Parameters
- fn: function
  - - (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5, arg6: A6, cb: function): void
    - Parameters
      - arg1: A1
      - arg2: A2
      - arg3: A3
      - arg4: A4
      - arg5: A5
      - arg6: A6
      - cb: function
        
        (err: Error, res?: T): void
        
        Parameters
        
        err: Error
        
        Optional res: T
        
        Returns void
      Returns void
Returns function
- - (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5, arg6: A6): Promise<T>
  - Parameters
    - arg1: A1
    - arg2: A2
    - arg3: A3
    - arg4: A4
    - arg5: A5
    - arg6: A6
    Returns Promise<T>
- Defined in util.ts:391
Type parameters
- T
- A1
- A2
- A3
- A4
- A5
- A6
- A7
Parameters
- fn: function
  - - (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5, arg6: A6, arg7: A7, cb: function): void
    - Parameters
      - arg1: A1
      - arg2: A2
      - arg3: A3
      - arg4: A4
      - arg5: A5
      - arg6: A6
      - arg7: A7
      - cb: function
        
        (err: Error, res?: T): void
        
        Parameters
        
        err: Error
        
        Optional res: T
        
        Returns void
      Returns void
Returns function
- - (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5, arg6: A6, arg7: A7): Promise<T>
  - Parameters
    - arg1: A1
    - arg2: A2
    - arg3: A3
    - arg4: A4
    - arg5: A5
    - arg6: A6
    - arg7: A7
    Returns Promise<T>

registerPkmImpl

registerPkmImpl(generation: number, impl: object): void

- Defined in pkbase_.ts:14
Register an implementation of a generation specific specialization of PkBase.

Parameters
- generation: number
  
  The generation this specialization is for
- impl: object
  
  The implementation of the specialization
Returns void

sequenceEqual

sequenceEqual(src1: Uint8Array, src2: Uint8Array): boolean
sequenceEqual(src1: Uint8Array, src2: Uint8Array, offset: number): boolean
sequenceEqual(src1: Uint8Array, off1: number, src2: Uint8Array, off2: number, length: number): boolean

- Defined in util.ts:329
Parameters
- src1: Uint8Array
- src2: Uint8Array
Returns boolean
- Defined in util.ts:330
Parameters
- src1: Uint8Array
- src2: Uint8Array
- offset: number
Returns boolean
- Defined in util.ts:331
Parameters
- src1: Uint8Array
- off1: number
- src2: Uint8Array
- off2: number
- length: number
Returns boolean

setKeyStore

setKeyStore(store: KeyStore): void

- Defined in key-store.ts:82
Set the global key store. It is used by utility functions to store and retrieve keys for provided saves and battle videos.

Parameters
- store: KeyStore
  
  The key store to be used globally
Returns void

xor

xor(src1: Uint8Array, src2: Uint8Array): Uint8Array
xor(src1: Uint8Array, src2: Uint8Array, length: number): Uint8Array
xor(src1: Uint8Array, off1: number, src2: Uint8Array, off2: number, len: number): Uint8Array
xor(src1: Uint8Array, off1: number, src2: Uint8Array, off2: number, dest: Uint8Array, off3: number, len: number): void

- Defined in util.ts:130
Parameters
- src1: Uint8Array
- src2: Uint8Array
Returns Uint8Array
- Defined in util.ts:131
Parameters
- src1: Uint8Array
- src2: Uint8Array
- length: number
Returns Uint8Array
- Defined in util.ts:132
Parameters
- src1: Uint8Array
- off1: number
- src2: Uint8Array
- off2: number
- len: number
Returns Uint8Array
- Defined in util.ts:133
Parameters
- src1: Uint8Array
- off1: number
- src2: Uint8Array
- off2: number
- dest: Uint8Array
- off3: number
- len: number
Returns void

xorInPlace

xorInPlace(dest: Uint8Array, off1: number, src: Uint8Array, off2: number, length: number): void

- Defined in util.ts:245
Parameters
- dest: Uint8Array
- off1: number
- src: Uint8Array
- off2: number
- length: number
Returns void

xorThree

xorThree(src1: Uint8Array, off1: number, src2: Uint8Array, off2: number, src3: Uint8Array, off3: number, length: number): Uint8Array

- Defined in util.ts:202
Parameters
- src1: Uint8Array
- off1: number
- src2: Uint8Array
- off2: number
- src3: Uint8Array
- off3: number
- length: number
Returns Uint8Array

Generated using TypeDoc

KeySAVCoreJS

Credits

History

License

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Stats

Variables

eggnames

Functions

base64Encode

Parameters

arr: Uint8Array

Returns string

breakKey

Parameters

break1: Uint8Array

break2: Uint8Array

Returns Promise<string>

breakSavOrBv

Parameters

file1: Uint8Array

file2: Uint8Array

Returns Promise<object>

clear

Parameters

src: Uint8Array

offset: number

length: number

Returns void

Parameters

src: Uint8Array

Returns void

copy

Parameters

src: Uint8Array

off1: number

dest: Uint8Array

off2: number

length: number

Returns void

createBuffer

Parameters

arr: Uint8Array | Uint16Array | Uint32Array

Returns Buffer

createDataView

Parameters

arr: any

Returns DataView

createNoKeyError

Parameters

stamp: string

isSav: boolean

Returns Error

createNotStoredKeyError

Parameters

stamp: string

isSav: boolean

Returns Error

createUint16Array

Parameters

arr: any

Returns Uint16Array

createUint32Array

Parameters

arr: any

Returns Uint32Array

createUint8Array

Parameters

arr: any

Returns Uint8Array

decodeUnicode16LE

Parameters

arr: Uint8Array

offset: number