Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
stelzo committed Jan 20, 2024
1 parent 0678fd9 commit d4c0698
Show file tree
Hide file tree
Showing 131 changed files with 2,470 additions and 1,686 deletions.
12 changes: 9 additions & 3 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ docs/AlmanaxEntryTributeItem.md
docs/AlmanaxWebhook.md
docs/AlmanaxWebhookDailySettings.md
docs/ConditionEntry.md
docs/ConditionEntryElement.md
docs/ConditionTreeLeaf.md
docs/ConditionTreeNode.md
docs/ConditionTreeRelation.md
docs/ConsumablesApi.md
docs/Cosmetic.md
docs/CosmeticType.md
Expand Down Expand Up @@ -80,7 +82,9 @@ src/model/AlmanaxEntryTributeItem.js
src/model/AlmanaxWebhook.js
src/model/AlmanaxWebhookDailySettings.js
src/model/ConditionEntry.js
src/model/ConditionEntryElement.js
src/model/ConditionTreeLeaf.js
src/model/ConditionTreeNode.js
src/model/ConditionTreeRelation.js
src/model/Cosmetic.js
src/model/CosmeticType.js
src/model/CreateAlmanaxWebhook.js
Expand Down Expand Up @@ -134,7 +138,9 @@ test/model/AlmanaxEntryTributeItem.spec.js
test/model/AlmanaxWebhook.spec.js
test/model/AlmanaxWebhookDailySettings.spec.js
test/model/ConditionEntry.spec.js
test/model/ConditionEntryElement.spec.js
test/model/ConditionTreeLeaf.spec.js
test/model/ConditionTreeNode.spec.js
test/model/ConditionTreeRelation.spec.js
test/model/Cosmetic.spec.js
test/model/CosmeticType.spec.js
test/model/CreateAlmanaxWebhook.spec.js
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.0.0-SNAPSHOT
7.3.0-SNAPSHOT
55 changes: 12 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@

dofusdude - JavaScript client for dofusdude-js
# A project for you - the developer.
The free, always-up-to-date, low-latency, insert-buzzword-here Ankama API for your next cool project!
The all-in-one toolbelt for your next Ankama related project.

