Open Dofus Encyclopedia API
The dofusdude server is always running with the latest Dofus version and it is highly recommended to use its public endpoints at https://api.dofusdu.de/. Try them out here and use the SDKs for real development.
- 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
If you want to host doduapi yourself, just follow these commands.
# Prepare search engine environment
export MEILI_MASTER_KEY=supersecretandhighlysecurekey
echo "MEILI_MASTER_KEY=$MEILI_MASTER_KEY" > .env
# Install and run search engine
curl -L https://install.meilisearch.com | sh
./meilisearch --master-key $MEILI_MASTER_KEY &
# Install and run doduapi
curl -s https://get.dofusdu.de/doduapi | sh
doduapi migrate up
doduapiYou can get the search engine process back with fg later.
Open the .env with your favorite editor. Add more parameters if you want. Here is a full list.
MEILI_MASTER_KEY=<already set> # a random string that must be the same in the meilisearch.service file or parameter
DIR=<working directory> # directory where the ./data dir can be found
DOFUS_VERSION=3.0.40.28 # must match a name from https://github.com/dofusdude/dofus3-main/releases
API_SCHEME=http # http or https. Just used for building links
API_HOSTNAME=localhost # the hostname of the api. Just used for building links
API_PORT=3000 # the port where to listen on
MEILI_PORT=7700 # the port where meilisearch is listening on
MEILI_PROTOCOL=http # http or https
MEILI_HOST=127.0.0.1 # the hostname of meilisearch
PROMETHEUS=false # enable prometheus metrics export running on one apiport + 1
FILESERVER=true # will tell doduapi to serve the image files itself
ALMANAX_MAX_LOOKAHEAD_DAYS=365 # maximum date range size
ALMANAX_DEFAULT_LOOKAHEAD_DAYS=6 # default date range size
IS_BETA=false # main (false) vs beta (true)
UPDATE_HOOK_TOKEN=secret # /update/<token> will trigger an update with a POST request {"version": "<dofusversion>"}Run doduapi with --headless in a server environment to avoid "no tty" errors.