dofusdude-js v1.0.0

dofusdude-js

dofusdude - JavaScript client for dofusdude-js

Open Ankama Developer Community

The all-in-one toolbelt for your next Ankama related project.

Versions

• Dofus 2
• Dofus 3
  • v1 latest (you are here)

Client SDKs

• Javascript npm i dofusdude-js --save
• Typescript npm i dofusdude-ts --save
• Go go get -u github.com/dofusdude/dodugo
• Python pip install dofusdude
• Java Maven with GitHub packages setup

Everything, including this site, is generated out of the Docs Repo. Consider it the Single Source of Truth. If there is a problem with the SDKs, create an issue there.

Your favorite language is missing? Please let me know!

Main Features

• 🥷 Seamless Auto-Update load data in the background when a new Dofus version is released and serving it within 10 minutes with atomic data source switching. No downtime and no effects for the user, just always up-to-date.

• ⚡ Blazingly Fast all data in-memory, aggressive caching over short time spans, HTTP/2 multiplexing, written in Go, optimized for low latency, hosted on bare metal in 🇩🇪.

• 📨 Almanax Discord Integration Use the endpoints as a dev or the official Web Client as a user.

• 🩸 Dofus 3 Beta from stable to bleeding edge by replacing /dofus3 with /dofus3beta.

• 🗣️ Multilingual supporting en, fr, es, pt, de.

• 🧠 Search by Relevance allowing typos in name and description, handled by language specific text analysis and indexing.

• 🕵️ Official Sources generated from actual data from the game.

... and much more on the Roadmap on my Discord.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.12.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://discord.gg/3EtHskZD8h

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install dofusdude-js --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your dofusdude-js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var dofusdude = require('dofusdude-js');


var api = new dofusdude.AlmanaxApi()
var language = "fr"; // {String} code
var date = new Date("Sat Jan 25 00:00:00 UTC 2025"); // {Date} yyyy-mm-dd
var opts = {
  'level': 56 // {Number} character level for the reward_xp field
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlmanaxDate(language, date, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.dofusdu.de

Documentation for Models

• dofusdude.Almanax
• dofusdude.AlmanaxBonus
• dofusdude.AlmanaxTribute
• dofusdude.AlmanaxTributeItem
• dofusdude.AlmanaxWebhook
• dofusdude.AlmanaxWebhookDailySettings
• dofusdude.Condition
• dofusdude.ConditionLeaf
• dofusdude.ConditionNode
• dofusdude.ConditionRelation
• dofusdude.CreateAlmanaxWebhook
• dofusdude.CreateAlmanaxWebhookDailySettings
• dofusdude.CreateAlmanaxWebhookMentionsValueInner
• dofusdude.CreateRSSWebhook
• dofusdude.CreateTwitterWebhook
• dofusdude.Effect
• dofusdude.EffectType
• dofusdude.Equipment
• dofusdude.EquipmentSet
• dofusdude.Error
• dofusdude.GameSearch
• dofusdude.GameSearchItem
• dofusdude.GameSearchType
• dofusdude.GetMetaAlmanaxBonuses200ResponseInner
• dofusdude.GetMetaWebhooksTwitter200Response
• dofusdude.Images
• dofusdude.ItemSubtype
• dofusdude.ListEquipmentSet
• dofusdude.ListEquipmentSets
• dofusdude.ListItem
• dofusdude.ListItemGeneral
• dofusdude.ListItems
• dofusdude.ListMounts
• dofusdude.Mount
• dofusdude.MountFamily
• dofusdude.PagedLinks
• dofusdude.PutAlmanaxWebhook
• dofusdude.PutRSSWebhook
• dofusdude.PutTwitterWebhook
• dofusdude.Range
• dofusdude.Recipe
• dofusdude.Resource
• dofusdude.RssWebhook
• dofusdude.TranslatedId
• dofusdude.TwitterWebhook
• dofusdude.Version
• dofusdude.Weapon

Documentation for Authorization

Endpoints do not require authorization.