## Client SDKs
Don't write types or functions yourself - I already (kinda) did! 😉
- [Javascript](https://github.com/dofusdude/dofusdude-js) npm i dofusdude-js --save
- [Typescript](https://github.com/dofusdude/dofusdude-ts) npm i dofusdude-ts --save
- [Go](https://github.com/dofusdude/dodugo) go get -u github.com/dofusdude/dodugo
Expand All @@ -21,66 +20,33 @@ Your favorite language is missing? Please let me know!

-**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 🇩🇪.

- 📨 **Discord Integration** Ankama related Twitter, RSS and Almanax feeds to post to Discord servers with advanced features like filters or mentions. Use the endpoints as a dev or the official [Web Client](https://discord.dofusdude.com) as a user.
- 📨 **Discord Integration** Ankama related RSS and Almanax feeds to post to Discord servers with advanced features like filters or mentions. Use the endpoints as a dev or the official [Web Client](https://discord.dofusdude.com) as a user.

- 🩸 **Dofus 2 Beta** from stable to bleeding edge by replacing /dofus2 with /dofus2beta.

- 🗣️ **Multilingual** supporting _en_, _fr_, _es_, _pt_ including the dropped languages from the Dofus website _de_ and _it_.

- 🧠 **Search by Relevance** allowing typos in name and description, handled by language specific text analysis and indexing by the powerful [Meilisearch](https://www.meilisearch.com) written in Rust.
- 🧠 **Search by Relevance** allowing typos in name and description, handled by language specific text analysis and indexing.

- 🕵️ **Complete** actual data from the game including items invisible to the encyclopedia like quest items.

- 🖼️ **HD Images** rendering vector graphics into PNGs up to 800x800 px in the background.


## Current state
- Weapons ✅
- Equipment ✅
- Sets ✅
- Resources ✅
- Consumables ✅
- Pets ✅
- Mounts ✅
- Cosmetics/Ceremonial Items ✅
- Harnesses ✅
- Quest Items ✅
- Almanax ✅
- Monsters ❌
- Spells ❌
- 🖼️ **HD Images** rendering game assets to high-res images with up to 800x800 px.

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

## Deploy now. Use forever.
Everything you see here on this site, you can use now and forever. Updates could introduce new fields, new paths or parameter but never break backwards compatibility, so no field or parameter will be deleted.
Everything you see here on this site, you can use now and forever. Updates could introduce new fields, new paths or parameter but never break backwards compatibility.

There is one exception! **The API will _always_ choose being up-to-date over everything else**. So if Ankama decides to drop languages from the game like they did with their website, the API will loose support for them, too.

## Only the beginning... 🤯
I want this project to be useful and not just add plain GET-categories no one needs.

There is a long list of features I want to add (see the Roadmap on my [Discord](https://discord.gg/3EtHskZD8h)). But they are all focussed on you, the developers. So please let me know what you need. I will change the list based on demand.

# Get started! 🥳
Scroll down and try it for yourself!

Or see how these other awesome projects use it:
- [KaellyBot](https://github.com/Kaysoro/KaellyBot) by Kaysoro
- [Dofus Craftlist](https://dofuscraftlist-dev.netlify.app) by Lystina
- [AlmanaxApp](https://almanaxapp.netlify.app) by Lystina
- [DofuStuffSimulator](https://dofusstuffsimulator.netlify.app/)

I highly recommend using the SDKs for quick results. I use them myself for parts of the API.

## Thank you!
I highly welcome everyone on my [Discord](https://discord.gg/3EtHskZD8h) to just talk about projects and use cases or give feedback of any kind.

The servers have a fixed monthly cost to provide very fast responses. If you want to help me keeping them running or simply donate, consider becoming a [GitHub Sponsor](https://github.com/sponsors/dofusdude).

The servers have a fixed monthly cost to provide very fast responses. If you want to help me keeping them running or simply donate to that cause, consider becoming a [GitHub Sponsor](https://github.com/sponsors/dofusdude).
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.8.0
- Package version: 0.8.0
- API version: 0.8.1
- Package version: 0.8.1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit [https://discord.gg/3EtHskZD8h](https://discord.gg/3EtHskZD8h)

Expand Down Expand Up @@ -215,6 +181,7 @@ Class | Method | HTTP request | Description
*dofusdude.GameApi* | [**getItemsAllSearch**](docs/GameApi.md#getItemsAllSearch) | **GET** /{game}/{language}/items/search | Search All Items
*dofusdude.MetaApi* | [**getGameSearchTypes**](docs/MetaApi.md#getGameSearchTypes) | **GET** /dofus2/meta/search/types | Available Game Search Types
*dofusdude.MetaApi* | [**getMetaAlmanaxBonuses**](docs/MetaApi.md#getMetaAlmanaxBonuses) | **GET** /dofus2/meta/{language}/almanax/bonuses | Available Almanax Bonuses
*dofusdude.MetaApi* | [**getMetaAlmanaxBonusesSearch**](docs/MetaApi.md#getMetaAlmanaxBonusesSearch) | **GET** /dofus2/meta/{language}/almanax/bonuses/search | Search Available Almanax Bonuses
*dofusdude.MetaApi* | [**getMetaElements**](docs/MetaApi.md#getMetaElements) | **GET** /dofus2/meta/elements | Effects and Condition Elements
*dofusdude.MountsApi* | [**getAllMountsList**](docs/MountsApi.md#getAllMountsList) | **GET** /{game}/{language}/mounts/all | List All Mounts
*dofusdude.MountsApi* | [**getMountsList**](docs/MountsApi.md#getMountsList) | **GET** /{game}/{language}/mounts | List Mounts
Expand Down Expand Up @@ -258,7 +225,9 @@ Class | Method | HTTP request | Description
- [dofusdude.AlmanaxWebhook](docs/AlmanaxWebhook.md)
- [dofusdude.AlmanaxWebhookDailySettings](docs/AlmanaxWebhookDailySettings.md)
- [dofusdude.ConditionEntry](docs/ConditionEntry.md)
- [dofusdude.ConditionEntryElement](docs/ConditionEntryElement.md)
- [dofusdude.ConditionTreeLeaf](docs/ConditionTreeLeaf.md)
- [dofusdude.ConditionTreeNode](docs/ConditionTreeNode.md)
- [dofusdude.ConditionTreeRelation](docs/ConditionTreeRelation.md)
- [dofusdude.Cosmetic](docs/Cosmetic.md)
- [dofusdude.CosmeticType](docs/CosmeticType.md)
- [dofusdude.CreateAlmanaxWebhook](docs/CreateAlmanaxWebhook.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/ConditionEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operator** | **String** | | [optional]
**intValue** | **Number** | | [optional]
**element** | [**ConditionEntryElement**](ConditionEntryElement.md) | | [optional]
**element** | [**ItemsListEntryTypedType**](ItemsListEntryTypedType.md) | | [optional]


11 changes: 0 additions & 11 deletions docs/ConditionEntryElement.md

This file was deleted.

10 changes: 10 additions & 0 deletions docs/ConditionTreeLeaf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# dofusdude.ConditionTreeLeaf

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**isOperand** | **Boolean** | always \"true\" for the leaf of a tree | [optional] [default to true]
**condition** | [**ConditionEntry**](ConditionEntry.md) | | [optional]


12 changes: 12 additions & 0 deletions docs/ConditionTreeNode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# dofusdude.ConditionTreeNode

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**isOperand** | **Boolean** | always \"true\" for the leaf of a tree | [optional] [default to true]
**relation** | **String** | \"and\", \"or\" | [optional] [default to 'and']
**children** | [**[ConditionTreeNode]**](ConditionTreeNode.md) | | [optional]
**condition** | [**ConditionEntry**](ConditionEntry.md) | | [optional]


11 changes: 11 additions & 0 deletions docs/ConditionTreeRelation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# dofusdude.ConditionTreeRelation

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**isOperand** | **Boolean** | always \"false\" for relations | [optional] [default to false]
**relation** | **String** | \"and\", \"or\" | [optional] [default to 'and']
**children** | [**[ConditionTreeNode]**](ConditionTreeNode.md) | | [optional]


1 change: 1 addition & 0 deletions docs/Cosmetic.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**imageUrls** | [**ImageUrls**](ImageUrls.md) | | [optional]
**effects** | [**[EffectsEntry]**](EffectsEntry.md) | | [optional]
**conditions** | [**[ConditionEntry]**](ConditionEntry.md) | | [optional]
**conditionTree** | [**ConditionTreeNode**](ConditionTreeNode.md) | | [optional]
**recipe** | [**[RecipeEntry]**](RecipeEntry.md) | | [optional]


1 change: 1 addition & 0 deletions docs/Equipment.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**imageUrls** | [**ImageUrls**](ImageUrls.md) | | [optional]
**effects** | [**[EffectsEntry]**](EffectsEntry.md) | | [optional]
**conditions** | [**[ConditionEntry]**](ConditionEntry.md) | | [optional]
**conditionTree** | [**ConditionTreeNode**](ConditionTreeNode.md) | | [optional]
**recipe** | [**[RecipeEntry]**](RecipeEntry.md) | | [optional]
**parentSet** | [**EquipmentParentSet**](EquipmentParentSet.md) | | [optional]

Expand Down
52 changes: 52 additions & 0 deletions docs/MetaApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**getGameSearchTypes**](MetaApi.md#getGameSearchTypes) | **GET** /dofus2/meta/search/types | Available Game Search Types
[**getMetaAlmanaxBonuses**](MetaApi.md#getMetaAlmanaxBonuses) | **GET** /dofus2/meta/{language}/almanax/bonuses | Available Almanax Bonuses
[**getMetaAlmanaxBonusesSearch**](MetaApi.md#getMetaAlmanaxBonusesSearch) | **GET** /dofus2/meta/{language}/almanax/bonuses/search | Search Available Almanax Bonuses
[**getMetaElements**](MetaApi.md#getMetaElements) | **GET** /dofus2/meta/elements | Effects and Condition Elements


Expand Down Expand Up @@ -96,6 +97,57 @@ No authorization required
- **Accept**: application/json


## getMetaAlmanaxBonusesSearch

> [GetMetaAlmanaxBonuses200ResponseInner] getMetaAlmanaxBonusesSearch(language, query, opts)
Search Available Almanax Bonuses

Search all the available bonuses and their id for filtering them in the range endpoint.

### Example

```javascript
import dofusdude from 'dofusdude-js';

let apiInstance = new dofusdude.MetaApi();
let language = fr; // String | a valid language code
let query = abond; // String | case sensitive search query
let opts = {
'limit': 56 // Number | maximum number of returned results
};
apiInstance.getMetaAlmanaxBonusesSearch(language, query, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**language** | **String**| a valid language code |
**query** | **String**| case sensitive search query |
**limit** | **Number**| maximum number of returned results | [optional]

### Return type

[**[GetMetaAlmanaxBonuses200ResponseInner]**](GetMetaAlmanaxBonuses200ResponseInner.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## getMetaElements

> [String] getMetaElements()
Expand Down
1 change: 1 addition & 0 deletions docs/Resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**imageUrls** | [**ImageUrls**](ImageUrls.md) | | [optional]
**effects** | [**[EffectsEntry]**](EffectsEntry.md) | | [optional]
**conditions** | [**[ConditionEntry]**](ConditionEntry.md) | | [optional]
**conditionTree** | [**ConditionTreeNode**](ConditionTreeNode.md) | | [optional]
**recipe** | [**[RecipeEntry]**](RecipeEntry.md) | | [optional]


1 change: 1 addition & 0 deletions docs/Weapon.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**imageUrls** | [**ImageUrls**](ImageUrls.md) | | [optional]
**effects** | [**[EffectsEntry]**](EffectsEntry.md) | | [optional]
**conditions** | [**[ConditionEntry]**](ConditionEntry.md) | | [optional]
**conditionTree** | [**ConditionTreeNode**](ConditionTreeNode.md) | | [optional]
**criticalHitProbability** | **Number** | | [optional]
**criticalHitBonus** | **Number** | | [optional]
**isTwoHanded** | **Boolean** | | [optional]
Expand Down
Loading

0 comments on commit d4c0698

Please sign in to comment.