Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eight04/wakfu-autobuild
A CLI tool that can find the equipment combination with the highest damage factor.
https://github.com/eight04/wakfu-autobuild
wakfu
Last synced: about 2 months ago
JSON representation
A CLI tool that can find the equipment combination with the highest damage factor.
- Host: GitHub
- URL: https://github.com/eight04/wakfu-autobuild
- Owner: eight04
- License: mit
- Created: 2020-06-06T08:53:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-29T14:23:19.000Z (over 2 years ago)
- Last Synced: 2024-10-11T23:33:21.358Z (2 months ago)
- Topics: wakfu
- Language: JavaScript
- Size: 420 KB
- Stars: 8
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
wakfu-autobuild
======================
[](https://travis-ci.com/eight04/wakfu-autobuild)
[](https://codecov.io/gh/eight04/wakfu-autobuild)
[](https://packagephobia.now.sh/result?p=wakfu-autobuild)
A CLI tool that can find the equipment combination with the highest damage factor.
Install
-------
```
npm install -g wakfu-autobuild
```
Usage
-----
```
Usage:
wakfu-autobuild [options]
Options:
--level= character level. [default: 1]
--min-level= minimum item level. [default: 0]
--element= number of elements that the character uses. [default: 1]
--require= a comma separated constrain list. Each constrain is composed by a property name,
the "=" symbol, and a value. Example: "ap=5,control=3"
--base-ap= base ap. [default: 6]
--base-mastery= base mastery given by passive or buff. [default: 0]
--base-critical-hit= base critical hit % given by passive or buff. [default: 0]
--base-critical-mastery= base critical mastery given by passive or buff. [default: 0]
--base-damage-inflicted= base damage inflicted %. [default: 0]
--second-mastery= a comma separated secondary mastery list. Example: "singleTarget,melee".
--major= calculate major points. [default: 0]
--disable-category= a comma separated category list. Example: "costume,accessory"
--disable-item= a comma separated list of item id. Example: "24674,22609"
--use-item= a comma separated list of item id. Example: "26581,17543"
--ap-to-damage calculate ap as a damage modifier.
--range-to-damage calculate range as a damage modifier. This adds 3 damage inflicted for each
range.
--score-only do not search for items but only calculate the score of the current stat given
by --base-xxx options.
```
Details:
* Equipment whose level is lower `--min-level` and higher `--level` are excluded. It doesn't calculate kit skill.
* `--element` decides how to calculate elemental mastery. Suppose an equipment gives 100 mastery in two elements. The tool adds 100 mastery for single-element character and adds 100 * 2 / 3 mastery for tri-element character.
* `--ap-to-damage` calculates AP as a damage modifier since you can cast more spells with more AP. However this is not strictly true because some spells have cooldown and can't be used multiple times in one turn.
* `--major` option treats major points as items and find the best combination with other equipment. You get one major point at level 25, 75, 125, and 175.
If you want to exclude/use specific majors, target them with id 1~7.
* Available options for `--require`:
```js
[
'ap', 'areaMastery',
'armorReceived', 'berserkMastery',
'block', 'control',
'criticalHit', 'criticalMastery',
'criticalResistance', 'distanceMastery',
'dodge', 'forceOfWill',
'healingMastery', 'hp',
'initiative', 'kitSkill',
'lock', 'meleeMastery',
'mp', 'prospecting',
'range', 'rearMastery',
'rearResistance', 'singleTargetMastery',
'wisdom', 'wp'
]
```
* Available options for `--second-mastery`:
```js
[
'area',
'berserk',
'distance',
'healing',
'melee',
'rear',
'singleTarget'
]
```
* Available options for `--disable-category`:
```js
[
'accessory', 'back',
'belt', 'chest',
'costume', 'firstWeapon',
'head', 'heavyWeapon',
'legs', 'mounts',
'neck', 'pet',
'ring', 'secondWeapon',
'shoulders'
]
```
Examples
--------
*Find some equipments for 12ap, lv.155, AoE, fire/earth Cra*
```
wakfu-autobuild --level 155 --element 2 --require control=2 --base-mastery 334 --base-critical-hit 33 --base-critical-mastery 208 --base-damage-inflicted 44 --second-mastery distance,area --disable-category accessory --range-to-damage --ap-to-damage --major 3
```
*Find some equipments for lv.140 Astrub Knight*
```
wakfu-autobuild --level 140 --element 1 --require mp=2 --base-mastery 301 --base-critical-hit 11 --second-mastery singleTarget,melee --ap-to-damage
```
*Calculate the score of autobuild for lv.166 pandora*
```
wakfu-autobuild --base-ap 12 --base-mastery 1148 --base-critical-hit 38 --ap-to-damage --score-only
```
Known issues
------
1. Static elemental mastery might not work correctly. To simplify the process e.g. "15 water mastery" will be converted to "15 mastery of 1 element".
2. Per (1), [Rokau's Club](https://www.wakfu.com/en/mmorpg/encyclopedia/weapons/14650-rokau-club) is treated as "20 mastery of 2 random elements".
3. Some classes get extra damage with specific stat e.g. Cra gains 3% damage inflicted for each `range`. Currently they are hand-crafted. Please raise feature requests to add more for other classes.
1. Set effects are not included. This affects the search result for low level items (and PvP items?).
Cache
-----
After fetching item data, it will be stored in the temporary folder (`%temp%/wakfu-autobuild` on Windows). While running, the tool checks wakfu version and decides whether to rebuild the item data.
However, this won't work when the tool itself has changed. For example, 0.4.0 doesn't process pets and mounts and the bug had been fixed at 0.4.1. In this case, you have to delete the cache folder manually to make it rebuild item data.
Changelog
---------
* 0.4.2 (Apr 29, 2022)
- Add: support `armorReceived` effect.
- Fix: elemental mastery on pets/mounts doesn't scale with level.
- Fix: `--level` and `--min-level` won't exclude pets/mounts anymore.
- Change: multiple static elemental mastery/resistance will be merge into a single effect. i.e. `15 fire mastery / 15 water mastery` would become `15 mastery of 2 random elements` instead of `15 mastery of 1 random elements / 15 mastery of 1 random elements`
* 0.4.1 (Apr 28, 2022)
- Add: `--min-level` argument.
- Add: support pets and mounts.
* 0.4.0 (Jul 23, 2020)
- Fix: dfs the final result to avoid memory overflow.
- Breaking: drop --pool-size option.
* 0.3.0 (Jul 13, 2020)
- Fix: solve negative effects correctly.
- Add: `--major` option.
- Add: `--disable-item` and `--use-item` options.
- Add: `--score-only` option.
- Add: `--pool-size` option. Improve performance.
- **Breaking: decrease default ap from 7 to 6. This affects the final score.**
- Breaking: exclude costume.
* 0.2.0 (Jun 7, 2020)
- Rewrite the solver, improve performance.
- Display alternative item in the result.
* 0.1.0 (Jun 6, 2020)
- Initial release.