Skip to content

Toolset Overview

Jump to bottom
Phil25 edited this page Jan 1, 2023 · 9 revisions

This page serves as an overview on tools related to ERDB and a brief primer on how to use them. In short, it is a collection of tools that allow applications an easy access to various, up-to-date data of ELDEN RING.

NOTE: These tools are usable but in are very early stages of development. If you're planning to use them, please let me know so I can make corrections and notify you of changes, if any.

Table of Contents

  • ERDB CLI
  • REST API
  • Image storage
  • Generated wiki pages

ERDB (CLI)

The ERDB CLI tool is the application that ties everything together and generates data for other tools found on this page. Its in-dept overview is available in the README.

REST API

Accessible under https://api.erdb.wiki, it provides the endpoints that applications can use to fetch data on items, armaments, icon IDs, reinforcement values, and many more.

The full docs are available under either https://api.erdb.wiki/v1/docs (interactive), or https://api.erdb.wiki/v1/redoc (non-interactive, but better UI).

  • This API is properly versioned, but, for the time being, only v1 will be used.
  • Each item is split into a separate table (as I began to call them) outlined in the docs (ex. armaments, tools).
  • Tables don't exactly correspond to ELDEN RING game params (ex. armaments vs ParamEquipWeapon), they're separated by my own logic.
  • Endpoints store information for any game version, but latest can be requested instead (as of 29.12.22: latest == 1.08.1).
  • Consecutive accesses are cached, latest is always cached.
  • Version needs to be in a full syntax, as specified by the docs (ex. 1.08.0 instead of 1.08).

Examples

Future considerations

  • AR calculator endpoint (by armament, armament+affinity, armament+level, armament+affinity+level).
  • ID lookups: currently items are available under their name only.

Thank you Emilia / sovietspaceship for hosting the API.

Image storage

Non-textual data is hosted using Cloudflare's image serving platform. This includes highest quality icons for all items in the game. In the future it will contain maps as well. For now, available under https://assets.erdb.workers.dev/.

  • Each image has a special ID making up its path, which specifies what it is (icons/), what table it belongs to and the ER-based icon ID itself.
  • At the end of said path, you can specify one of 4 qualities:
    • high (1024x1024),
    • low (512x512),
    • menu (192x192),
    • icon (32x32).
  • Decision to use icon IDs instead of item names was difficult, but ultimately it is easier for look-ups when multiple items share the same ID.
  • Icon IDs can be found under icon property for every table in the ERDB API which does have an icon.
  • Armor table also has icon_fem which is used for female versions of the icon, icon is always male and they differ in very few instances.

Examples

Future considerations

  • Endpoint will be aliased to assets.erdb.wiki.
  • Maps will be available under maps/ location.

ERDB Wikipedia

More user- than application-oriented tool. It uses data created by ERDB to generate a human-readable Wikipedia website. As of now, it is a heavy WIP, but a preview can be accessed here.

One of the main goals of this project is to allow users to generate their personal Wikipedia of ELDEN RING, no matter how modded it is (item randomizer, param randomizer, balance overhaul, etc...)

Future considerations

  • Use under erdb.wiki domain.
  • Complete all the tables, of course.
  • Find out a good style, maybe similar to ER menus.
  • AR calculator for every armament page.
  • Armament browser and comparison page.
  • Effect-based item lookup.
  • Links to various tools created by the community.
  • Plenty of other ideas, but please create an issue if you have a request!
Clone this wiki locally