https://github.com/micheljung/d2r-api

GraphQL API for Diablo II: Resurrected
https://github.com/micheljung/d2r-api

Last synced: about 2 months ago
JSON representation

GraphQL API for Diablo II: Resurrected

• Host: GitHub
• URL: https://github.com/micheljung/d2r-api
• Owner: micheljung
• Created: 2021-10-10T13:45:29.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-04T15:29:03.000Z (about 3 years ago)
• Last Synced: 2024-04-24T12:42:00.441Z (8 months ago)
• Language: Kotlin
• Size: 747 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Diablo 2: Resurrected API (d2r-api)

An API that provides game data as a GraphQL API.

## How to use

1. Start the API using Docker:

       docker run -d -p "4000:4000" micheljung/d2r-api

1. Access, or post your queries to, [http://localhost:4000/graphql](http://localhost:4000/graphql)

## Examples

### List all Unique items

Query:

```

{

  uniqueitems {

    index

    itemName

  }

}

```

Result:

```json

{

  "data": {

    "uniqueitems": [

      {

        "index": "The Gnasher",

        "itemName": "Hand Axe"

      },

      ...

      {

        "index": "Hellfire Torch",

        "itemName": "charm"

      }

    ]

  }

}

```

### Find all complete rune words

Query:

```

{

  runes(query: [{field:"complete", query: 1}]) {

    runeName

    runesUsed

  }

}

```

Result:

```

{

  "data": {

    "runes": [

      {

        "runeName": "Ancients' Pledge",

        "runesUsed": "RalOrtTal"

      },

      ...

      {

        "runeName": "Zephyr",

        "runesUsed": "OrtEth"

      }

    ]

  }

}

```

Currently, all queried fields are `OR`. `AND` will be supported soon. Combinations of the two likely won't be supported.

## Where the Data comes from

Using the [data-extractor](build-plugins/data-extractor), a developer can extract the game's "excel" data directly

from a game installation into the folder [d2r](d2r). This could be improved by reading the data directly from Blizzard's

CDN at build time, so no game installation is needed.

All data is extracted except `sounds.txt` which is considered big and useless. Other useless data might be removed in

future, too.

Any empty or "category" lines (like "Expansion", "Armors") are removed based on heuristic. Otherwise, the data contains

everything that's present in the game files, including [unused items](https://tcrf.net/Diablo_II/Unused_Objects). It's

up to the caller to detect and remove such unwanted entries.

To update the extracted data, execute:

    .\gradlew extract

or if your installation is at a non-default location:

     .\gradlew -PdataPath="G:/Diablo II Resurrected/Data" extract

## About the GraphQL Schema

Instead of creating a static GraphQL schema for each entity by hand, it's auto-generated by the following rules:

1. If a field contains any empty value, it's considered nullable

1. If a field contains only numbers, it's considered an `Int`

1. If a field contains only numbers and one of them is a float, it's considered an `Float`

1. If a field contains any non-number content, it's considered a `String`

1. If a field contains no values at all, it's considered `String` and a warning is logged

This leads to a non-perfect schema since e.g. `Boolean` can't be detected reliably (and thus is never used), and the

type of empty columns is potentially likely incorrect. However, it also removes any manual work, human errors and

never needs to be updated.

If this decision turns out to be problematic, let me know so that a static schema can be added in the future.