wakfu-tools v1.1.4

Wakfu Tools

Binary Decoder of the game Wakfu for NodeJS (but not for browsers) and is inspired by WakfuDecrypt. It works in environments that have the game installed.

Installation

With NodeJS installed, run the command:

npm i wakfu-tools

Usage

CommonJS:

const wakfuTools = require('wakfu-tools')

EcmaScript6:

import wakfuTools from 'wakfu-tools'

Example

Example of using WakfuTools to return a Spell that has a specific image:

import wakfuTools from 'wakfu-tools'

const { SPELL } = wakfuTools.IndexBinaries
const wakfuPath = 'YOUR_WAKFU_GAME_PATH\Ankama\zaap\wakfu'

const spells = wakfuTools.loadDocument(wakfuPath, SPELL)

console.log(spells.find(e => e.gfx_id === 7005))

API

Indexes

Wakfu Tools has indexes to facilitate the choice of the resource.

IndexBinaries

It contains all the documents that can be retrieved from the binary files.

// Can be used literally
const spellIndex = wakfuTools.IndexBinaries.SPELL

// or destructuring
const { SPELL } = wakfuTools.IndexBinaries

To constant values check IndexBinaries.js.

IndexAnimations

It contains all the animations that can be retrieved from the binary files.

// Can be used literally
const npcIndex = wakfuTools.IndexAnimations.NPC

// or destructuring
const { NPC } = wakfuTools.IndexAnimations

Constant Values:

DYNAMIC, EQUIPMENT, GUI, INTERACTIVE, NPC, PET, PLAYER, RESOURCE

IndexTranslate

It contains all the translations that can be retrieved from each language file.

// Can be used literally
const spellNameIndex = wakfuTools.IndexTranslate.SPELL_NAME

// or destructuring
const { SPELL_NAME } = wakfuTools.IndexTranslate

To constant values check IndexTranslate.js.

Methods

loadWorldInfo (wakfuPath)

Returns an array with all the worlds decoded.

import wakfuTools from 'wakfu-tools'

const wakfuPath = 'YOUR_WAKFU_GAME_PATH\Ankama\zaap\wakfu'

console.log(wakfuTools.loadWorldInfo(wakfuPath))

loadDocument (wakfuPath, indexBinary)

Returns an array of all decoded resources.

import wakfuTools from 'wakfu-tools'

const { EMOTE } = wakfuTools.IndexBinaries
const wakfuPath = 'YOUR_WAKFU_GAME_PATH\Ankama\zaap\wakfu'

const emotes = wakfuTools.loadDocument(wakfuPath, EMOTE)

console.log(emotes.find(e => e.cmd === '/hi'))

loadAnimations (wakfuPath, indexAnimation)

Returns an array of all decoded resources.

import fs from 'fs'
import wakfuTools from 'wakfu-tools'

const { NPC } = wakfuTools.IndexAnimations
const wakfuPath = 'YOUR_WAKFU_GAME_PATH\Ankama\zaap\wakfu'

const animations = wakfuTools.loadAnimations(wakfuPath, NPC)
const animation = animations.loadAnimation(1007)
const textureFile = animations.loadTexture(animation.texture.name)

fs.writeFileSync(`./texture.png`, textureFile)

loadTranslations (wakfuPath, language)

Returns an object of all translated resources.

import wakfuTools from 'wakfu-tools'

const lang = 'en'
const { SPELL_NAME } = wakfuTools.IndexTranslate
const wakfuPath = 'YOUR_WAKFU_GAME_PATH\Ankama\zaap\wakfu'

const translate = wakfuTools.loadTranslations(wakfuPath, lang)

console.log(translate[SPELL_NAME][7052])

Language can be:

pt, en, fr, de, es

Most complete example:

import wakfuTools from 'wakfu-tools'

const lang = 'en'
const { SPELL } = wakfuTools.IndexBinaries
const { SPELL_NAME, SPELL_BACKGROUND_DESCRIPTION } = wakfuTools.IndexTranslate
const wakfuPath = 'YOUR_WAKFU_GAME_PATH\Ankama\zaap\wakfu'

const translate = wakfuTools.loadTranslations(wakfuPath, lang)
const spells = wakfuTools.loadDocument(wakfuPath, SPELL)

const AllSpellNamesAndDescriptions = spells.map(spell => ({
    name: translate[SPELL_NAME][spell.id],
    description: translate[SPELL_BACKGROUND_DESCRIPTION][spell.id]
}))

console.log(AllSpellNamesAndDescriptions)