diff --git a/README.md b/README.md index 4d20cc2..3e594f8 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,53 @@ # xiv_craft_solver -A rust program for solving FFXIV craft recipe. **Only normal lv90 recipes with stars and 70/80 dur works.** +A rust program for solving FFXIV craft recipe. + +Originaly written by [RikaKagurasaka](https://github.com/RikaKagurasaka/xiv_craft_solver), +it now is widely improved and provides python bindings for a GUI (or anything else really) ## Usage 1. Download the latest release. 2. Unzip the file. 3. Edit the `craft.toml` file. 4. Run the program. -5. Wait for about 1 minute. +5. Wait for about 1-3 seconds. 6. Copy the output. 7. Import to other simulators. +## CLI +When building the CLI invocation is done with the following parameters +``` +Small XIV solver library in rust, with python and rust bindings + +Usage: ffcraft [OPTIONS] + +Options: + -r, --recipe-name + Name of the receipe [default: default_recipe] + -c, --character-name + Name of the character [default: default_character] + -f, --file-name + The ml file name [default: craft.toml] + -v, --verbose... + The verbose flag + -d, --depth + The depth of the first pass [default: 8] + -t, --threads + Thread counts, default is 4 [default: 4] + -D, --desperate + Desperate mode, will try to finish the craft above all + -l, --long + Long mode, will try to find more solutions, at the expense of time + -h, --help + Print help + -V, --version + Print version +``` + +## Python +To build the python module, run ``maturin develop`` or ``maturin build`` then ``maturin install`` + #### Example -Note: The recipe data can be retrieved from [FFXIV Crafting Optimizer](https://yyyy.games/crafter/#/simulator) +Note: The recipe data can be retrieved from a [FFXIV Crafting Optimizer](https://yyyy.games/crafter/#/simulator) with checking of **Custom Recipe** after selecting the recipe. ![img.png](img.png) ```toml @@ -43,9 +79,19 @@ max_cp = 602 ``` Solving... -Quality: 11126/12628 - ["muscleMemory", "manipulation", "veneration", "groundwork2", "basicSynth2", "prudentSynthesis", "prudentSynthesis", "prudentSynthesis", "prudentTouch", "prudentTouch", "manipulation", "innovation", "prudentTouch", "basicTouch", "standardTouch", "advancedTouch", "innovation", "prudentTouch", "basicTouch", "standardTouch", "advancedTouch", "innovation", "trainedFinesse", "trainedFinesse", "greatStrides", "byregotsBlessing", "basicSynth2"] + > SOLUTION [Least steps] < +Quality: [10941/10920] | Durability: [0/70] | Cp : [14/602] | Steps : 18 +["muscleMemory", "manipulation", "veneration", "wasteNot2", "groundwork", "delicateSynthesis", "basicSynth", "innovation", "preparatoryTouch", "preparatoryTouch", "preparatoryTouch", "preparatoryTouch", "greatStrides", "innovation", "basicTouch", "standardTouch", "greatStrides", "byregotsBlessing", "basicSynth2"] + > SOLUTION [Most durability] < +Quality: [10923/10920] | Durability: [15/70] | Cp : [4/602] | Steps : 22 +["muscleMemory", "manipulation", "veneration", "groundwork", "carefulSynthesis", "prudentTouch", "innovation", "prudentTouch", "prudentTouch", "prudentTouch", "prudentTouch", "manipulation", "innovation", "prudentTouch", "basicTouch", "standardTouch", "advancedTouch", "innovation", "prudentTouch", "basicTouch", "greatStrides", "byregotsBlessing", "basicSynth2"] + + > SOLUTION [Most quality] < +Quality: [12142/10920] | Durability: [-5/70] | Cp : [1/602] | Steps : 22 +["muscleMemory", "manipulation", "veneration", "wasteNot2", "groundwork", "carefulSynthesis", "basicTouch", "innovation", "preparatoryTouch", "basicTouch", "standardTouch", "advancedTouch", "innovation", "prudentTouch", "basicTouch", "standardTouch", "advancedTouch", "innovation", "prudentTouch", "trainedFinesse", "greatStrides", "byregotsBlessing", "basicSynth2"] + +Program finished successfully in 954ms Press enter to exit... ``` diff --git a/pyproject.toml b/pyproject.toml index e75ad35..49e1fa0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [build-system] -requires = ["maturin>=0.14,<0.15"] -build-backend = "maturin" +requires = ["maturin>=0.14,<0.15"] #,"setuptools>=42.0", "wheel"] +build-backend = "maturin" #setuptools.build_meta [project] name = "xiv_craft_solver" @@ -11,4 +11,22 @@ classifiers = [ "Programming Language :: Python :: Implementation :: PyPy", ] +[tool.pytest.ini_options] +addopts = "--cov=ffcraft_solver" +testpaths = [ + "tests", +] +[tool.mypy] +mypy_path = "python" +check_untyped_defs = true +disallow_any_generics = true +ignore_missing_imports = true +no_implicit_optional = true +show_error_codes = true +strict_equality = true +warn_redundant_casts = true +warn_return_any = true +warn_unreachable = true +warn_unused_configs = true +no_implicit_reexport = true \ No newline at end of file diff --git a/python/__init__.py b/python/__init__.py new file mode 100644 index 0000000..8925872 --- /dev/null +++ b/python/__init__.py @@ -0,0 +1,4 @@ +""" +A rust program for solving FFXIV craft recipe. + - ffcraft_solver +""" diff --git a/python/main.py b/python/__main__.py similarity index 100% rename from python/main.py rename to python/__main__.py diff --git a/python/example_dearpygui.py b/python/ffcraft_solver/example_dearpygui.py similarity index 100% rename from python/example_dearpygui.py rename to python/ffcraft_solver/example_dearpygui.py diff --git a/python/loader.py b/python/ffcraft_solver/loader.py similarity index 100% rename from python/loader.py rename to python/ffcraft_solver/loader.py diff --git a/python/ffcraft_solver/main.py b/python/ffcraft_solver/main.py new file mode 100644 index 0000000..76c2691 --- /dev/null +++ b/python/ffcraft_solver/main.py @@ -0,0 +1,183 @@ +import dearpygui.dearpygui as dpg +import loader +import rich +import xiv_craft_solver as xcs + +dpg.create_context() +dpg.configure_app(manual_callback_management=True) +dpg.create_viewport(title='XIV Solver', width=500, height=700) + + +class User: + name = 'NEW' + food = '' + pot = '' + specialist = False + initial_craftsmanship = 0 + initial_control = 0 + initial_cp = 0 + craftsmanship = 0 + control = 0 + cp = 0 + + def refresh_gui(self) -> True: + self.compute_stats() + dpg.set_value(user_combo, self.name) + dpg.set_value(food_combo, self.food) + dpg.set_value(pot_combo, self.pot) + dpg.set_value(user_effective_stats, [self.craftsmanship, self.control, self.cp]) + return True + + def compute_stats(self) -> list: + food = [] + try: + full_food = full_config.get_foods_dict()[self.food] + # [[5, 120], [0, 0], [26, 82]] + if user.initial_craftsmanship * full_food[0][0] / 100 > full_food[0][1]: + food.append(full_food[0][1]) + else: + food.append(round(user.initial_craftsmanship * full_food[0][0] / 100)) + if user.initial_control * full_food[1][0] / 100 > full_food[1][1]: + food.append(full_food[1][1]) + else: + food.append(round(user.initial_control * full_food[1][0] / 100)) + if user.initial_cp * full_food[2][0] / 100 > full_food[2][1]: + food.append(full_food[2][1]) + else: + food.append(round(user.initial_cp * full_food[2][0] / 100)) + except KeyError as _: + food = [0, 0, 0] + pass + + pot = [] + try: + full_pot = full_config.get_pots_dict()[self.pot] + # [(0, 0), (0, 0), (6, 21)] + if user.initial_craftsmanship * full_pot[0][0] / 100 > full_pot[0][1]: + pot.append(full_pot[0][1]) + else: + pot.append(round(user.initial_craftsmanship * full_pot[0][0] / 100)) + if user.initial_control * full_pot[1][0] / 100 > full_pot[1][1]: + pot.append(full_pot[1][1]) + else: + pot.append(round(user.initial_control * full_pot[1][0] / 100)) + if user.initial_cp * full_pot[2][0] / 100 > full_pot[2][1]: + pot.append(full_pot[2][1]) + else: + pot.append(round(user.initial_cp * full_pot[2][0] / 100)) + except KeyError as _: + pot = [0, 0, 0] + pass + + if user.specialist: + specialist = [20, 20, 15] + else: + specialist = [0, 0, 0] + + self.craftsmanship = self.initial_craftsmanship + food[0] + pot[0] + specialist[0] + self.control = self.initial_control + food[1] + pot[1] + specialist[1] + self.cp = self.initial_cp + food[2] + pot[2] + specialist[2] + + def set_initial_stats(self, _, app_data, __) -> list: + self.initial_craftsmanship = app_data[0] + self.initial_control = app_data[1] + self.initial_cp = app_data[2] + self.refresh_gui() + return [self.initial_craftsmanship, self.initial_control, self.initial_cp] + + def set_specialist(self, _, app_data, __) -> bool: + if app_data: + self.specialist = True + else: + self.specialist = False + self.refresh_gui() + return self.specialist + + def set_food(self, _, app_data, __) -> str: + self.food = app_data + self.refresh_gui() + return self.food + + def set_pot(self, _, app_data, __) -> str: + self.pot = app_data + self.refresh_gui() + return self.food + + +class Recipe: + name = '' + quality = 0 + difficulty = 0 + durability = 0 + + def set_recipe_stats(self, _, app_data, __): + self.quality = app_data[0] + self.difficulty = app_data[1] + self.durability = app_data[2] + return self.quality, self.difficulty, self.durability + + def get_recipe_stats(self): + return self.quality, self.difficulty, self.durability + + def set_recipe_name(self, _, app_data, __): + self.name = app_data + self.set_recipe_stats(0, full_config.get_recipes_dict()[self.name], 0) + dpg.set_value(recipe_stats, self.get_recipe_stats()) + return self.name + + +with dpg.window(label="Settings", width=500, height=700, no_resize=True, no_title_bar=True): + user = User() + recipe = Recipe() + + full_config = loader.Loader() + characters_names = full_config.get_users_names() + foods_names = full_config.get_foods_names() + pots_names = full_config.get_pots_names() + recipe_names = full_config.get_recipes_names() + + dpg.add_text("Character") + user_combo = dpg.add_combo(items=characters_names, label="Your character") + dpg.set_value(user_combo, "NEW") + # TODO: Load 1rst user in users.yaml by default + # TODO: Make NEW prompt for a name when saving + user_stats = dpg.add_input_intx(size=3, label="Stats", tag="stats_tooltip", callback=user.set_initial_stats) + with dpg.tooltip("stats_tooltip"): + dpg.add_text("Craftsmanship / Control / CP") + dpg.add_button(label="Save!", indent=282) + specialist_checkbox = dpg.add_checkbox(label="Specialist", tag="specialist", callback=user.set_specialist) + dpg.add_text(" ") + user_effective_stats = dpg.add_input_intx(size=3, label="Effective stats", tag="effective_stats_tooltip", readonly=True) + with dpg.tooltip("effective_stats_tooltip"): + dpg.add_text("Craftsmanship / Control / CP") + + dpg.add_separator() + + dpg.add_text("Consumables") + food_combo = dpg.add_combo(items=foods_names, label="Food", callback=user.set_food) + pot_combo = dpg.add_combo(items=pots_names, label="Pot", callback=user.set_pot) + + dpg.add_separator() + + dpg.add_text("Recipe") + recipe_combo = dpg.add_combo(items=recipe_names, label="Recipe", callback=recipe.set_recipe_name) + dpg.set_value(recipe_combo, "NEW") + recipe_stats = dpg.add_input_intx(size=3, label="Stats", tag="recipe_tooltip", callback=recipe.set_recipe_stats) + with dpg.tooltip("recipe_tooltip"): + dpg.add_text("Quality / Difficulty / Durability") + # TODO: add a small grey text message if recipe matches a known recipe + dpg.add_button(label="Save!", indent=282) + + dpg.add_button(label="Solve!") + dpg.add_collapsing_header(label="Result") + + # TODO: add a log space at the bottom + +dpg.setup_dearpygui() +dpg.show_viewport() +while dpg.is_dearpygui_running(): + jobs = dpg.get_callback_queue() # retrieves and clears queue + dpg.run_callbacks(jobs) + dpg.render_dearpygui_frame() +dpg.start_dearpygui() +dpg.destroy_context() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..19524e4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +pyyaml==6.0 +rich==12.0.1 +pyparse~=1.1.7 +pyparsing[diagrams]~=3.0.7 +pytest==7.1.1 \ No newline at end of file diff --git a/requirements_dev.txt b/requirements_dev.txt new file mode 100644 index 0000000..6b51f2b --- /dev/null +++ b/requirements_dev.txt @@ -0,0 +1,7 @@ +flake8==4.0.1 +tox==3.24.5 +pytest==7.1.1 +pytest-cov==3.0.0 +mypy==0.941 +pyyaml==6.0 +rich==12.0.1 \ No newline at end of file diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..de4561b --- /dev/null +++ b/setup.cfg @@ -0,0 +1,45 @@ +[metadata] +name = ffcraft_solver +description = A rust program for solving FFXIV craft recipe. +author = Dandaedre & Vkyfox +version = 0.0.4 +license = Mozilla Public License Version 2.0 +license_file = LICENSE +platforms = unix, linux, cygwin, win32 +classifiers = + Programming Language :: Python :: 3 + Programming Language :: Python :: 3 :: Only + Programming Language :: Python :: 3.10 + Programming Language :: Python :: 3.9 + +[options] +packages = + ffcraft_solver + ffcraft_solver.modules +install_requires = + pyyaml>=6.0 +python_requires = >=3.9 +package_dir = + =src + +zip_safe = no + +[options.packages.find] +where = + = python + = python/ffcraft_solver + +[options.extras_require] +testing = + flake8>=4.0.1 + tox>=3.24.3 + pytest>=6.2.5 + pytest-cov>=2.12.1 + mypy>==0.910 + pyyaml>=6.0 + +[options.package_data] +slapping = py.typed + +[flake8] +max-line-length = 160 \ No newline at end of file diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..7fb9316 --- /dev/null +++ b/tox.ini @@ -0,0 +1,29 @@ +[tox] +minversion = 3.8.0 +envlist = py37, py38, py39, flake8, mypy +isolated_build = true + +[gh-actions] +python = + 3.7: py36, mypy, flake8 + 3.8: py38 + 3.9: py39 + +[testenv] +setenv = + PYTHONPATH = {toxinidir} +deps = + -r{toxinidir}/requirements_dev.txt +commands = + pytest --basetemp={envtmpdir} + +[testenv:flake8] +basepython = python3.10 +deps = flake8 +commands = flake8 src tests + +[testenv:mypy] +basepython = python3.10 +deps = + -r{toxinidir}/requirements_dev.txt +commands = mypy src