Skip to content

Latest commit

 

History

History
250 lines (156 loc) · 8.62 KB

README.md

File metadata and controls

250 lines (156 loc) · 8.62 KB
Raw

Forks Stargazers Issues


Logo

Wakfu autobuilder


· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

The Wakfu Autobuilder is a toolkit, consisting of:

  • A Command-Line Interface (CLI)
  • A Graphic User Interface (GUI)

These tools are designed to identify the best equipment setup for your character at a specific level.

They consider your preferred statistics and use your input to determine the most effective combination.

(back to top)

Video GUI Usage Example

wakfu-autobuilder-gui.mp4

Built With

  • Kotlin
  • JavaFX

(back to top)

Usage GUI (User Interface)

To use Wakfu Autobuilder, you need to download the executable file for your operating system from the releases page and execute it

Important

I'm not paying any developer license (because it's too expensive). Therefore it's possible that in some OS you will have to bypass security for being able to start the executable for the first time

Usage CLI (Command Line Interface)

If you don't want to use the user interface you can still use it via the CLI.

For that you need first some prerequisites and installation

After that the documentation of the usage can be found using the --help command, that will list the available options and their descriptions.

./gradlew :autobuilder:run --args="--help"

Here is an example of how to use Wakfu Autobuilder in your terminal

./gradlew :autobuilder:run --args="--level 110 --action-point 11 --movement-point 5 --mastery-distance 500 --hp 2000 --range 2 --cc 30 --class cra --create-zenith-build --duration 60"

In this example, this command will search for the best equipment combination for a level 110 Cra with 11 action points, 5 movement points, 500 distance mastery, 2000 hp, 2 range, and 30 critical hit.

It will also create a zenith build.

The search will last for 60 seconds.

The output of the command will show the details of the best build found, such as the equipment names and a link to reach your zenith wakfu build created.

(back to top)

Roadmap

  • Add Changelog
  • Have a User Interface
  • Multi-language Support
    • French

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  2. Commit your Changes (git commit -m 'Add some AmazingFeature')
  3. Push to the Branch (git push origin feature/AmazingFeature)
  4. Open a Pull Request

(back to top)

Getting Started For Developer Contributors

Prerequisites

For this project you'll need to install:

Installation

  1. Clone the repo 
    git clone https://github.com/CharlyRien/wakfu-autobuilder.git
  2. Build the project with the Gradle wrapper included in the repository 
    ./gradlew build

(back to top)

Test

Test GUI

To test your release for the GUI you can use the command:

./gradlew :gui:run

It will compile and start the GUI with your local changes.

Test CLI

To test your release for the CLI you can use the command:

./gradlew :autobuilder:run --args="--help"

This command will package everything into a single executable file for the following platforms (x64):

  • Linux
  • Windows
  • macOS

After that you can use your executables created like any user would do.

License

Contact

Project Link: https://github.com/CharlyRien/wakfu-autobuilder Discord: Chosante

(back to top)

Acknowledgments

(back to top)