Compare commits

..

36 Commits
v0.1.5 ... dev

Author SHA1 Message Date
Dandaedre 0600681ec8 Update Jenkinsfile
Rust/Python CI xiv_csolver failed CI.
Archive/xiv_csolver/pipeline/head There was a failure building this commit Details
Gitea/xiv_csolver/pipeline/head There was a failure building this commit Details
2026-09-13 13:38:34 +02:00
Dandaedre ff4428ebef Add Jenkinsfile
Rust/Python CI xiv_csolver failed CI.
Gitea/xiv_csolver/pipeline/head There was a failure building this commit Details
2026-09-13 13:32:15 +02:00
Dandaedre d0cacd765c v0.1.8 2023-05-25 19:58:30 +02:00
Dandaedre 89856681f7 Test WinR 2023-05-25 19:23:35 +02:00
beffroi 099ea3fcba "Fixes" a logging error by masking it 2023-05-25 11:51:58 +02:00
beffroi 6ce1bc1e71 Adds a lot to the todo list, and adds a fast and wonky autoretry
fix the gitignore and ignore file
2023-05-25 11:33:16 +02:00
Dandaedre 75495dc2c5 Typo(Doc) - Fixes a broken doc reference 2023-03-09 04:27:34 +01:00
Dandaedre 4808b5f82f Test(Coverage) - Adds the final coverage for bindings and corrects the python's side of implementation 2023-03-09 04:21:09 +01:00
Dandaedre 9a958fd804 Split Python bindings and finishes coverage 2023-03-09 02:02:02 +01:00
Dandaedre b0cf27f624 Test(Coverage) - Adds the coverage of lib.rs and purges useless data from the report (python and main) 2023-03-09 01:32:12 +01:00
Dandaedre 406bc0e515 Test(Coverage) - Adds solver coverage and fixes tests/ folder being there 2023-03-08 06:14:17 +01:00
Dandaedre 539a14a4fc Coverage(Solver) - Puts solver at 76% coverage 2023-03-07 07:58:12 +01:00
Dandaedre fc5cce934a Reformat(All) - Reformats the code 2023-03-07 06:48:35 +01:00
Dandaedre ee24bdd0af Tests(Multiple) - Updates multiple test units 2023-03-07 06:24:22 +01:00
Dandaedre d5ff22d026 Build(Tests) - Cleanup of the test harness 2023-03-07 06:23:33 +01:00
Dandaedre cce631261b Coverage(actions) - Adds coverage of actions.rs 2023-03-06 15:34:11 +01:00
Dandaedre 72a1fa4fdc Release(0.1.7) - Test, release and Format
Also renamed files
2023-03-06 03:27:41 +01:00
Dandaedre a54c09bc66 Coverage(WIP) - Deletes the html coverage report and addns specs coverage 2023-03-06 03:13:53 +01:00
Dandaedre 283d00d31a Fix(Rust) - Fix of a silly GIL mistake 2023-03-05 06:24:07 +01:00
Dandaedre 686c7d97c0 Update(Todo) - Adds the implemented features of 0.1.6 2023-03-05 05:30:01 +01:00
Dandaedre 25678a307a Fix(Version) - Fix the version number for a patch not a relase (0.2.0 -> 0.1.6) 2023-03-05 05:26:40 +01:00
Dandaedre 9cf9791a37 Version(0.2.0) - Introduces the release 2023-03-05 05:17:16 +01:00
Dandaedre 9fa1ee8cf6 Doc(Addentum) - Adds more documentation 2023-03-05 05:17:16 +01:00
Dandaedre a5c196b764 Addentum(Doc) - Adds more documentation 2023-03-05 05:17:16 +01:00
Dandaedre 0c5ed39573 Doc(Addentum) - Added a lot of documentation and some code examples 2023-03-05 05:17:16 +01:00
Dandaedre 47792825f7 Deletion(Coverage) - Deletes the coverage output, since it cannot properly be displayed 2023-03-05 05:17:16 +01:00
Dandaedre 95353bd86d Fix(Config) - Fixed a couple of values in config files 2023-03-05 05:17:16 +01:00
Dandaedre 78e7f56b67 Deletion(Ressources) - Deleted an extra folder with a typo in the name 2023-03-05 05:17:16 +01:00
Dandaedre 4321cb1a6a Coverage(test) - First batch of test function & coverage 2023-03-05 05:17:16 +01:00
Dandaedre c0aafa15bd Fix(Users.taml) - Fixes the user yaml that was broken by commit cf9fe275ee 2023-03-05 05:14:17 +01:00
vicky cf9fe275ee finalized save feature! 2023-03-04 14:32:27 +01:00
vicky a2b618f566 added verification logic to save as input, added printing to yaml for users 2023-03-03 18:18:43 +01:00
vicky fca57523eb added todo for error handling bad yaml 2023-03-03 18:08:10 +01:00
vicky 383912d8f4 Added option to save users and make them appear and update user list, no print yet 2023-03-03 17:30:36 +01:00
Dandaedre d8819feb41 Fix(Project name) - [Breaking] Changes all naming convention for the project 2023-02-25 21:33:11 +01:00
Dandaedre 53779bb19d Fix(Makefile) - Changes the lock and adds _linux to the zip 2023-02-25 01:17:42 +01:00
46 changed files with 2629 additions and 455 deletions

9
.bumpversion.cfg Normal file
View File

@ -0,0 +1,9 @@
[bumpversion]
current_version = 0.1.8
tag = True
[bumpversion:file:python/pyproject.toml]
[bumpversion:file:Cargo.toml]
[bumpversion:file:pyproject.toml]

3
.gitignore vendored
View File

@ -7,6 +7,8 @@ expected_values.md
releases/* releases/*
.whl .whl
pyinstaller_log.txt pyinstaller_log.txt
llvm/*
/coverage/*
# Byte-compiled / optimized / DLL files # Byte-compiled / optimized / DLL files
__pycache__/ __pycache__/
@ -161,3 +163,4 @@ dmypy.json
# Cython debug symbols # Cython debug symbols
cython_debug/ cython_debug/
Cargo.lock

2
.ignore Normal file
View File

@ -0,0 +1,2 @@
*.ico
*.png

48
Cargo.lock generated
View File

@ -63,6 +63,22 @@ dependencies = [
"os_str_bytes", "os_str_bytes",
] ]
[[package]]
name = "ctor"
version = "0.1.26"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6d2301688392eb071b0bf1a37be05c469d3cc4dbbd95df672fe28ab021e6a096"
dependencies = [
"quote",
"syn",
]
[[package]]
name = "diff"
version = "0.1.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "56254986775e3233ffa9c4d7d3faaf6d36a2c09d30b20687e9f88bc8bafc16c8"
[[package]] [[package]]
name = "errno" name = "errno"
version = "0.2.8" version = "0.2.8"
@ -192,6 +208,15 @@ version = "6.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9b7820b9daea5457c9f21c69448905d723fbd21136ccf521748f23fd49e723ee" checksum = "9b7820b9daea5457c9f21c69448905d723fbd21136ccf521748f23fd49e723ee"
[[package]]
name = "output_vt100"
version = "0.1.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "628223faebab4e3e40667ee0b2336d34a5b960ff60ea743ddfdbcf7770bcfb66"
dependencies = [
"winapi",
]
[[package]] [[package]]
name = "parking_lot" name = "parking_lot"
version = "0.12.1" version = "0.12.1"
@ -215,6 +240,18 @@ dependencies = [
"windows-sys", "windows-sys",
] ]
[[package]]
name = "pretty_assertions"
version = "1.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a25e9bcb20aa780fd0bb16b72403a9064d6b3f22f026946029acb941a50af755"
dependencies = [
"ctor",
"diff",
"output_vt100",
"yansi",
]
[[package]] [[package]]
name = "proc-macro-error" name = "proc-macro-error"
version = "1.0.4" version = "1.0.4"
@ -552,14 +589,21 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "447660ad36a13288b1db4d4248e857b510e8c3a225c822ba4fb748c0aafecffd" checksum = "447660ad36a13288b1db4d4248e857b510e8c3a225c822ba4fb748c0aafecffd"
[[package]] [[package]]
name = "xiv_craft_solver" name = "xiv_csolver"
version = "0.1.4" version = "0.1.7"
dependencies = [ dependencies = [
"clap", "clap",
"lazy_static", "lazy_static",
"pretty_assertions",
"pyo3", "pyo3",
"strum", "strum",
"strum_macros", "strum_macros",
"threadpool", "threadpool",
"toml", "toml",
] ]
[[package]]
name = "yansi"
version = "0.5.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "09041cd90cf85f7f8b2df60c646f853b7f535ce68f85244eb6731cf89fa498ec"

View File

@ -1,13 +1,13 @@
[package] [package]
name = "xiv_craft_solver" name = "xiv_csolver"
version = "0.1.5" version = "0.1.8"
edition = "2021" edition = "2021"
authors = ["谭俊健","Dandaedre","Vkyfox"] authors = ["谭俊健","Dandaedre","Vkyfox"]
description = "Small XIV solver library in rust, with python and rust bindings" description = "Small XIV solver library in rust, with python and rust bindings"
homepage = "https://proxy.dandaedre.com/gitea/Dandaedre/rcraft_solver" homepage = "https://proxy.dandaedre.com/gitea/Dandaedre/xiv_csolver"
documentation = "https://proxy.dandaedre.com/gitea/Dandaedre/rcraft_solver" documentation = "https://proxy.dandaedre.com/gitea/Dandaedre/xiv_csolver"
repository = "https://proxy.dandaedre.com/gitea/Dandaedre/rcraft_solver.git" repository = "https://proxy.dandaedre.com/gitea/Dandaedre/xiv_csolver.git"
license = "MIT OR Apache-2.0" license = "Apache-2.0"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@ -19,7 +19,7 @@ toml = "0.5.9"
clap = {version = "4.1.6", features = ["derive"]} clap = {version = "4.1.6", features = ["derive"]}
threadpool = "1.8.1" threadpool = "1.8.1"
# For python bindings TODO: make it optionnal # For python bindings TODO: make it optionnal
pyo3 = { version = "0.18.0", features = ["extension-module"] } pyo3 = { version = "0.18.1", features= ["extension-module"]}
# [target.'cfg(not(no_python))'.dependencies] # [target.'cfg(not(no_python))'.dependencies]
# pyo3 = { version = "0.18.0", features = ["extension-module"] } # pyo3 = { version = "0.18.0", features = ["extension-module"] }
@ -27,25 +27,27 @@ pyo3 = { version = "0.18.0", features = ["extension-module"] }
# [build] # [build]
# target = ["x86_64-unknown-linux-gnu", "x86_64-unknown-windows-gnu"] # target = ["x86_64-unknown-linux-gnu", "x86_64-unknown-windows-gnu"]
[dev-dependencies]
pretty_assertions = "1"
[profile.release] [profile.release]
panic = 'abort' panic = 'abort'
opt-level = 3 opt-level = 3
lto = true lto = true
[features] [features]
default = [] extension-module = ["pyo3/extension-module"]
default = ["extension-module"]
verbose = [] verbose = []
no_python = [] # Removes the python bindings no_python = [] # Removes the python bindings
fast = [] # Remove some under optimisations that try to find other routes fast = [] # Remove some under optimisations that try to find other routes
[lib] [lib]
name = "xiv_craft_solver" # Pending rename ffcraft_solver_lib name = "xiv_csolver_lib"
path = "src/lib.rs" path = "src/lib.rs"
crate-type = ["cdylib","rlib"] crate-type = ["cdylib","rlib"]
[[bin]] [[bin]]
name = "ffcraft_solver_cli" name = "xiv_csolver_cli"
path = "src/bin/ffcraft.rs" path = "src/bin/xiv_csolver.rs"
[tool.maturin]
python-source = "python"

232
Jenkinsfile vendored Normal file
View File

@ -0,0 +1,232 @@
// Add this webhook in Gitea:
// http://192.168.1.37:8080/gitea-webhook/post
pipeline {
agent { label 'rust_no_docker' }
environment {
CARGO_TERM_COLOR = 'always'
RUST_BACKTRACE = '1'
VENV = '.venv'
}
stages {
stage('Checkout') {
steps {
checkout scm
sh '''
set -eu
git submodule sync --recursive
git submodule update --init --recursive
'''
}
}
stage('Setup Rust') {
steps {
sh '''
set -eu
if ! command -v rustup >/dev/null 2>&1; then
echo "ERROR: rustup is not installed on this worker." >&2
exit 1
fi
echo "Ensuring stable Rust is available..."
rustup toolchain install stable \
--profile minimal \
--component rustfmt \
--component clippy
rustup default stable
echo
echo "Using:"
rustc --version
cargo --version
rustfmt --version
cargo clippy --version
'''
}
}
stage('Setup Python') {
steps {
sh '''
set -eu
if ! command -v uv >/dev/null 2>&1; then
echo "uv not found — installing it..."
if ! command -v cargo-binstall >/dev/null 2>&1; then
echo "cargo-binstall not found — installing it..."
cargo install cargo-binstall
fi
cargo binstall --no-confirm uv
else
echo "uv already installed."
fi
echo "Using:"
uv --version
rm -rf "${VENV}"
echo "Creating Python virtual environment..."
uv venv "${VENV}"
echo "Installing Maturin..."
uv pip install \
--python "${VENV}/bin/python" \
"maturin>=0.14,<0.15"
echo
echo "Python:"
"${VENV}/bin/python" --version
echo "Maturin:"
"${VENV}/bin/maturin" --version
'''
}
}
stage('Format') {
steps {
sh '''
set -eu
echo "Checking Rust formatting..."
cargo fmt --all -- --check
'''
}
}
stage('Rust Check') {
steps {
sh '''
set -eu
echo "Checking Rust targets..."
cargo check \
--all-targets \
--all-features
'''
}
}
stage('Rust Tests') {
steps {
sh '''
set -eu
echo "Running Rust tests..."
cargo test \
--all-targets \
--all-features
'''
}
}
stage('Clippy') {
steps {
sh '''
set -eu
echo "Running Clippy..."
cargo clippy \
--all-targets \
--all-features
'''
}
}
stage('Build CLI') {
steps {
sh '''
set -eu
echo "Building xiv_csolver CLI..."
cargo build \
--release \
--bin xiv_csolver_cli
echo
echo "CLI build completed."
if [ -f target/release/xiv_csolver_cli ]; then
ls -lh target/release/xiv_csolver_cli
fi
'''
}
}
stage('Build Python Bindings') {
steps {
sh '''
set -eu
echo "Building Python extension through Maturin..."
"${VENV}/bin/maturin" build \
--release
echo
echo "Python binding build completed."
'''
}
}
}
post {
success {
publishChecks(
conclusion: 'SUCCESS',
name: 'Rust/Python CI',
summary: 'xiv_csolver passed all CI checks.',
text: 'Formatting, Rust checks, tests, Clippy, CLI build, and Python binding build completed successfully.',
title: 'Build Successful'
)
echo '✅ xiv_csolver passed all CI checks.'
}
failure {
publishChecks(
conclusion: 'FAILURE',
name: 'Rust/Python CI',
summary: 'xiv_csolver failed CI.',
text: 'Formatting, Rust compilation, tests, Clippy, CLI build, or Maturin binding build failed. Check the Jenkins log.',
title: 'Build Failed'
)
echo '❌ xiv_csolver CI failed.'
}
unstable {
publishChecks(
conclusion: 'ACTION_REQUIRED',
name: 'Rust/Python CI',
summary: 'xiv_csolver CI is unstable.',
text: 'The Jenkins build completed with an unstable status.',
title: 'Build Unstable'
)
echo '⚠️ xiv_csolver CI is unstable.'
}
always {
sh '''
echo "Cleaning Python CI environment..."
rm -rf .venv
'''
}
}
}

View File

@ -14,14 +14,26 @@ dependencies = [
script_runner="@shell" script_runner="@shell"
ignore_errors = true ignore_errors = true
script = [ script = [
"twine upload releases/ffcraft_solver*.whl --repository gitea", "twine upload releases/xiv_csolver*.whl --repository gitea",
"twine upload releases/xiv_craft_solver*.whl --repository gitea", "twine upload releases/xiv_csolver_lib*.whl --repository gitea",
] ]
[tasks.format] [tasks.fmt]
install_crate = "rustfmt" script_runner = "@shell"
command = "cargo" script = [
args = ["fmt", "--", "--emit=files"] "cargo +nightly fmt -- --config format_code_in_doc_comments=true --config imports_granularity=Module"
]
[tasks.testcov]
script_runner = "@shell"
ignore_errors = true
script = [
"mkdir -p coverage",
"mkdir -p coverage/html",
"mkdir -p coverage/",
"CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage -Ccodegen-units=1 -Copt-level=0 -Coverflow-checks=off' LLVM_PROFILE_FILE='llvm/cargo-test-%p-%m.profraw' cargo test",
"grcov . --binary-path ./target/debug/deps/ -s . -t html --branch --ignore-not-existing --ignore '../*' --ignore '/*' --ignore '*xiv_csolver.rs' --ignore '*python*.rs' -o coverage/html/",
]
[tasks.clean] [tasks.clean]
command = "cargo" command = "cargo"
@ -46,8 +58,8 @@ script_runner = "@shell"
script = ''' script = '''
mkdir -p releases # Add version as an arg and things mkdir -p releases # Add version as an arg and things
cp target/wheels/*.whl releases/ cp target/wheels/*.whl releases/
zip releases/ffcraft_solver_cli.zip -j target/release/ffcraft_solver_cli craft.toml -j target/release/libxiv_craft_solver.so zip releases/xiv_csolver_cli_linux.zip -j target/release/xiv_csolver_cli craft.toml -j target/release/libxiv_craft_solver.so
cd python/dist/ && zip ../../releases/ffcraft_solver_gui.zip -r ffcraft_solver_gui_linux/ cd python/dist/ && zip ../../releases/xiv_csolver_gui_linux.zip -r xiv_csolver_gui_linux/
''' '''
[tasks.zip_win] [tasks.zip_win]
@ -55,8 +67,8 @@ script_runner = "@shell"
script = ''' script = '''
mkdir -p releases # Add version as an arg and things mkdir -p releases # Add version as an arg and things
cp target/wheels/*.whl releases/ cp target/wheels/*.whl releases/
tar acvf releases/ff_craft_solver_cli_win.zip .\craft.toml -C .\target\release\ ffcraft_solver_cli.exe libxiv_craft_solver.d tar acvf releases/xiv_csolver_cli_win.zip .\craft.toml -C .\target\release\ xiv_csolver_cli.exe libxiv_craft_solver.d
tar acvf releases/ff_craft_solver_gui_win.zip -C .\python\dist\ .\ffcraft_solver_gui_win\* tar acvf releases/xiv_csolver_gui_win.zip -C .\python\dist\ .\xiv_csolver_gui_win\*
''' '''
[tasks.pip] [tasks.pip]
@ -78,13 +90,14 @@ linux_alias = "linux_pyinstaller"
script_runner = "@shell" script_runner = "@shell"
script = ''' script = '''
cd python cd python
pyinstaller src/ffcraft_solver/__main__.py -i "src/ffcraft_solver/ressources/ffcraft_solver.ico" --add-data "src/ffcraft_solver/configs/:ffcraft_solver/configs" --add-data "src/ffcraft_solver/ressources/:ffcraft_solver/ressources" --name ffcraft_solver_gui_linux -y pyinstaller src/xiv_csolver/__main__.py -i "src/xiv_csolver/ressources/xiv_csolver.ico" --add-data "src/xiv_csolver/configs/:xiv_csolver/configs" --add-data "src/xiv_csolver/ressources/:xiv_csolver/ressources" --name xiv_csolver_gui_linux -y
''' '''
[tasks.windows_pyinstaller] [tasks.windows_pyinstaller]
script_runner = "@shell" script_runner = "@shell"
script = ''' script = '''
cd python && pyinstaller src\ffcraft_solver\__main__.py --add-data "src\ffcraft_solver\configs\;ffcraft_solver\configs" --add-data "src\ffcraft_solver\ressources\;ffcraft_solver\ressources" --name ffcraft_solver_gui_win -y cd python
pyinstaller src\xiv_csolver\__main__.py -i "src/xiv_csolver/ressources/xiv_csolver.ico" --add-data "src\xiv_csolver\configs\;xiv_csolver\configs" --add-data "src\xiv_csolver\ressources\;xiv_csolver\ressources" --name xiv_csolver_gui_win -y
''' '''
[tasks.build] [tasks.build]
@ -100,6 +113,8 @@ args = ["develop", "--release"]
command = "maturin" command = "maturin"
args = ["build", "--release"] args = ["build", "--release"]
[tasks.rebuild]
dependencies = ["clean","build","maturin","pip"]
[tasks.rust] [tasks.rust]
dependencies = ["build","maturin"] dependencies = ["build","maturin"]

View File

@ -1,9 +1,12 @@
# xiv_craft_solver # xiv_csolver
A rust program for solving FFXIV craft recipe. A rust program for solving FFXIV craft recipe.
Originaly written by [RikaKagurasaka](https://github.com/RikaKagurasaka/xiv_craft_solver), 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) it now is widely improved and provides python bindings for a GUI (or anything else really)
![coverage/html/badges/plastic.svg](coverage/html/badges/flat.svg)
### Basic RUST CLI Usage ### Basic RUST CLI Usage
Everything is done through the regular cargo interface Everything is done through the regular cargo interface
1. Download the latest release. 1. Download the latest release.
@ -19,7 +22,7 @@ When building the CLI invocation is done with the following parameters
``` ```
Small XIV solver library in rust, with python and rust bindings Small XIV solver library in rust, with python and rust bindings
Usage: ffcraft [OPTIONS] Usage: xiv_csolver_cli [OPTIONS]
Options: Options:
-r, --recipe-name <RECIPE_NAME> -r, --recipe-name <RECIPE_NAME>
@ -43,7 +46,13 @@ Options:
-V, --version -V, --version
Print version Print version
``` ```
## Developpement ## Developpement
Please remember to set and use a venv before building
While not mandatory, using ``cargo-make`` will provide you with the commands:
- cargo make rebuild (rebuilding both the rust and pip bindings)
- cargo make release (rebuilding and bundling the executables (for your os)) in a releases folder
### Rust ### Rust
Everything is located in the root & src. Everything is located in the root & src.
You can build the program (CLI) with cargo build the following features are available You can build the program (CLI) with cargo build the following features are available
@ -51,8 +60,9 @@ You can build the program (CLI) with cargo build the following features are avai
- The ``no_python`` will not build the lib (WIP, not fully implemented) - The ``no_python`` will not build the lib (WIP, not fully implemented)
- The ``fast`` feature will not allow some under-optimisation to run (saving global run-time) - The ``fast`` feature will not allow some under-optimisation to run (saving global run-time)
- The ``verbose`` feature will allow even more debug messages (They might not be shown depending on the verbosity level hoever) - The ``verbose`` feature will allow even more debug messages (They might not be shown depending on the verbosity level hoever)
#### Maturin #### Maturin
To build the python module, run ``maturin develop`` or ``maturin build`` then ``maturin install`` To build the python module, run either ``maturin develop`` or ``maturin build`` then ``maturin install``
### Python ### Python
#### Developping the GUI #### Developping the GUI
@ -60,10 +70,9 @@ To build the python module, run ``maturin develop`` or ``maturin build`` then ``
1. Go to the ``python`` directory 1. Go to the ``python`` directory
2. Install the dev dependencies ``pip install -r requirements_dev.txt`` 2. Install the dev dependencies ``pip install -r requirements_dev.txt``
3. Install the project (in editable mode) ``pip install -e .`` 3. Install the project (in editable mode) ``pip install -e .``
4. Invoke the project (from anywhere) ``python -m ffcraft_solver`` 4. Invoke the project (from anywhere) ``python -m xiv_csolver``
5. Edit the project and re-invoke it (no need to install / compile again) 5. Edit the project and re-invoke it (no need to install / compile again)
#### Rust CLI Example #### Rust CLI Example
Note: The recipe data can be retrieved from a [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. with checking of **Custom Recipe** after selecting the recipe.

17
Todo.md
View File

@ -5,20 +5,31 @@
✅ (GUI) Make macros work ✅ (GUI) Make macros work
🟩 (GUI) Visual feedback when pressing solve 🟩 (GUI) Visual feedback when pressing solve
🟩 (GUI) Update on the Quality % 🟩 (GUI) Update on the Quality %
🟩 (GUI) Ability to save ✅ (GUI) Ability to save
✅ (GUI) Make the logging work ✅ (GUI) Make the logging work
🟩 (PKG) Rename libs, bin, python, exe ✅ (PKG) Rename libs, bin, python, exe
### Important ### Important
✅ (PKG) Have cargo-make setup for release/cleanup/build ✅ (PKG) Have cargo-make setup for release/cleanup/build
✅ (PKG) Merge latest pre-release for the GUI ✅ (PKG) Merge latest pre-release for the GUI
✅ (PKG) Have a rebuild function
🟩 (CLI) Rework the parameters and return structs to only have one ref each
### Features ### Features
🟩 (GUI) Refactor code 🟩 (GUI) Refactor code
🟩 (GUI) Restore GUI state
🟩 (GUI) Bugfix the gui and clean it up
🟩 (LIB) Restructure code, cleanup the mess
🟩 (LIB) Have an autoretry
🟩 (LIB) Have the autoretry be smart and/or threaded with interrupts
🟩 (LIB) Cleanup the Toml to have one unique Food/Receipe/Craftsman with the gui
🟩 (LIB) Be more aggressive with the mem optimisations
🟩 (LIB) Have a thread interrupt mode for fast mode
🟩 (LIB) Cleanup features (verbose doesn't really make sense)
# Roadmap # Roadmap
## v1.0.0 ## v1.0.0
### Important ### Important
🟩 (LIB) Rust API docs ✅ (LIB) Rust API docs
🟩 (CLI) Accept and copy from the base recipes 🟩 (CLI) Accept and copy from the base recipes
🟩 (CLI) Accept and copy pots & food 🟩 (CLI) Accept and copy pots & food
🟩 (PKG) Have a unified toml/yaml way of registering recipes 🟩 (PKG) Have a unified toml/yaml way of registering recipes

View File

@ -0,0 +1,23 @@
<svg xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink" width="96" height="20" role="img" aria-label="coverage: 99%">
<title>coverage: 99%</title>
<linearGradient id="s" x2="0" y2="100%">
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
<stop offset="1" stop-opacity=".1"/>
</linearGradient>
<clipPath id="r">
<rect width="96" height="20" rx="3" fill="#fff"/>
</clipPath>
<g clip-path="url(#r)">
<rect width="61" height="20" fill="#555"/>
<rect x="61" width="35" height="20" fill="#97ca00"/>
<rect width="96" height="20" fill="url(#s)"/>
</g>
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110">
<text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text>
<text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text>
<text aria-hidden="true" x="775" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="250">99%</text>
<text x="775" y="140" transform="scale(.1)" fill="#fff" textLength="250">99%</text>
</g>
<script xmlns=""/>
</svg>

After

Width:  |  Height:  |  Size: 1.3 KiB

View File

@ -0,0 +1,13 @@
<svg xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink" width="96" height="20" role="img" aria-label="coverage: 99%">
<title>coverage: 99%</title>
<g shape-rendering="crispEdges">
<rect width="61" height="20" fill="#555"/>
<rect x="61" width="35" height="20" fill="#97ca00"/>
</g>
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110">
<text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text>
<text x="775" y="140" transform="scale(.1)" fill="#fff" textLength="250">99%</text>
</g>
<script xmlns=""/>
</svg>

After

Width:  |  Height:  |  Size: 712 B

View File

@ -0,0 +1,13 @@
<svg xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink" width="142.5" height="28" role="img" aria-label="COVERAGE: 99%">
<title>COVERAGE: 99%</title>
<g shape-rendering="crispEdges">
<rect width="91" height="28" fill="#555"/>
<rect x="91" width="51.5" height="28" fill="#97ca00"/>
</g>
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="100">
<text fill="#fff" x="455" y="175" transform="scale(.1)" textLength="670">COVERAGE</text>
<text fill="#fff" x="1167.5" y="175" font-weight="bold" transform="scale(.1)" textLength="275">99%</text>
</g>
<script xmlns=""/>
</svg>

After

Width:  |  Height:  |  Size: 739 B

View File

@ -0,0 +1,25 @@
<svg xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink" width="96" height="18" role="img" aria-label="coverage: 99%">
<title>coverage: 99%</title>
<linearGradient id="s" x2="0" y2="100%">
<stop offset="0" stop-color="#fff" stop-opacity=".7"/>
<stop offset=".1" stop-color="#aaa" stop-opacity=".1"/>
<stop offset=".9" stop-color="#000" stop-opacity=".3"/>
<stop offset="1" stop-color="#000" stop-opacity=".5"/>
</linearGradient>
<clipPath id="r">
<rect width="96" height="18" rx="4" fill="#fff"/>
</clipPath>
<g clip-path="url(#r)">
<rect width="61" height="18" fill="#555"/>
<rect x="61" width="35" height="18" fill="#97ca00"/>
<rect width="96" height="18" fill="url(#s)"/>
</g>
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110">
<text aria-hidden="true" x="315" y="140" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text>
<text x="315" y="130" transform="scale(.1)" fill="#fff" textLength="510">coverage</text>
<text aria-hidden="true" x="775" y="140" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="250">99%</text>
<text x="775" y="130" transform="scale(.1)" fill="#fff" textLength="250">99%</text>
</g>
<script xmlns=""/>
</svg>

After

Width:  |  Height:  |  Size: 1.4 KiB

View File

@ -0,0 +1,27 @@
<svg xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink" width="99" height="20" role="img" aria-label="Coverage: 99%">
<title>Coverage: 99%</title>
<style>a:hover #llink{fill:url(#b);stroke:#ccc}a:hover #rlink{fill:#4183c4}</style>
<linearGradient id="a" x2="0" y2="100%">
<stop offset="0" stop-color="#fcfcfc" stop-opacity="0"/>
<stop offset="1" stop-opacity=".1"/>
</linearGradient>
<linearGradient id="b" x2="0" y2="100%">
<stop offset="0" stop-color="#ccc" stop-opacity=".1"/>
<stop offset="1" stop-opacity=".1"/>
</linearGradient>
<g stroke="#d5d5d5">
<rect stroke="none" fill="#fcfcfc" x="0.5" y="0.5" width="61" height="19" rx="2"/>
<rect x="67.5" y="0.5" width="31" height="19" rx="2" fill="#fafafa"/>
<rect x="67" y="7.5" width="0.5" height="5" stroke="#fafafa"/>
<path d="M67.5 6.5 l-3 3v1 l3 3" stroke="d5d5d5" fill="#fafafa"/>
</g>
<g aria-hidden="true" fill="#333" text-anchor="middle" font-family="Helvetica Neue,Helvetica,Arial,sans-serif" text-rendering="geometricPrecision" font-weight="700" font-size="110px" line-height="14px">
<rect id="llink" stroke="#d5d5d5" fill="url(#a)" x=".5" y=".5" width="61" height="19" rx="2"/>
<text aria-hidden="true" x="305" y="150" fill="#fff" transform="scale(.1)" textLength="510">Coverage</text>
<text x="305" y="140" transform="scale(.1)" textLength="510">Coverage</text>
<text aria-hidden="true" x="825" y="150" fill="#fff" transform="scale(.1)" textLength="230">99%</text>
<text id="rlink" x="825" y="140" transform="scale(.1)" textLength="230">99%</text>
</g>
<script xmlns=""/>
</svg>

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

@ -3,11 +3,14 @@ requires = ["maturin>=0.14,<0.15"]
build-backend = "maturin" build-backend = "maturin"
[project] # The rust bindings [project] # The rust bindings
name = "xiv_craft_solver" name = "xiv_csolver_lib"
requires-python = ">=3.7" requires-python = ">=3.7"
version = "0.1.5" version = "0.1.8"
classifiers = [ classifiers = [
"Programming Language :: Rust", "Programming Language :: Rust",
"Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy", "Programming Language :: Python :: Implementation :: PyPy",
] ]
[tool.maturin]
features = ["pyo3/extension-module"]

View File

@ -8,8 +8,8 @@ classifiers =
[options] [options]
packages = packages =
ffcraft_solver xiv_csolver
ffcraft_solver.modules xiv_csolver.modules
install_requires = install_requires =
pyyaml>=6.0 pyyaml>=6.0
python_requires = >=3.9 python_requires = >=3.9
@ -21,7 +21,7 @@ zip_safe = no
[options.packages.find] [options.packages.find]
where = where =
= src = src
= src/ffcraft_solver = src/xiv_csolver
[options.extras_require] [options.extras_require]
testing = testing =

View File

@ -3,13 +3,13 @@ requires = ["setuptools>=42.0", "wheel"]
build-backend = "setuptools.build_meta" build-backend = "setuptools.build_meta"
[project] # The Python GUI [project] # The Python GUI
name = "ffcraft_solver" name = "xiv_csolver"
authors = [ authors = [
{name="Vkyfox"}, {name="Vkyfox"},
{name="Dandaedre"}, {name="Dandaedre"},
] ]
requires-python = ">=3.7" requires-python = ">=3.7"
version = "0.1.5" version = "0.1.8"
license = {text="Mozilla Public License Version 2.0"} license = {text="Mozilla Public License Version 2.0"}
classifiers = [ classifiers = [
"Programming Language :: Rust", "Programming Language :: Rust",
@ -18,7 +18,7 @@ classifiers = [
] ]
[tool.pytest.ini_options] [tool.pytest.ini_options]
addopts = "--cov=ffcraft_solver" addopts = "--cov=xiv_csolver"
testpaths = [ testpaths = [
"tests", "tests",
] ]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 248 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 352 KiB

View File

@ -1,4 +1,4 @@
""" """
A rust program for solving FFXIV craft recipe. A rust program for solving FFXIV craft recipe.
- ffcraft_solver - xiv_csolver
""" """

View File

@ -1,8 +1,6 @@
import time import re
import dearpygui.dearpygui as dpg import dearpygui.dearpygui as dpg
from ffcraft_solver.modules import loader, log, solver from xiv_csolver.modules import loader, log, solver, printer
import rich
class User: class User:
@ -110,6 +108,22 @@ class User:
dpg.set_value(user_stats, [self.initial_craftsmanship, self.initial_control, self.initial_cp]) dpg.set_value(user_stats, [self.initial_craftsmanship, self.initial_control, self.initial_cp])
return self.name return self.name
@staticmethod
def save_users() -> True:
if dpg.get_value(save_user_as) == '':
loggers.add_log('Cannot save user without a name.')
elif re.search(r'^\s+$', dpg.get_value(save_user_as)):
loggers.add_log('Name cannot be only whitespaces.')
elif re.search(r'^\s.+', dpg.get_value(save_user_as)):
loggers.add_log('Name cannot start with a whitespace.')
elif re.search(r'\s$', dpg.get_value(save_user_as)):
loggers.add_log('Name cannot end with a whitespace.')
else:
saver.save_users(dpg.get_value(save_user_as), dpg.get_value(user_stats))
loggers.add_log('User saved!')
dpg.configure_item('user_combo', items=full_config.get_users_names())
return True
class Recipe: class Recipe:
name = ' ' name = ' '
@ -122,7 +136,7 @@ class Recipe:
progress_extra_difficulty = 0 progress_extra_difficulty = 0
def refresh_gui(self): def refresh_gui(self):
dpg.set_value(recipe_stats, self.get_recipe_stats()[0:3]) dpg.set_value(basic_recipe_stats, self.get_recipe_stats()[0:3])
dpg.set_value(advanced_recipe_stats, self.get_recipe_stats()[3:7]) dpg.set_value(advanced_recipe_stats, self.get_recipe_stats()[3:7])
if self.name != ' ': if self.name != ' ':
dpg.set_value(save_recipe_as, self.name) dpg.set_value(save_recipe_as, self.name)
@ -133,11 +147,11 @@ class Recipe:
stats = [0, 0, 0] stats = [0, 0, 0]
advanced_stats = [0, 0, 0, 0] advanced_stats = [0, 0, 0, 0]
if tag == 'recipe_tooltip': if tag == 'basic_recipe_stats':
stats = app_data stats = app_data
advanced_stats = dpg.get_value(advanced_recipe_stats) advanced_stats = dpg.get_value(advanced_recipe_stats)
elif tag == 'advanced_recipe_tooltip': elif tag == 'advanced_recipe_stats':
stats = dpg.get_value(recipe_stats) stats = dpg.get_value(basic_recipe_stats)
advanced_stats = app_data advanced_stats = app_data
elif tag == 0: elif tag == 0:
stats = [app_data[0], app_data[1], app_data[2]] stats = [app_data[0], app_data[1], app_data[2]]
@ -169,6 +183,22 @@ class Recipe:
def get_recipe_name(self) -> str: def get_recipe_name(self) -> str:
return self.name return self.name
@staticmethod
def save_recipe() -> True:
if dpg.get_value(save_recipe_as) == '':
loggers.add_log('Cannot save recipe without a name.')
elif re.search(r'^\s+$', dpg.get_value(save_recipe_as)):
loggers.add_log('Name cannot be only whitespaces.')
elif re.search(r'^\s.+', dpg.get_value(save_recipe_as)):
loggers.add_log('Name cannot start with a whitespace.')
elif re.search(r'\s$', dpg.get_value(save_recipe_as)):
loggers.add_log('Name cannot end with a whitespace.')
else:
saver.save_recipe(dpg.get_value(save_recipe_as), dpg.get_value(basic_recipe_stats), dpg.get_value(advanced_recipe_stats))
loggers.add_log('Recipe saved!')
dpg.configure_item('recipe_combo', items=full_config.get_recipes_names())
return True
class Solution: class Solution:
def __init__(self, title, logger): def __init__(self, title, logger):
@ -238,10 +268,12 @@ if __name__ == '__main__':
pots_names = full_config.get_pots_names() pots_names = full_config.get_pots_names()
recipe_names = full_config.get_recipes_names() recipe_names = full_config.get_recipes_names()
saver = printer.Printer(full_config)
# Start of GUI drawing # Start of GUI drawing
# CHARACTER # CHARACTER
dpg.add_text("Character") dpg.add_text("Character")
user_combo = dpg.add_combo(items=characters_names, label="Your character", callback=user.set_name_combo) user_combo = dpg.add_combo(tag='user_combo', items=characters_names, label="Your character", callback=user.set_name_combo)
dpg.set_value(user_combo, ' ') dpg.set_value(user_combo, ' ')
# TODO: Load 1rst user in users.yaml by default # TODO: Load 1rst user in users.yaml by default
user_stats = dpg.add_input_intx(size=3, label="Stats", tag="stats_tooltip", callback=user.set_initial_stats) user_stats = dpg.add_input_intx(size=3, label="Stats", tag="stats_tooltip", callback=user.set_initial_stats)
@ -249,8 +281,8 @@ if __name__ == '__main__':
dpg.add_text("Craftsmanship / Control / CP") dpg.add_text("Craftsmanship / Control / CP")
with dpg.group(horizontal=True): with dpg.group(horizontal=True):
save_user_as = dpg.add_input_text(hint='Save as...') save_user_as = dpg.add_input_text(hint='Save as...')
dpg.add_button(label="Save!") # TODO: make it so field is not cleared at every input in stats
# TODO: Can't save if value == ' ' dpg.add_button(label="Save!", callback=user.save_users)
# EFFECTIVE STATS # EFFECTIVE STATS
dpg.add_separator() dpg.add_separator()
@ -264,24 +296,25 @@ if __name__ == '__main__':
food_combo = dpg.add_combo(items=foods_names, label="Food", callback=user.set_food) 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) pot_combo = dpg.add_combo(items=pots_names, label="Pot", callback=user.set_pot)
specialist_checkbox = dpg.add_checkbox(label="Specialist", tag="specialist", callback=user.set_specialist) specialist_checkbox = dpg.add_checkbox(label="Specialist", tag="specialist", callback=user.set_specialist)
# TODO : possibility to add new food/pots without manually adding them to the config files
# RECIPE # RECIPE
dpg.add_separator() dpg.add_separator()
dpg.add_text("Recipe") dpg.add_text("Recipe")
recipe_combo = dpg.add_combo(items=recipe_names, label="Recipe", callback=recipe.set_recipe_name) recipe_combo = dpg.add_combo(items=recipe_names, tag='recipe_combo', label="Recipe", callback=recipe.set_recipe_name)
dpg.set_value(recipe_combo, " ") dpg.set_value(recipe_combo, " ")
recipe_stats = dpg.add_input_intx(size=3, label="Stats", tag="recipe_tooltip", callback=recipe.set_recipe_stats) basic_recipe_stats = dpg.add_input_intx(size=3, label="Stats", tag="basic_recipe_stats", callback=recipe.set_recipe_stats)
with dpg.tooltip("recipe_tooltip"): with dpg.tooltip("basic_recipe_stats"):
dpg.add_text("Progress / Quality / Durability") dpg.add_text("Progress / Quality / Durability")
advanced_recipe_stats = dpg.add_input_intx( advanced_recipe_stats = dpg.add_input_intx(
size=4, label="Advanced stats", tag="advanced_recipe_tooltip", callback=recipe.set_recipe_stats size=4, label="Advanced stats", tag="advanced_recipe_stats", callback=recipe.set_recipe_stats
) )
with dpg.tooltip("advanced_recipe_tooltip"): with dpg.tooltip("advanced_recipe_stats"):
dpg.add_text("Progress / Quality difficulty // Progress / Quality extra difficulty") dpg.add_text("Progress / Quality difficulty // Progress / Quality extra difficulty")
# TODO: add a log if recipe matches a known recipe # TODO: add a log if recipe matches a known recipe
with dpg.group(horizontal=True): with dpg.group(horizontal=True):
save_recipe_as = dpg.add_input_text(hint='Save as...') save_recipe_as = dpg.add_input_text(hint='Save as...')
dpg.add_button(label="Save!", callback=request_solve) dpg.add_button(label="Save!", callback=recipe.save_recipe)
# TODO: Can't save if value == ' ' # TODO: Can't save if value == ' '
# SOLVE # SOLVE

View File

@ -2,7 +2,11 @@
# as can be found on other solver websites, such as https://yyyy.games/crafter/index.html#/simulator and checking custom recipe. # as can be found on other solver websites, such as https://yyyy.games/crafter/index.html#/simulator and checking custom recipe.
# The language option is the second menu to the left from the top-right hand corner. # The language option is the second menu to the left from the top-right hand corner.
# If this seems super convoluted, and you'd rather it was just the three in-game values, know that me too. # If this seems super convoluted, and you'd rather it was just the three in-game values, know that me too.
# Unfortunately that is how Square Enix chose to make crafting work in FFXIV. # Unfortunately that is how the craft system works in FFXIV.
Grade 7 Tincture of Strength: [5060, 12628, 70, 130, 115, 80, 70] Lvl88: [1650, 7000, 40, 128, 112, 100, 100]
Grade 5 Strength Alkahest: [1300, 6200, 40, 123, 107, 100, 100] Patch6.3_precrafts: [3696, 8200, 35, 130, 115, 80, 70]
Patch6.3_gear: [5060, 12628, 70, 130, 115, 80, 70]
Patch6.3_gatherer: [5720, 12900, 70, 130, 115, 80, 70]
Patch6.4_precrafts: [4488, 9090, 35, 130, 115, 80, 70]
Patch6.4_gear: [6600, 14040, 70, 130, 115, 80, 70]

View File

@ -3,6 +3,6 @@
# different gear or melds. # different gear or melds.
# The top line will always be selected by default # The top line will always be selected by default
Vicky Crosia: [4021, 3933, 587]
Dandaedre Zadiel: [0, 0, 0] Vicky Crosia: [4021, 3987, 601]
Sekundes Dullahan: [2566, 2443, 522] Ladisla Kociann: [4021, 3951, 580]

View File

@ -1,10 +1,10 @@
import xiv_craft_solver import xiv_csolver_lib
import rich import rich
rich.inspect(xiv_craft_solver) rich.inspect(xiv_csolver_lib)
rich.inspect(xiv_craft_solver.test_result) rich.inspect(xiv_csolver_lib.test_result())
rich.inspect(xiv_craft_solver.test_result()) rich.inspect(xiv_csolver_lib.test_info())
rich.inspect(xiv_craft_solver.test_result()) rich.inspect(xiv_csolver_lib.test_final_results())
class FeedMeDaddy: class FeedMeDaddy:
@ -28,5 +28,5 @@ class FeedMeDaddy:
el_daddy = FeedMeDaddy() el_daddy = FeedMeDaddy()
rich.inspect(xiv_craft_solver.solve_from_python(el_daddy)) rich.inspect(xiv_csolver_lib.solve_from_python(el_daddy))

View File

@ -1,17 +1,21 @@
import rich
import yaml import yaml
import os import os
from ffcraft_solver.modules import log from xiv_csolver.modules import log
class DefaultConfig: class DefaultConfig:
yaml_user = 'configs/users.yaml' yaml_dir = 'configs/'
yaml_consumable = 'configs/consumables.yaml' yaml_user = yaml_dir + 'users.yaml'
yaml_recipes = 'configs/recipes.yaml' yaml_consumable = yaml_dir + 'consumables.yaml'
yaml_recipes = yaml_dir + 'recipes.yaml'
class Loader: class Loader:
# TODO: create folder/file if missing when clicking "save" # TODO: create folder/file if missing when clicking "save"
# TODO: log any missing file(s) or the whole folder # TODO: log any missing file(s) or the whole folder
# TODO: find a way to log at initialization
# TODO: except ParserError and handle it
def __init__(self, loggers: log.Loggers): def __init__(self, loggers: log.Loggers):
self.loggers = loggers self.loggers = loggers
self.user_list = {' ': [0, 0, 0]} self.user_list = {' ': [0, 0, 0]}
@ -20,32 +24,53 @@ class Loader:
self.recipes_list = {' ': [0, 0, 0, 0, 0, 0, 0]} self.recipes_list = {' ': [0, 0, 0, 0, 0, 0, 0]}
self.config = DefaultConfig() self.config = DefaultConfig()
if not os.path.exists(self.relative_import(self.config.yaml_dir)):
os.mkdir(self.relative_import(self.config.yaml_dir))
try: try:
with open(self.relative_import(self.config.yaml_user), 'r') as file: with open(self.relative_import(self.config.yaml_user), 'r') as file:
self.user_list.update(yaml.safe_load(file)) loaded_file = yaml.safe_load(file)
if loaded_file:
self.user_list.update(loaded_file)
except FileNotFoundError as e: except FileNotFoundError as e:
self.loggers.add_log(e) print(e)
# self.loggers.add_log(f'File {self.config.yaml_user} not found.')
print(f'File {self.config.yaml_user} not found.')
print(f'Creating {self.config.yaml_user}.')
with open(self.relative_import(self.config.yaml_user), 'w+') as _:
pass
try: try:
with open(self.relative_import(self.config.yaml_consumable), 'r') as file: with open(self.relative_import(self.config.yaml_consumable), 'r') as file:
if loaded_file:
loaded_file = yaml.safe_load(file) loaded_file = yaml.safe_load(file)
self.foods_list.update(loaded_file['Foods']) self.foods_list.update(loaded_file['Foods'])
self.pots_list.update(loaded_file['Pots']) self.pots_list.update(loaded_file['Pots'])
except FileNotFoundError as e: except FileNotFoundError as e:
self.loggers.add_log(e) print(e)
# self.loggers.add_log(f'File {self.config.yaml_consumable} not found.')
print(f'File {self.config.yaml_consumable} not found.')
print(f'Creating {self.config.yaml_consumable}.')
with open(self.relative_import(self.config.yaml_consumable), 'w+') as _:
pass
try: try:
with open(self.relative_import(self.config.yaml_recipes), 'r') as file: with open(self.relative_import(self.config.yaml_recipes), 'r') as file:
self.recipes_list.update(yaml.safe_load(file)) loaded_file = yaml.safe_load(file)
if loaded_file:
self.recipes_list.update(loaded_file)
except (FileNotFoundError, IsADirectoryError) as e: except (FileNotFoundError, IsADirectoryError) as e:
self.loggers.add_log(e) print(e)
# self.loggers.add_log(f'File {self.config.yaml_recipes} not found.')
print(f'File {self.config.yaml_recipes} not found.')
print(f'Creating {self.config.yaml_recipes}.')
with open(self.relative_import(self.config.yaml_recipes), 'w+') as _:
pass
@staticmethod @staticmethod
def relative_import(path): def relative_import(path):
return os.path.normpath(os.path.join(__file__, "../..", path)) return os.path.normpath(os.path.join(__file__, "../..", path))
def get_users_dict(self) -> dict: def get_users_dict(self) -> dict:
self.loggers.add_log('Loaded user dictionary from users.yaml')
return self.user_list return self.user_list
def get_users_names(self) -> list: def get_users_names(self) -> list:

View File

@ -3,12 +3,9 @@ import dearpygui.dearpygui as dpg
class Loggers: class Loggers:
def __init__(self, log=None): def __init__(self):
timestamp = self.get_timestamp() timestamp = self.get_timestamp()
if not log:
self.log = f"{timestamp} Log initialised." self.log = f"{timestamp} Log initialised."
else:
self.log = log
def add_log(self, other: str) -> str: def add_log(self, other: str) -> str:
timestamp = self.get_timestamp() timestamp = self.get_timestamp()

View File

@ -0,0 +1,77 @@
from xiv_csolver.modules import loader
class Printer:
def __init__(self, full_config: loader.Loader):
self.full_config = full_config
self.help_text_dict = {
'users': '''# Name: [Craftsmanship, control, cp]
# You are encouraged to use this either for multiple characters if you have them, or different jobs having
# different gear or melds.
# The top line will always be selected by default
''',
'foods': '''Foods:
# Name: [[Bonus craftsmanship%, max value], [bonus control%, max value], [bonus cp%, max value]]
# For example, Calamari Ripieni HQ gives 5% craftsmanship up to a maximum of 120, and 26% CP up to a
# maximum of 82, and is hence noted as:
# Calamari Ripieni HQ: [[5, 120], [0, 0], [26, 82]]
#
# Here is your template to copy/paste and fill in:
# Name: [[0, 0], [0, 0], [0, 0]]''',
'pots': ''' # Same as above:
# Name: [[Bonus craftsmanship%, max value], [bonus control%, max value], [bonus cp%, max value]]
# For example, Cunning Craftsman's Draught HQ gives 6% CP up to a maximum of 21, and is hence noted as:
# Cunning Craftsman's Draught HQ: [[0, 0], [0, 0], [6, 21]]
#
# Here is your template to copy/paste and fill in:
# Name: [[0, 0], [0, 0], [0, 0]]''',
'recipe': '''# Name: [Progress, quality, durability, progress difficulty, quality difficulty, extra progress difficulty, extra quality difficulty]
# as can be found on other solver websites, such as https://yyyy.games/crafter/index.html#/simulator and checking custom recipe.
# The language option is the second menu to the left from the top-right hand corner.
# If this seems super convoluted, and you'd rather it was just the three in-game values, know that me too.
# Unfortunately that is how the craft system works in FFXIV.'''
}
def save_users(self, user_name: str = None, user_stats: list = None) -> dict:
output = self.help_text_dict['users'] + '\r\n\r\n'
if user_name.title() == '':
for user, stats in self.full_config.get_users_dict().items():
if user != ' ':
output += f'{user}: [{stats[0]}, {stats[1]}, {stats[2]}]\r\n'
else:
self.full_config.get_users_dict()[user_name] = user_stats
for user, stats in self.full_config.get_users_dict().items():
if user != ' ':
output += f'{user}: [{stats[0]}, {stats[1]}, {stats[2]}]\r\n'
self.print_users(output)
return self.full_config.get_users_dict()
def print_users(self, output: str) -> True:
with open(self.full_config.relative_import(self.full_config.config.yaml_user), 'w') as file:
file.write(output)
return True
def save_recipe(self, recipe_name: str = None, recipe_basic_stats: list = None, recipe_advanced_stats: list = None) -> dict:
output = self.help_text_dict['recipe'] + '\r\n\r\n'
if recipe_name.title() == '':
for recipe, stats in self.full_config.get_recipes_dict().items():
if recipe != ' ':
output += f'{recipe}: [{stats[0]}, {stats[1]}, {stats[2]}, {stats[3]}, {stats[4]}, {stats[5]}, {stats[6]}]\r\n'
else:
self.full_config.get_recipes_dict()[recipe_name] = recipe_basic_stats[:-1] + recipe_advanced_stats
for recipe, stats in self.full_config.get_recipes_dict().items():
if recipe != ' ':
output += f'{recipe}: [{stats[0]}, {stats[1]}, {stats[2]}, {stats[3]}, {stats[4]}, {stats[5]}, {stats[6]}]\r\n'
self.print_recipe(output)
return self.full_config.get_recipes_dict()
def print_recipe(self, output) -> True:
with open(self.full_config.relative_import(self.full_config.config.yaml_recipes), 'w') as file:
file.write(output)
return True

View File

@ -1,7 +1,7 @@
import rich import rich
import xiv_craft_solver as xcs import xiv_csolver_lib as xcs
from ffcraft_solver.__main__ import User, Recipe from xiv_csolver.__main__ import User, Recipe
from ffcraft_solver.modules import log, translator from xiv_csolver.modules import log, translator
class Result: class Result:
@ -50,7 +50,7 @@ Remaining CP: {self.remaining_cp}"""
saved_lines.append(line) saved_lines.append(line)
for line in saved_lines: for line in saved_lines:
justified_text += line + '\n' justified_text += line + '\r\n'
return justified_text[:-1] return justified_text[:-1]
@ -67,8 +67,9 @@ Remaining CP: {self.remaining_cp}"""
if self.steps != 15 and self.steps != 29 and self.steps != 44: if self.steps != 15 and self.steps != 29 and self.steps != 44:
saved_lines.append('/echo Craft complete ! <se.3>') saved_lines.append('/echo Craft complete ! <se.3>')
else: # else:
self.loggers.log(f'No completion message in macro because rotation is exactly {self.steps} steps.') # TODO: Add a callback to the parent object for logging
# self.loggers.add_log(f'No completion message in macro because rotation is exactly {self.steps} steps.')
if self.steps > 15: if self.steps > 15:
saved_lines.insert(14, '/echo Macro 1 complete <se.2>') saved_lines.insert(14, '/echo Macro 1 complete <se.2>')
@ -81,11 +82,11 @@ Remaining CP: {self.remaining_cp}"""
for line in saved_lines: for line in saved_lines:
count += 1 count += 1
if count < 16: if count < 16:
self.macro1 += line + '\n' self.macro1 += line + '\r\n'
elif 15 < count < 31: elif 15 < count < 31:
self.macro2 += line + '\n' self.macro2 += line + '\r\n'
elif 30 < count < 46: elif 30 < count < 46:
self.macro3 += line + '\n' self.macro3 += line + '\r\n'
self.macro1 = self.macro1[:-1] self.macro1 = self.macro1[:-1]
self.macro2 = self.macro2[:-1] self.macro2 = self.macro2[:-1]
@ -116,6 +117,7 @@ class Solver:
self.loggers = loggers self.loggers = loggers
self.solutions = [] self.solutions = []
self.info = None
self.best_quality = None self.best_quality = None
self.least_steps = None self.least_steps = None
self.safe_50 = None self.safe_50 = None
@ -124,8 +126,8 @@ class Solver:
self.compute_all() self.compute_all()
def solve(self) -> str: def solve(self) -> str:
self.solutions = xcs.solve_from_python(self) self.solutions,self.info = xcs.solve_from_python(self)
return xcs.solve_from_python(self) return self.solutions
def compute_all(self) -> True: def compute_all(self) -> True:
if self.solutions: if self.solutions:
@ -149,19 +151,19 @@ class Solver:
if s.quality > threshold: if s.quality > threshold:
self.safe_50 = Result(s, 'Safe 50') self.safe_50 = Result(s, 'Safe 50')
done = True done = True
else:
break
if not done: if not done:
self.loggers.add_log('Could not find a rotation for a 50% Safe Margin.\n' self.loggers.add_log('Could not find a rotation for a 50% Safe Margin.\r\n'
' Defaulting to Best Quality.') ' Defaulting to Best Quality.')
self.safe_50 = self.best_quality self.safe_50 = self.best_quality
# self.safe_50 = Result(self.solutions[round(len(self.solutions)/2)+1], 'Safe 50') # old version
return self.safe_50 return self.safe_50
def compute_least_steps(self) -> Result: def compute_least_steps(self) -> Result:
least_steps = 100 least_steps = 100
output = None output = None
if self.solutions:
for e in self.solutions: for e in self.solutions:
if e.steps < least_steps: if e.steps < least_steps:
least_steps = e.steps least_steps = e.steps
@ -169,5 +171,3 @@ class Solver:
self.least_steps = Result(output, 'Least steps') self.least_steps = Result(output, 'Least steps')
return self.least_steps return self.least_steps

View File

@ -1,4 +1,4 @@
from ffcraft_solver.modules import log from xiv_csolver.modules import log
loggers = log.Loggers loggers = log.Loggers
@ -48,7 +48,7 @@ def translate_list(actions: list, lang: str):
output.append(dictionary[action]) output.append(dictionary[action])
except KeyError: except KeyError:
output.append(supported_languages["en"][action]) output.append(supported_languages["en"][action])
loggers.log('Translation not found. Defaulting to English.\n' loggers.log('Translation not found. Defaulting to English.\r\n'
' Macros will probably be broken because of this.') ' Macros will probably be broken because of this.')
else: else:

View File

Before

Width:  |  Height:  |  Size: 248 KiB

After

Width:  |  Height:  |  Size: 248 KiB

View File

Before

Width:  |  Height:  |  Size: 352 KiB

After

Width:  |  Height:  |  Size: 352 KiB

View File

@ -1,29 +0,0 @@
[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

1
rustfmt.toml Normal file
View File

@ -0,0 +1 @@
reorder_imports = true

View File

@ -1,24 +1,54 @@
//! Module containing all actions that a crafter can execute
//!
//! All actions are defined as Action, containing all methods to actively use it in a craft
//! while ActionBuilder is used only initally as a lazy_static setup
use crate::craft::Craft; use crate::craft::Craft;
use crate::specs::{Buff, Success}; use crate::specs::{Buff, Success};
use lazy_static::lazy_static; use lazy_static::lazy_static;
#[allow(dead_code)]
use std::fmt::Debug; use std::fmt::Debug;
/// Hold an action for the solver to try using
///
/// It will be used heavily to try/discard actions durin craft
pub struct Action { pub struct Action {
/// The action name, in a human readable format, it will be used to generate a short_name
pub name: String, pub name: String,
/// The natural durability cost, without buff or reductions
pub dur: u32, pub dur: u32,
/// The cost in cp
pub cp: u32, pub cp: u32,
/// The amount of progression provided in percent (not the actual value added to the craft)
pub progress: u32, pub progress: u32,
/// The amount of quality provided in percent (not the acual value added to the craft)
pub quality: u32, pub quality: u32,
/// The name of the buff given, if any
pub buff: Option<(Buff, u8)>, pub buff: Option<(Buff, u8)>,
/// The short name of the action, as used by most crafting simulator (aka: stripped of whitespace)
pub short_name: String, pub short_name: String,
} }
/// Builds an action based on an action
///
/// Made to initialize lazy_static and nothing more
pub struct ActionBuilder { pub struct ActionBuilder {
action: Action, action: Action,
} }
impl ActionBuilder { impl ActionBuilder {
/// Base creator, takes a name and initialize an empty action with the short_name
/// and name setup and default values for all other fields
///
/// # Examples
/// ```
/// use xiv_csolver_lib::action::ActionBuilder;
/// use xiv_csolver_lib::specs::Buff;
/// ActionBuilder::new("Muscle Memory")
/// .cp(6)
/// .progress(300)
/// .buff(Some((Buff::MuscleMemory, 5)))
/// .build();
/// ```
pub fn new(name: &str) -> Self { pub fn new(name: &str) -> Self {
let mut short_name = name.to_string(); let mut short_name = name.to_string();
short_name = short_name.replace("II", "2"); short_name = short_name.replace("II", "2");
@ -46,31 +76,46 @@ impl ActionBuilder {
}, },
} }
} }
/// Changes the durability consumption of an action
pub fn dur(mut self, dur: u32) -> Self { pub fn dur(mut self, dur: u32) -> Self {
self.action.dur = dur; self.action.dur = dur;
self self
} }
/// Changes the crafting points (cp) consumption of an action
pub fn cp(mut self, cp: u32) -> Self { pub fn cp(mut self, cp: u32) -> Self {
self.action.cp = cp; self.action.cp = cp;
self self
} }
/// Changes the amount of progress of an action
pub fn progress(mut self, progress: u32) -> Self { pub fn progress(mut self, progress: u32) -> Self {
self.action.progress = progress; self.action.progress = progress;
self self
} }
/// Changes the amount of quality of an action
pub fn quality(mut self, quality: u32) -> Self { pub fn quality(mut self, quality: u32) -> Self {
self.action.quality = quality; self.action.quality = quality;
self self
} }
/// Makes an action add a buff for certain number of actions
/// The buffs available are defined in [specs.rs](crate::specs::Buff)
///
/// ``
/// (self.recipe.progress as f32 - self.progression as f32) / self.get_base_progression() as f32;
/// ``
pub fn buff(mut self, buff: Option<(Buff, u8)>) -> Self { pub fn buff(mut self, buff: Option<(Buff, u8)>) -> Self {
self.action.buff = buff; self.action.buff = buff;
self self
} }
/// Finalize the usage of the ActionBuilder and return the action
/// Once again, all this is for the usage of lazy_static
pub fn build(self) -> Action { pub fn build(self) -> Action {
self.action self.action
} }
} }
/// Custom implementation of the equality operator, it is used to compare actions during the
/// the crafting process
impl PartialEq for Action { impl PartialEq for Action {
fn eq(&self, other: &Self) -> bool { fn eq(&self, other: &Self) -> bool {
self.cp == other.cp self.cp == other.cp
@ -80,10 +125,14 @@ impl PartialEq for Action {
} }
} }
/// A craft action, after compilation (with lazy_static)
// no other actions should be created
impl Action { impl Action {
/// Get the printable name of the action
pub fn get_name(&self) -> String { pub fn get_name(&self) -> String {
self.name.clone() self.name.clone()
} }
/// Get the CP cost, reduced by the eventual chain buffs currently active in the craft
pub fn get_cp_cost(&self, _craft: &Craft) -> u32 { pub fn get_cp_cost(&self, _craft: &Craft) -> u32 {
if self == &ACTIONS.standard_touch && _craft.buffs.basic_touch > 0 { if self == &ACTIONS.standard_touch && _craft.buffs.basic_touch > 0 {
return 18; return 18;
@ -93,9 +142,12 @@ impl Action {
}; };
self.cp self.cp
} }
pub fn get_durability_cost(&self, _craft: &Craft) -> u32 { /// Get the durability cost this action would have if used at this stage of the craft
/// This method accounts for the effects of **master mend** and **waste not**.
/// Note that not using i32 for durability from scratch is a desing choice
pub fn get_durability_cost(&self, _craft: &Craft) -> i32 {
if self == &ACTIONS.masters_mend { if self == &ACTIONS.masters_mend {
return 30; return -30;
} }
if self.dur == 0 || self.progress == 0 && self.quality == 0 { if self.dur == 0 || self.progress == 0 && self.quality == 0 {
return 0; return 0;
@ -107,8 +159,16 @@ impl Action {
if dur < 5 { if dur < 5 {
dur = 5; dur = 5;
} }
dur dur as i32
} }
/// Get the progress effect this action would have if used at this stage of the craft
/// This method accounts for the effects of **groundwork** under 20 durability,
/// and the effects of **veneration** and **muscle memory**
/// # Exemple
/// ```md
/// - Groundwork will return 200 if the durability remaining is above 20
/// - Basic Synthesis will return 100 if no buffs are up and 150 with veneration
/// ```
pub fn get_progress(&self, _craft: &Craft) -> u32 { pub fn get_progress(&self, _craft: &Craft) -> u32 {
let mut prog = self.progress as f64; let mut prog = self.progress as f64;
if self.dur == 20 && _craft.durability < self.get_durability_cost(_craft) as i32 { if self.dur == 20 && _craft.durability < self.get_durability_cost(_craft) as i32 {
@ -123,6 +183,9 @@ impl Action {
} }
(prog * mult).floor() as u32 (prog * mult).floor() as u32
} }
/// Get the quality effect this action would have if used at this stage of the craft.
/// This method account for the **inner quiet** stacking effect, **innovation** and **great strides**
pub fn get_quality(&self, _craft: &Craft) -> u32 { pub fn get_quality(&self, _craft: &Craft) -> u32 {
let mut qual = self.quality as f64; let mut qual = self.quality as f64;
if self == &ACTIONS.byregot_blessing { if self == &ACTIONS.byregot_blessing {
@ -141,9 +204,19 @@ impl Action {
let iq_mult = (_craft.buffs.inner_quiet as f64 * 0.1) + 1.0; let iq_mult = (_craft.buffs.inner_quiet as f64 * 0.1) + 1.0;
(qual * mult * iq_mult).floor() as u32 (qual * mult * iq_mult).floor() as u32
} }
/// Returns the Buff (if any) up at this time of the craft
pub fn get_buff(&self) -> Option<(Buff, u8)> { pub fn get_buff(&self) -> Option<(Buff, u8)> {
self.buff self.buff
} }
/// Returns a bool representing if this action **can** be used, note that this does only account
/// for the game limitations and not viability limitation
///
/// # Improvements
/// This function could easily prune useless actions by considering them not available.
/// Doing so could stop early refresh of buffs and spam of observe and such.
/// However some of such "optimisations" could just plain hurt the craft by forbidding a *seemingly*
/// useless action. The "bruteforce" method being easily computatble on a modern computer, such
/// optimisations arent warrented and left to aother time.
pub fn can_use(&self, _craft: &Craft) -> bool { pub fn can_use(&self, _craft: &Craft) -> bool {
if self.get_cp_cost(_craft) > _craft.cp as u32 { if self.get_cp_cost(_craft) > _craft.cp as u32 {
return false; return false;
@ -170,32 +243,110 @@ impl Debug for Action {
} }
} }
/// The callable actionlist, to be used in conjunction with lazy_static
pub struct ActionList { pub struct ActionList {
/// Increases progress.
/// Efficiency: 300%
/// Success Rate: 100%
/// Additional Effect: Efficiency of your next Synthesis action is increased by 100%
/// Available only on the first step.
/// Additional effect is active for five steps.
pub muscle_memory: Action, pub muscle_memory: Action,
/// Increases quality.
/// Efficiency: 100%
/// Success Rate: 100%
/// Additional Effect: Increases Inner Quiet stack by one (up to 10)
/// Availabe only on the first step.
pub reflect: Action, pub reflect: Action,
/// Increases progress.
/// Efficiency: 120%
/// Success Rate: 100%
pub basic_synthesis: Action, pub basic_synthesis: Action,
/// Increases progress.
/// Efficiency: 120%
/// Success Rate: 100%
pub careful_synthesis: Action, pub careful_synthesis: Action,
/// Increases progress at greater cost to durability.
/// Efficiency decreases by half when durability is below durability cost.
/// Efficiency: 300%
/// Success Rate: 100%
/// Durability Cost: 20
pub groundwork: Action, pub groundwork: Action,
/// Increases progress at half the durability cost.
/// Efficiency: 180%
/// Success Rate: 100%
/// Unavailable when Waste Not or Waste Not II is active.
pub prudent_synthesis: Action, pub prudent_synthesis: Action,
/// Increases both progress and quality.
/// Efficiency: 100%
/// Success Rate: 100%
pub delicate_synthesis: Action, pub delicate_synthesis: Action,
/// Increases quality.
/// Efficiency: 100%
/// Success Rate: 100%
pub basic_touch: Action, pub basic_touch: Action,
/// Increases quality.
/// Efficiency: 125%
/// Success Rate: 100%
/// Combo action: Basic Touch
/// Combo bonus: CP cost reduced to 18
pub standard_touch: Action, pub standard_touch: Action,
/// Increases quality. Inner Quiet effect ends upon use.
/// Efficiency: 100% plus 20% for each count of your Inner Quiet stack, up to a maximum of 300%
/// Success Rate: 100%
/// Requires at least one stack of Inner Quiet.
pub byregot_blessing: Action, pub byregot_blessing: Action,
/// Increases quality at half the durability cost.
/// Efficiency: 100%
/// Success Rate: 100%
/// Unavailable when Waste Not or Waste Not II are active.
pub prudent_touch: Action, pub prudent_touch: Action,
/// Increases quality at a greater cost to durability.
/// Additional Effect: Increases Inner Quiet stack by one (up to 11)
/// Efficiency: 200%
/// Success Rate: 100%
/// Durability Cost: 20
pub preparatory_touch: Action, pub preparatory_touch: Action,
/// Increases quality.
/// Efficiency: 150%
/// Success Rate: 100%
/// Combo action: Standard Touch
/// Combo bonus: CP cost reduced to 18
pub advanced_touch: Action, pub advanced_touch: Action,
/// Increases quality at no cost to durability.
/// Efficiency: 100%
/// Success Rate: 100%
/// Available only when Inner Quiet stack size is 10.
pub trained_finesse: Action, pub trained_finesse: Action,
/// Restores item durability by 30.
pub masters_mend: Action, pub masters_mend: Action,
// Restores item durability by 60.
// pub masters_mend_2: Action,
/// Reduces loss of durability by 50% for the next four steps.
pub waste_not: Action, pub waste_not: Action,
/// Reduces loss of durability by 50% for the next eight steps.
pub waste_not_ii: Action, pub waste_not_ii: Action,
/// Restores 5 points of durability after each step for the next eight steps.
pub manipulation: Action, pub manipulation: Action,
/// Increases efficiency of Synthesis actions by 50% for the next four steps.
pub veneration: Action, pub veneration: Action,
/// Increases the efficiency of next Touch action by 100%.
/// Effect active for three steps.
pub great_strides: Action, pub great_strides: Action,
/// Increases efficiency of Touch actions by 50% for the next four steps.
pub innovation: Action, pub innovation: Action,
// Do nothing for one step.
//pub observe: Action, //pub observe: Action,
// Increases progress.
// Efficiency: 200%
// Success Rate: 50%
// Combo Action: Observe
// Combo Bonus: Increases success rate to 100%
//pub focused_synthesis: Action, //pub focused_synthesis: Action,
} }
/// Create all base actions as a default (for lazy_static)
impl Default for ActionList { impl Default for ActionList {
fn default() -> Self { fn default() -> Self {
Self { Self {
@ -268,6 +419,7 @@ impl Default for ActionList {
.build(), .build(),
masters_mend: ActionBuilder::new("Master's Mend").cp(88).build(), masters_mend: ActionBuilder::new("Master's Mend").cp(88).build(),
//masters_mend: ActionBuilder::new("Master's Mend").dur(-30).cp(88).build(),
waste_not: ActionBuilder::new("Waste Not") waste_not: ActionBuilder::new("Waste Not")
.cp(56) .cp(56)
.buff(Some((Buff::WasteNot, 4))) .buff(Some((Buff::WasteNot, 4)))
@ -300,5 +452,99 @@ impl Default for ActionList {
} }
lazy_static! { lazy_static! {
/// Initialize a static pseudo &Craft: ACTIONS
pub static ref ACTIONS: ActionList = ActionList::default(); pub static ref ACTIONS: ActionList = ActionList::default();
} }
#[cfg(test)]
mod test {
use crate::action::ACTIONS;
use pretty_assertions::assert_eq;
use strum::IntoEnumIterator;
#[test]
pub fn test_structs() {
let ac = crate::action::Action {
name: "Michel".to_string(),
dur: 0,
cp: 0,
progress: 0,
quality: 0,
buff: None,
short_name: "miguel".to_string(),
};
let ab = crate::action::ActionBuilder { action: ac };
let ba = crate::action::ActionBuilder::new(&"Basic Synthesis");
let _ = crate::action::ActionBuilder::new(&"Groundwork");
let cs = crate::action::ActionBuilder::new(&"Careful Synthesis");
ab.dur(10)
.cp(10)
.progress(10)
.quality(10)
.buff(None)
.build();
let act1 = ba.cp(10).dur(22).progress(33).quality(44).build();
let act2 = cs.cp(10).dur(22).progress(33).quality(44).build();
assert_eq!(act1, act2);
format!("{:?}", act1);
let _ = crate::action::ActionList::default();
}
#[test]
pub fn test_with_craft() {
let mut bbs = crate::specs::BuffState::default();
for buff in crate::specs::Buff::iter() {
bbs.apply(buff, 2);
}
let mut act1 = crate::action::ActionBuilder::new(&"Basic Synthesis")
.dur(22)
.cp(10)
.progress(100)
.quality(100)
.build();
let mut craft = crate::craft::Craft::default();
craft.buffs = bbs;
assert_eq!(act1.get_name(), "Basic Synthesis");
assert_eq!(act1.get_cp_cost(&craft), 10);
assert_eq!(act1.get_durability_cost(&craft), 11);
assert_eq!(act1.get_progress(&craft), 250);
assert_eq!(act1.get_quality(&craft), 300);
assert_eq!(act1.get_buff(), None);
assert!(act1.can_use(&craft));
assert_eq!(&ACTIONS.standard_touch.get_cp_cost(&craft), &18);
assert_eq!(&ACTIONS.advanced_touch.get_cp_cost(&craft), &18);
assert_eq!(&ACTIONS.masters_mend.get_durability_cost(&craft), &-30);
assert_eq!(&ACTIONS.byregot_blessing.get_quality(&craft), &420);
assert_eq!(&ACTIONS.byregot_blessing.can_use(&craft), &true);
assert_eq!(&ACTIONS.muscle_memory.can_use(&craft), &true);
assert_eq!(&ACTIONS.trained_finesse.can_use(&craft), &false);
assert_eq!(&ACTIONS.reflect.can_use(&craft), &true);
act1.progress = 0;
act1.quality = 0;
assert_eq!(act1.get_durability_cost(&craft), 0);
act1.dur = 0;
act1.progress = 100;
act1.quality = 100;
assert_eq!(act1.get_durability_cost(&craft), 0);
act1.dur = 20;
craft.durability = 10;
craft.buffs = crate::specs::BuffState::default();
assert_eq!(act1.get_progress(&craft), 50);
assert_eq!(act1.get_quality(&craft), 50);
act1.dur = 2;
assert_eq!(act1.get_durability_cost(&craft), 5);
craft.cp = 0;
assert_eq!(&ACTIONS.reflect.can_use(&craft), &false);
craft.cp = 100;
craft.success = crate::specs::Success::Failure;
assert_eq!(&ACTIONS.reflect.can_use(&craft), &false);
}
}

View File

@ -1,74 +0,0 @@
// #![warn(missing_docs,unsafe_code,unstable_features,)]
use clap::Parser;
use std::time::Instant;
use xiv_craft_solver;
#[derive(Debug)]
struct CustomError(String);
fn main() {
let args = xiv_craft_solver::io::Args::parse();
let params = xiv_craft_solver::io::Parameters::from_args(&args);
// Start timer
let now = Instant::now();
println!("Solving...");
// Solve from config
let (recipe, stats) = xiv_craft_solver::load_from_config(
&args.recipe_name,
&args.file_name,
&args.character_name,
);
let results = xiv_craft_solver::solve_craft(recipe, stats, params);
// Stop timer
let t_final = now.elapsed().as_millis();
// Show best result depending on selected value
match results {
None => {
println!(
"[Error] No solutions found for craft '{}' with crafter '{}' (ms)",
args.recipe_name, args.character_name
);
return;
}
Some(ref res) => {
// Show best results
if args.verbose > 0 {
println!("[Final] {} results were found:", res.len());
#[cfg(feature = "verbose")]
if args.verbose > 1 {
xiv_craft_solver::print_routes(&results);
}
}
}
}
println!("\n > SOLUTION [Least steps] <");
xiv_craft_solver::find_fast_route(&results)
.unwrap()
.pretty_print();
println!("\n > SOLUTION [Most durability] <");
xiv_craft_solver::find_safe_route(&results)
.unwrap()
.pretty_print();
println!("\n > SOLUTION [Most quality] < ");
xiv_craft_solver::find_quality_route(&results)
.unwrap()
.pretty_print();
// #[cfg(feature = "verbose")]
// if params.verbose>2{
// println!("[F] Top routes {:?}",results);
// }
// Wait for user input
println!(
"\nProgram finished successfully in {}ms\nPress enter to exit...",
t_final
);
let mut input = String::new();
std::io::stdin().read_line(&mut input).unwrap();
()
}

168
src/bin/xiv_csolver.rs Normal file
View File

@ -0,0 +1,168 @@
//! # Solver bin for FFXIV Crafting in Rust
//!
//! This project strives to provide a fast, accurate and reliable way to craft
//! in FFXIV and obtain HQ results
//!
//! This project also provides bindings for python to allow hooking it to any form of better GUI/CLI
//!
//! The project is (for now) self-hosted and hosted on [Github](https://github.com/Dandaedre/xiv_csolver)
//!
//! ## Getting started
//!
//! ### Development
//!
//! #### Rust
//! To set up the whole development environment, it is recommended to use cargo-make
//!
//! Doing so will allow you custom commands to
//!
//! ```sh
//! cargo make rebuild
//! ```
//! To rebuild the whole project
//!
//! ```sh
//! cargo make release
//! ```
//! To generate the release files, bins and libs, package them and make them ready to release
//!
//! #### Python
//!
//! It is really recommended to set up a venv to handle the python development
//!
//! All bindings and the explanation of how to use them can be found in the [`io`](xiv_csolver_lib::io) module.
//!
//! ### Features
//!
//! Use these by running `cargo run/build --features <name of feature>`
//!
//! - ``no_python`` : Don't build the lib & python bindings (WIP, not fully implemented)
//! - ``fast`` : Don't allow some under-optimisation to run (saving global run-time)
//! - ``verbose`` : Allow for more debug messages (note that -v(vv) must still be passed to activate them)
//!
//! ## Regenerating the API Bindings
//!
//! The python bindings are generated using maturin
//!
//! ```sh
//! cargo install maturin
//! maturin develop
//! ```
//! ## Solving and bias
//!
//! The solving algorithm used has a very strong bias toward a particular method:
//!
//! - **Step 1** : Try to push the progression of the craft one step before being finishable
//! - **Step 2** : Try to increase the quality as much as possible.
//! - **Step 3** : Finish the craft
//!
//! To account for a lot of possibilities, step one generates all methods to try and finish the craft
//! and step two tests all methods to up the quality until all crafting points are depleted
//! Doing so ensures by brute force that all permutations are thoroughly tested.
//!
//! While this method works and is very likely the best method for the current patch,
//! a rework of the crafting actions could very well make this method subpar or at least
//! on par with another method.
//!
//! In layman's term, only the groundwork opening is tested and no delicate synthesis spam is tested.
//! However, for now, these two crafting techniques remain subpar and discarding them comes at no
//! loss for the crafter.
//!
//! Others algorithm exists and could very well cover all other basis at the expense of runtime.
//! We have chosen not to implement them as they (for now) would be very unlikely to uncover anything
//! meaningful.
//!
//! ### Leveling
//!
//! We have (for now at least) no intention to release a leveling feature to the crafting solver
//! However, selecting some spells and buffs and have them disabled could be added as a feature
//! hence making a "leveling" option
//!
//! If it is ever released, this feature is likely to be heavily reliant on the python GUI.
//!
//!
//! ## Contributing
//!
//! All form of contributions are welcome !
//!
//! While this project was originally a collab and didn't strive to encompass every need
//! of a modern FFXIV crafter, more polish and finish is always welcome.
//!
//! ## License
//!
//! The original code was released without a license by [RikaKagurasaka](https://github.com/RikaKagurasaka/xiv_craft_solver)
//!
//! All this fork's code is released under [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
#![warn(missing_docs)]
use clap::Parser;
use std::time::Instant;
use xiv_csolver_lib;
#[derive(Debug)]
struct CustomError(String);
fn main() {
let args = xiv_csolver_lib::io::Args::parse();
let params = xiv_csolver_lib::io::Parameters::from_args(&args);
// Start timer
let now = Instant::now();
println!("Solving...");
// Solve from config
let (recipe, stats) =
xiv_csolver_lib::load_from_config(&args.recipe_name, &args.file_name, &args.character_name);
let results = xiv_csolver_lib::solve_craft(recipe, stats, params);
// Stop timer
let t_final = now.elapsed().as_millis();
// Show best result depending on selected value
match results {
None => {
println!(
"[Error] No solutions found for craft '{}' with crafter '{}' (ms)",
args.recipe_name, args.character_name
);
return;
}
Some(ref res) => {
// Show best results
if args.verbose > 0 {
println!("[Final] {} results were found:", res.0.len());
#[cfg(feature = "verbose")]
if args.verbose > 1 {
xiv_csolver_lib::print_routes(&results);
}
}
println!("\n > SOLUTION [Least steps] <");
xiv_csolver_lib::find_fast_route(&res)
.unwrap()
.pretty_print();
println!("\n > SOLUTION [Most durability] <");
xiv_csolver_lib::find_safe_route(&res)
.unwrap()
.pretty_print();
println!("\n > SOLUTION [Most quality] < ");
xiv_csolver_lib::find_quality_route(&res)
.unwrap()
.pretty_print();
}
}
// #[cfg(feature = "verbose")]
// if params.verbose>2{
// println!("[F] Top routes {:?}",results);
// }
// Wait for user input
println!(
"\nProgram finished successfully in {}ms\nPress enter to exit...",
t_final
);
let mut input = String::new();
std::io::stdin().read_line(&mut input).unwrap();
()
}

View File

@ -1,24 +1,46 @@
//! Module containing everything to create a craft and all methods to get the current state of the craft
//!
//! A craft represent the state of the recipe with a vector of actions applied to it.
//! Applying actions to it will make the craft progress, while branching and trying other actions
//! will be done by cloning
use crate::action::Action; use crate::action::Action;
use crate::specs::{Buff, BuffState, Recipe, Stats, Success}; use crate::specs::{Buff, BuffState, Recipe, Stats, Success};
use crate::Parameters; use crate::Parameters;
use std::fmt::{Debug, Display, Formatter}; use std::fmt::{Debug, Display, Formatter};
/// The craft structure, note that there is no standard way of backtracking
/// and a traditional branching method is applied when solving.
#[derive(Clone)] #[derive(Clone)]
pub struct Craft<'a> { pub struct Craft<'a> {
/// The recipe used, contains all needed information on the difficulty and target
pub recipe: Recipe, pub recipe: Recipe,
/// The stats of the crafter
pub stats: Stats, pub stats: Stats,
/// The buffs currently running
pub buffs: BuffState, pub buffs: BuffState,
/// The step count, aka number of steps done from the beggining of the craft
pub step_count: u32, pub step_count: u32,
/// The remaining durability
pub durability: i32, pub durability: i32,
/// The current progression
pub progression: u32, pub progression: u32,
/// The current quality
pub quality: u32, pub quality: u32,
/// The cp currently remaining
pub cp: i32, pub cp: i32,
/// Wether the craft has succeded, is pending sucess, or failed
pub success: Success, pub success: Success,
/// The vector of action already applied, structs are used for the vector since
/// static references are used and therefore take no additional memory at runtime
pub actions: Vec<&'a Action>, pub actions: Vec<&'a Action>,
/// The parameters used for the craft
/// TODO: The usage of a non reference is quite an oversight and should be changed ASAP
pub args: Parameters, pub args: Parameters,
} }
impl<'a> Craft<'a> { impl<'a> Craft<'a> {
/// Create a new craft with a recipe, stats and parameters
pub fn new(recipe: Recipe, stats: Stats, params: Parameters) -> Craft<'a> { pub fn new(recipe: Recipe, stats: Stats, params: Parameters) -> Craft<'a> {
Self { Self {
recipe, recipe,
@ -35,13 +57,18 @@ impl<'a> Craft<'a> {
} }
} }
/// How much progression will be done by an action with 100 efficiency and no buffs
/// This function is mainly used to know wether or not the craft will finish in
/// 1, 1.2 or 2.0 actions.
pub fn get_base_progression(&self) -> u32 { pub fn get_base_progression(&self) -> u32 {
let base_value = (self.stats.craftsmanship as f64 / 10.0) let base_value = (self.stats.craftsmanship as f64 / 10.0)
/ (self.recipe.progress_divider as f64 / 100.0) / (self.recipe.progress_divider as f64 / 100.0)
+ 2.0; + 2.0;
(base_value * (self.recipe.progress_modifier as f64 / 100.0) as f64).floor() as u32 (base_value * (self.recipe.progress_modifier as f64 / 100.0) as f64).floor() as u32
} }
/// How much quality will the crafter generate with one action with 100 efficiency and no buffs
/// This function is usually called by [`run_action`](crate::craft::Craft::run_action)
/// wich will then apply all needed buff and progress the craft
pub fn get_base_quality(&self) -> u32 { pub fn get_base_quality(&self) -> u32 {
let base_value = (self.stats.control as f64 / 10.0) let base_value = (self.stats.control as f64 / 10.0)
/ (self.recipe.quality_divider as f64 / 100.0) / (self.recipe.quality_divider as f64 / 100.0)
@ -49,6 +76,15 @@ impl<'a> Craft<'a> {
(base_value * (self.recipe.quality_modifier as f64 / 100.0) as f64).floor() as u32 (base_value * (self.recipe.quality_modifier as f64 / 100.0) as f64).floor() as u32
} }
/// Add an action to the current craft
/// This method will:
/// - Check wether the action can be used
/// - Increment the step count
/// - Decrease cp
/// - Decrease or increase durability
/// - Increase progression
/// - "Tick" buffs (substract 1 from their remaining time) and remove them if consumed
/// - Add the used action to the vec of actions used
pub fn run_action(&mut self, action: &'a Action) -> &mut Craft<'a> { pub fn run_action(&mut self, action: &'a Action) -> &mut Craft<'a> {
if !action.can_use(self) { if !action.can_use(self) {
self.success = Success::Failure; self.success = Success::Failure;
@ -145,3 +181,135 @@ impl<'a> Display for Craft<'a> {
.finish() .finish()
} }
} }
#[cfg(test)]
impl<'a> Craft<'a> {
/// Create a "Default" craft, testing only
pub fn default() -> Craft<'a> {
Self::new(
crate::specs::Recipe {
durability: 200,
progress: 200,
progress_divider: 100,
progress_modifier: 100,
quality: 100,
quality_divider: 100,
quality_modifier: 100,
},
crate::specs::Stats {
craftsmanship: 200,
control: 200,
max_cp: 200,
},
crate::io::Parameters {
threads: 10,
verbose: 2,
depth: 10,
desperate: false,
byregot_step: 10,
},
)
}
/// Create a "Two start" craft, testing only
pub fn two_star() -> Craft<'a> {
Self::new(
crate::specs::Recipe {
durability: 70,
progress: 3900,
quality: 10920,
progress_divider: 130,
quality_divider: 115,
progress_modifier: 80,
quality_modifier: 70,
},
crate::specs::Stats {
craftsmanship: 4041,
control: 3971,
max_cp: 595,
},
crate::io::Parameters {
threads: 8,
verbose: 2,
depth: 8,
desperate: false,
byregot_step: 10,
},
)
}
/// Create a "Zero star" craft for debbuging & testing
pub fn zero_star() -> Craft<'a> {
Self::new(
crate::specs::Recipe {
durability: 70,
progress: 4000,
quality: 10920,
progress_divider: 100,
quality_divider: 100,
progress_modifier: 100,
quality_modifier: 100,
},
crate::specs::Stats {
craftsmanship: 4000,
control: 4000,
max_cp: 600,
},
crate::io::Parameters {
threads: 8,
verbose: 2,
depth: 8,
desperate: false,
byregot_step: 10,
},
)
}
}
#[cfg(test)]
mod test {
use pretty_assertions::assert_eq;
// Struct Test
#[test]
pub fn struct_tests() {
let craft = crate::craft::Craft::zero_star().clone();
assert_eq!(craft.get_base_progression(), 402);
assert_eq!(craft.get_base_quality(), 435);
format!("{}", craft);
format!("{:?}", craft);
}
#[test]
pub fn test_craft() {
let mut craft = crate::craft::Craft::default();
craft.cp = 1000;
format!("{:?}", craft);
let mut craft2 = craft.run_action(&crate::action::ACTIONS.veneration).clone();
craft.run_action(&crate::action::ACTIONS.masters_mend);
craft.run_action(&crate::action::ACTIONS.masters_mend);
craft.run_action(&crate::action::ACTIONS.manipulation);
craft.run_action(&crate::action::ACTIONS.basic_touch);
craft.run_action(&crate::action::ACTIONS.basic_synthesis);
assert_eq!(craft.durability, 190);
craft.run_action(&crate::action::ACTIONS.masters_mend);
assert_eq!(craft.durability, 200);
craft.run_action(&crate::action::ACTIONS.masters_mend);
for _ in 0..10 {
craft.run_action(&crate::action::ACTIONS.basic_touch);
}
for _ in 0..3 {
craft.run_action(&crate::action::ACTIONS.masters_mend);
craft.run_action(&crate::action::ACTIONS.groundwork);
}
assert_eq!(craft.success, crate::craft::Success::Success);
for _ in 0..20 {
craft2.run_action(&crate::action::ACTIONS.preparatory_touch);
}
assert_eq!(craft2.durability, 0);
assert_eq!(craft2.success, crate::craft::Success::Failure);
}
}

319
src/io.rs
View File

@ -1,19 +1,30 @@
use crate::Craft; //! The main IO module
//! For now it contains the Args bindings (for clap) and the struct
//! needed to hold all parameters needed at runtime
use clap::Parser; use clap::Parser;
use core::fmt::Display;
#[cfg(not(feature = "no_python"))]
use pyo3::prelude::*;
/// The parameters needed at runtime, used since Args cannot easily be passed to python
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
pub struct Parameters { pub struct Parameters {
/// The number of threads to use
/// TODO: Add an auto feature to guess threads depending on architecture and action pool
pub threads: usize, pub threads: usize,
/// The level of verbosity from 0 to 3
pub verbose: u8, pub verbose: u8,
/// How many steps are allowed for finishing the craft
/// TODO: Be a little smarted about this approach and stop guessing if enough starters are found
/// and continue guessing if more are needed
pub depth: u32, pub depth: u32,
/// Wether to try every mesure to finish the craft or not
pub desperate: bool, pub desperate: bool,
/// How early byregot will be used, setting it too low high miss easy solutions (for small crafts)
/// but setting it too low will have the solver try byregot way too often adding many useless crafts
/// in the pool of solutions
pub byregot_step: u8, pub byregot_step: u8,
} }
/// The args passed to the CLI, used by clap to generate a nice argument parser
#[derive(Parser, Debug, Clone)] #[derive(Parser, Debug, Clone)]
#[command(author, version, about, long_about = None)] #[command(author, version, about, long_about = None)]
pub struct Args { pub struct Args {
@ -50,127 +61,8 @@ pub struct Args {
pub long: bool, pub long: bool,
} }
/// A final stripped down version of a craft
/// used for final print and talking with python
#[derive(Debug)]
#[pyclass]
pub struct SolverResult {
#[pyo3(get)]
pub steps: u32,
#[pyo3(get)]
pub quality: u32,
#[pyo3(get)]
pub progression: u32,
#[pyo3(get)]
pub durability: i32,
#[pyo3(get)]
pub cp: i32,
#[pyo3(get)]
pub total_cp: u32,
#[pyo3(get)]
pub total_progression: u32,
#[pyo3(get)]
pub total_quality: u32,
#[pyo3(get)]
pub total_durability: u32,
#[pyo3(get)]
pub actions: Vec<String>,
#[pyo3(get)]
pub step1_solutions: usize,
#[pyo3(get)]
pub step2_solutions: usize,
#[pyo3(get)]
pub found_100_percent: bool,
}
/// Pretty display for SolverResult
impl Display for SolverResult {
fn fmt(&self, _f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
println!("{:?}", self.actions);
Ok(())
}
}
//#[pymethods]
impl SolverResult {
pub fn from_craft(
craft: &Craft,
step1_solutions: usize,
step2_solutions: usize,
found_100_percent: bool,
) -> SolverResult {
let mut actions = craft
.actions
.iter()
.map(|action| format!("{}", action.short_name))
.collect::<Vec<String>>();
let arg = (craft.recipe.progress as f32 - craft.progression as f32)
/ craft.get_base_progression() as f32;
if 0.0 < arg && arg < 1.2 {
actions.push("basicSynth2".to_string());
}
if 1.2 <= arg && arg < 1.8 {
actions.push("carefulSynthesis".to_string());
}
if 1.8 <= arg && arg < 2.0 {
actions.push("observe".to_string());
actions.push("focusedSynthesis".to_string());
}
SolverResult {
steps: craft.step_count,
progression: craft.progression,
quality: craft.quality,
durability: craft.durability,
actions: actions,
step1_solutions,
step2_solutions,
found_100_percent,
total_progression: craft.recipe.progress,
total_quality: craft.recipe.quality,
total_durability: craft.recipe.durability,
cp: craft.cp,
total_cp: craft.stats.max_cp,
}
}
}
#[pymethods]
impl SolverResult {
#[staticmethod]
pub fn default() -> Self {
Self {
steps: 0,
progression: 0,
quality: 0,
durability: 0,
total_progression: 0,
total_quality: 0,
total_durability: 0,
actions: vec!["Act1".to_string(), "Act2".to_string()],
step1_solutions: 0,
step2_solutions: 0,
found_100_percent: false,
cp: 0,
total_cp: 0,
}
}
pub fn pretty_print(&self) {
println!(
"Quality: [{}/{}] | Durability: [{}/{}] | Cp : [{}/{}] | Steps : {}",
self.quality,
self.total_quality,
self.durability,
self.total_durability,
self.cp,
self.total_cp,
self.steps
);
println!("{:?}", self.actions);
}
}
impl Parameters { impl Parameters {
/// Create parameters from the arguments parsed by clap
pub fn from_args(args: &Args) -> Self { pub fn from_args(args: &Args) -> Self {
Self { Self {
depth: if args.desperate { 11 } else { 8 }, depth: if args.desperate { 11 } else { 8 },
@ -182,59 +74,140 @@ impl Parameters {
} }
} }
////// Python Bindings ////// #[cfg(test)]
mod tests {
use crate::io::{Args, Parameters};
use crate::python_bindings::SolverResult;
use clap::Parser;
use pretty_assertions::{assert_eq, assert_ne};
/// A Python module implemented in Rust. impl PartialEq for Parameters {
#[cfg(not(feature = "no_python"))] fn eq(&self, rhs: &Parameters) -> bool {
#[pymodule] (self.byregot_step == rhs.byregot_step)
fn xiv_craft_solver(_py: Python, m: &PyModule) -> PyResult<()> { & (self.depth == rhs.depth)
m.add_function(wrap_pyfunction!(test_result, m)?)?; & (self.desperate == rhs.desperate)
m.add_function(wrap_pyfunction!(solve_from_python, m)?)?; & (self.threads == rhs.threads)
Ok(()) }
} }
/// #[test]
#[cfg(not(feature = "no_python"))] pub fn test_parameters_derived_attributes() {
#[pyfunction] let def = Parameters {
pub fn test_result() -> SolverResult { byregot_step: 0,
SolverResult::default() depth: 0,
} desperate: false,
threads: 42,
/// Create a stat struct stats with the base values verbose: 1,
#[cfg(not(feature = "no_python"))]
use crate::{solve_craft, Recipe, Stats};
#[cfg(not(feature = "no_python"))]
#[pyfunction]
pub fn solve_from_python(values: &PyAny) -> PyResult<Option<Vec<SolverResult>>> {
// // Create Recipe
let recipe = Recipe {
durability: values.getattr("durability")?.extract()?,
progress: values.getattr("progress")?.extract()?,
progress_divider: values.getattr("progress_divider")?.extract()?,
progress_modifier: values.getattr("progress_modifier")?.extract()?,
quality: values.getattr("quality")?.extract()?,
quality_divider: values.getattr("quality_divider")?.extract()?,
quality_modifier: values.getattr("quality_modifier")?.extract()?,
}; };
let def2 = def;
let def3 = def2.clone();
// Create Stats assert_eq!(def2, def3);
let stats = Stats { }
craftsmanship: values.getattr("craftsmanship")?.extract()?,
control: values.getattr("control")?.extract()?, #[test]
max_cp: values.getattr("max_cp")?.extract()?, pub fn test_display() {
let def = SolverResult::default();
assert_ne!(def.to_string(), "");
assert_eq!(def.to_string(), "[\"Act1\", \"Act2\"]");
def.pretty_print();
}
#[test]
pub fn test_debug() {
let def = SolverResult::default();
assert_eq!(format!("{:?}", def),"SolverResult { steps: 0, quality: 0, progression: 0, durability: 0, cp: 0, total_cp: 0, total_progression: 0, total_quality: 0, total_durability: 0, actions: [\"Act1\", \"Act2\"] }");
//, step1_solutions: 0, step2_solutions: 0, found_100_percent: false }
}
#[test]
pub fn test_arguments() {
// Create false argument parameter
let a = Args {
character_name: "Bob GZ".to_string(),
depth: 77,
desperate: false,
file_name: "test.toml".to_string(),
long: false,
recipe_name: "Belladone".to_string(),
threads: 11,
verbose: 1,
}; };
let a2 = a.clone();
println!("{:?}", a2);
// Test Custom recipe
let a3 = crate::io::Args::parse_from([
"ultraman",
"-r",
"recipe",
"-c",
"dan",
"-f",
"bigfile.toml",
"-d",
"45",
"-t",
"4",
"-D",
"-l",
"-vvv",
]);
let _ = Args::parse_from(["-V"]);
let _ = Args::parse_from(["-H"]);
assert_eq!(a3.recipe_name, "recipe");
assert_eq!(a3.character_name, "dan");
assert_eq!(a3.file_name, "bigfile.toml");
assert_eq!(a3.verbose, 3);
assert_eq!(a3.depth, 45);
assert_eq!(a3.threads, 4);
assert_eq!(a3.desperate, true);
assert_eq!(a3.long, true);
// Create parameters // Test default parameters
let param = Parameters { let a4 = Args::parse_from(["bobGZ"]);
depth: values.getattr("depth")?.extract()?, assert_eq!(a4.recipe_name, "default_recipe");
byregot_step: values.getattr("byregot_step")?.extract()?, assert_eq!(a4.character_name, "default_character");
desperate: values.getattr("desperate")?.extract()?, assert_eq!(a4.file_name, "craft.toml");
threads: values.getattr("threads")?.extract()?, assert_eq!(a4.verbose, 0);
verbose: values.getattr("verbose")?.extract()?, assert_eq!(a4.depth, 8);
}; assert_eq!(a4.threads, 4);
assert_eq!(a4.desperate, false);
assert_eq!(a4.long, false);
}
// println!("{:?} len: {:?} ",values,values.getattr("len()")); #[test]
let res = solve_craft(recipe, stats, param); pub fn test_parameters() {
Ok(res) // Test a random config
let ar = Args::parse_from([
"ultraman",
"-r",
"recipe",
"-c",
"dan",
"-f",
"bigfile.toml",
"-d",
"45",
"-t",
"4",
"-D",
"-l",
"-vvv",
]);
let p = Parameters::from_args(&ar);
assert_eq!(p.depth, 11);
assert_eq!(p.verbose, 3);
assert_eq!(p.threads, 4);
assert_eq!(p.desperate, true);
assert_eq!(p.byregot_step, 6);
// Test defaults
let ar = Args::parse_from(&["a"]);
let p = Parameters::from_args(&ar);
assert_eq!(p.depth, 8);
assert_eq!(p.verbose, 0);
assert_eq!(p.threads, 4);
assert_eq!(p.desperate, false);
assert_eq!(p.byregot_step, 8);
}
} }

View File

@ -1,24 +1,121 @@
use crate::io::SolverResult; //! # Solver bin for FFXIV Crafting in Rust
use crate::{ //!
craft::Craft, //! This project strives to provide a fast, accurate and reliable way to craft
io::Parameters, //! in FFXIV and obtain HQ results
specs::{Recipe, Stats}, //!
}; //! This project also provides bindings for python to allow hooking it to any form of better GUI/CLI
//!
//! The project is (for now) self-hosted and hosted on [Github](https://github.com/Dandaedre/xiv_csolver)
//!
//! ## Getting started
//!
//! ### Development
//!
//! #### Rust
//! To set up the whole development environment, it is recommended to use cargo-make
//!
//! Doing so will allow you custom commands to
//!
//! ```sh
//! cargo make rebuild
//! ```
//! To rebuild the whole project
//!
//! ```sh
//! cargo make release
//! ```
//! To generate the release files, bins and libs, package them and make them ready to release
//!
//! #### Python
//!
//! It is really recommended to set up a venv to handle the python development
//!
//! All bindings and the explanation of how to use them can be found in the [`io`](crate::io) module.
//!
//! ### Features
//!
//! Use these by running `cargo run/build --features <name of feature>`
//!
//! - ``no_python`` : Don't build the lib & python bindings (WIP, not fully implemented)
//! - ``fast`` : Don't allow some under-optimisation to run (saving global run-time)
//! - ``verbose`` : Allow for more debug messages (note that -v(vv) must still be passed to activate them)
//!
//! ## Regenerating the API Bindings
//!
//! The python bindings are generated using maturin
//!
//! ```sh
//! cargo install maturin
//! maturin develop
//! ```
//! ## Solving and bias
//!
//! The solving algorithm used has a very strong bias toward a particular method:
//!
//! - **Step 1** : Try to push the progression of the craft one step before being finishable
//! - **Step 2** : Try to increase the quality as much as possible.
//! - **Step 3** : Finish the craft
//!
//! To account for a lot of possibilities, step one generates all methods to try and finish the craft
//! and step two tests all methods to up the quality until all crafting points are depleted
//! Doing so ensures by brute force that all permutations are thoroughly tested.
//!
//! While this method works and is very likely the best method for the current patch,
//! a rework of the crafting actions could very well make this method subpar or at least
//! on par with another method.
//!
//! In layman's term, only the groundwork opening is tested and no delicate synthesis spam is tested.
//! However, for now, these two crafting techniques remain subpar and discarding them comes at no
//! loss for the crafter.
//!
//! Others algorithm exists and could very well cover all other basis at the expense of runtime.
//! We have chosen not to implement them as they (for now) would be very unlikely to uncover anything
//! meaningful.
//!
//! ### Leveling
//!
//! We have (for now at least) no intention to release a leveling feature to the crafting solver
//! However, selecting some spells and buffs and have them disabled could be added as a feature
//! hence making a "leveling" option
//!
//! If it is ever released, this feature is likely to be heavily reliant on the python GUI.
//!
//!
//! ## Contributing
//!
//! All form of contributions are welcome !
//!
//! While this project was originally a collab and didn't strive to encompass every need
//! of a modern FFXIV crafter, more polish and finish is always welcome.
//!
//! ## License
//!
//! The original code was released without a license by [RikaKagurasaka](https://github.com/RikaKagurasaka/xiv_craft_solver)
//!
//! All this fork's code is released under [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
#![warn(missing_docs)]
use crate::craft::Craft;
use crate::io::Parameters;
use crate::python_bindings::{Info, SolverResult};
use crate::specs::{Recipe, Stats};
use std::sync::{Arc, Mutex}; use std::sync::{Arc, Mutex};
use threadpool::ThreadPool; use threadpool::ThreadPool;
pub mod action; pub mod action;
pub mod craft; pub mod craft;
pub mod io; pub mod io;
pub mod python_bindings;
mod solver; mod solver;
mod specs; pub mod specs;
/// Solve the craft with given arguments, this functions calls threads and must own it's values /// Solve the craft with given arguments, this functions calls threads and must own it's values
pub fn solve_craft<'a>( pub fn solve_craft<'a>(
recipe: Recipe, recipe: Recipe,
stats: Stats, stats: Stats,
params: Parameters, params: Parameters,
) -> Option<Vec<SolverResult>> { ) -> Option<(Vec<SolverResult>, Info)> {
// Load the craft with given arguments // Load the craft with given arguments
let craft = Craft::new(recipe, stats, params); let craft = Craft::new(recipe, stats, params);
@ -53,7 +150,7 @@ pub fn solve_craft<'a>(
} }
} }
// Core algorithm, fill all found routes with the best route (doesn't branch, just replace) // Core algorithm, fill all found routes with the best route
let arc_phase2_routes = Arc::new(Mutex::new(Vec::<Craft>::new())); let arc_phase2_routes = Arc::new(Mutex::new(Vec::<Craft>::new()));
for route in phase1_routes { for route in phase1_routes {
@ -71,9 +168,25 @@ pub fn solve_craft<'a>(
let phase2_routes = arc_phase2_routes.lock().unwrap(); let phase2_routes = arc_phase2_routes.lock().unwrap();
let nb_p2 = phase2_routes.len(); let nb_p2 = phase2_routes.len();
// Drop on empty results // Drop on empty results. // TODO: Retry automatically with better parameters
if phase2_routes.len() == 0 { if phase2_routes.len() == 0 {
return None; // No solutions were found
if params.desperate {
// But everything was tested
return Some((Vec::<SolverResult>::new(), Info::new(0, 0, false)));
} else {
// And not everything was tested
return solve_craft(
recipe,
stats,
Parameters {
depth: 11,
byregot_step: 6,
desperate: true,
..params
},
);
}
} }
// Print the results if verbose // Print the results if verbose
@ -99,17 +212,17 @@ pub fn solve_craft<'a>(
for route in phase2_routes.iter() { for route in phase2_routes.iter() {
if route.quality >= route.recipe.quality { if route.quality >= route.recipe.quality {
// valid_routes.push(route.clone()); // valid_routes.push(route.clone());
valid_solutions.push(SolverResult::from_craft(route, nb_p1, nb_p2, true)); valid_solutions.push(SolverResult::from_craft(route)); //nb_p1, nb_p2, true
} }
} }
// If no craft can make it to 100% HQ, fallback to base results // If no craft can make it to 100% HQ, fallback to base results
if valid_solutions.len() == 0 { if valid_solutions.len() == 0 {
for route in phase2_routes.iter() { for route in phase2_routes.iter() {
valid_solutions.push(SolverResult::from_craft(route, nb_p1, nb_p2, false)); valid_solutions.push(SolverResult::from_craft(route));
} }
} }
Some(valid_solutions) Some((valid_solutions, Info::new(nb_p1, nb_p2, true)))
} }
/// Load the config from args and make a craft from it /// Load the config from args and make a craft from it
@ -226,9 +339,9 @@ pub fn load_from_config<'a>(
} }
/// Print all routes in the vect, verbose /// Print all routes in the vect, verbose
pub fn print_routes<'a>(routes: &Option<Vec<SolverResult>>) { pub fn print_routes<'a>(routes: &Option<(Vec<SolverResult>, Info)>) {
match routes { match routes {
Some(r) => { Some((r, _)) => {
println!("Showing {} routes", r.len()); println!("Showing {} routes", r.len());
for c in r.iter() { for c in r.iter() {
println!( println!(
@ -242,37 +355,206 @@ pub fn print_routes<'a>(routes: &Option<Vec<SolverResult>>) {
} }
/// Find the route with the least amount of steps /// Find the route with the least amount of steps
pub fn find_fast_route(routes: &Option<Vec<SolverResult>>) -> Option<&SolverResult> { pub fn find_fast_route<'a>(routes: &'a (Vec<SolverResult>, Info)) -> Option<&'a SolverResult> {
match routes { let (_routes, _info) = routes;
Some(_routes) => {
if _routes.len() > 0 { if _routes.len() > 0 {
_routes.iter().min_by_key(|key| key.steps) _routes.iter().min_by_key(|key| key.steps)
} else { } else {
None None
} }
}
None => None,
}
} }
/// Find the route with the maximum amount of quality /// Find the route with the maximum amount of quality
pub fn find_quality_route(routes: &Option<Vec<SolverResult>>) -> Option<&SolverResult> { pub fn find_quality_route<'a>(routes: &'a (Vec<SolverResult>, Info)) -> Option<&'a SolverResult> {
match routes { let (_routes, _info) = routes;
Some(_routes) => _routes.iter().max_by_key(|key| key.quality), _routes.iter().max_by_key(|key| key.quality)
None => None,
}
} }
/// Find the route with the maximum of durability left /// Find the route with the maximum of durability left
pub fn find_safe_route(routes: &Option<Vec<SolverResult>>) -> Option<&SolverResult> { pub fn find_safe_route(routes: &(Vec<SolverResult>, Info)) -> Option<&SolverResult> {
match routes { let (_routes, _info) = routes;
Some(_routes) => {
if _routes.len() > 0 { if _routes.len() > 0 {
_routes.iter().max_by_key(|key| key.durability) _routes.iter().max_by_key(|key| key.durability)
} else { } else {
None None
} }
}
#[cfg(test)]
mod test {
use super::*;
#[test]
pub fn test_lib_find_route() {
// Supposed to find a route for the base craft
let mut craft = crate::craft::Craft::two_star();
let res = solve_craft(craft.recipe, craft.stats, craft.args);
assert!(res.unwrap().0.len() > 2000);
craft.recipe.progress = 0;
let res = solve_craft(craft.recipe, craft.stats, craft.args);
println!("{:?}", res);
assert!(res.unwrap().0.len() == 0);
craft.recipe.progress = 100;
craft.stats.max_cp = 0;
craft.cp = 0;
let mut res = solve_craft(craft.recipe, craft.stats, craft.args).unwrap();
println!("{:?}", res);
assert_eq!(res.0.len(), 1);
assert_eq!(res.0.pop().unwrap().actions, vec!("basicSynth2"));
} }
None => None,
#[test]
pub fn test_lib_print_route() {
let craft = crate::craft::Craft::two_star();
print_routes(&solve_craft(craft.recipe, craft.stats, craft.args));
print_routes(&None);
}
#[test]
pub fn test_lib_best_solutions() {
let craft = crate::craft::Craft::two_star();
let routes = solve_craft(craft.recipe, craft.stats, craft.args).unwrap();
// assert!(find_fast_route(&(None)).is_none());
// assert!(find_quality_route(&None).is_none());
// assert!(find_safe_route(&None).is_none());
assert!(find_fast_route(&((vec![], Info::default()))).is_none());
assert!(find_quality_route(&((vec![], Info::default()))).is_none());
assert!(find_safe_route(&((vec![], Info::default()))).is_none());
let sol = find_fast_route(&routes).unwrap();
assert_eq!(sol.steps, 17);
assert_eq!(sol.quality, 11129);
assert_eq!(sol.progression, 3750);
assert_eq!(sol.durability, 0);
assert_eq!(sol.cp, 7);
assert_eq!(routes.1.step1_solutions, 9);
assert_eq!(routes.1.step2_solutions, 21193);
assert_eq!(routes.1.found_100_percent, true);
assert_eq!(
sol.actions,
vec!(
"muscleMemory",
"manipulation",
"veneration",
"wasteNot2",
"groundwork",
"delicateSynthesis",
"delicateSynthesis",
"innovation",
"preparatoryTouch",
"preparatoryTouch",
"preparatoryTouch",
"preparatoryTouch",
"innovation",
"basicTouch",
"standardTouch",
"greatStrides",
"byregotsBlessing",
"basicSynth2"
)
);
let sol = find_quality_route(&routes).unwrap();
assert_eq!(sol.steps, 23);
assert_eq!(sol.quality, 12032);
assert_eq!(sol.progression, 3675);
assert_eq!(sol.durability, -5);
assert_eq!(sol.cp, 3);
assert_eq!(routes.1.step1_solutions, 9);
assert_eq!(routes.1.step2_solutions, 21193);
assert_eq!(routes.1.found_100_percent, true);
assert_eq!(
sol.actions,
vec!(
"muscleMemory",
"manipulation",
"veneration",
"groundwork",
"prudentSynthesis",
"innovation",
"prudentTouch",
"basicTouch",
"standardTouch",
"advancedTouch",
"manipulation",
"innovation",
"prudentTouch",
"basicTouch",
"standardTouch",
"advancedTouch",
"innovation",
"basicTouch",
"standardTouch",
"advancedTouch",
"greatStrides",
"innovation",
"byregotsBlessing",
"basicSynth2"
)
);
let sol = find_safe_route(&routes).unwrap();
assert_eq!(sol.steps, 22);
assert_eq!(sol.quality, 11161);
assert_eq!(sol.progression, 3675);
assert_eq!(sol.durability, 10);
assert_eq!(sol.cp, 4);
assert_eq!(routes.1.step1_solutions, 9);
assert_eq!(routes.1.step2_solutions, 21193);
assert_eq!(routes.1.found_100_percent, true);
assert_eq!(
sol.actions,
vec!(
"muscleMemory",
"manipulation",
"veneration",
"groundwork",
"carefulSynthesis",
"prudentTouch",
"innovation",
"prudentTouch",
"prudentTouch",
"prudentTouch",
"prudentTouch",
"manipulation",
"innovation",
"prudentTouch",
"basicTouch",
"standardTouch",
"advancedTouch",
"innovation",
"basicTouch",
"standardTouch",
"greatStrides",
"byregotsBlessing",
"basicSynth2"
)
);
}
#[test]
pub fn test_load_from_config() {
load_from_config("default_recipe", "craft.toml", "default_character");
}
#[should_panic]
#[test]
pub fn test_bad_config_filename() {
load_from_config("default_recipe", "nocrafto.toml", "default_character");
}
#[should_panic]
#[test]
pub fn test_bad_config_recipename() {
load_from_config("bad_recipe", "craft.toml", "default_character");
}
#[should_panic]
#[test]
pub fn test_bad_config_charname() {
load_from_config("default_recipe", "craft.toml", "bad_character");
} }
} }

View File

@ -1,4 +1,337 @@
#[cfg(not(feature="no_python"))] //! The binding module
//! It contains the python bindings, and the structs
//! needed to hold all parameters needed at runtime
//!
//! Making the bindings a build feature is a WIP
use crate::Craft;
#[cfg(not(feature = "no_python"))]
use crate::Parameters;
use core::fmt::Display;
use pyo3::prelude::*; use pyo3::prelude::*;
/// A final stripped down version of a craft
/// used for final print and talking with python
#[derive(Debug)]
#[pyclass]
pub struct SolverResult {
/// The number of steps this particular craft takes
#[pyo3(get)]
pub steps: u32,
/// The quality obtained at the end of the craft (absolute value)
#[pyo3(get)]
pub quality: u32,
/// The amount of progression obtained at the end of the craft (absolute value)
#[pyo3(get)]
pub progression: u32,
/// The remaining durability at the end of this craft
#[pyo3(get)]
pub durability: i32,
/// The remaining crafting points at the end of this craft
#[pyo3(get)]
pub cp: i32,
/// The total amount of crafting points the crafter had available (Deprecated)
#[pyo3(get)]
pub total_cp: u32,
/// The total amount of progression needed to finish the craft (Deprecated)
#[pyo3(get)]
pub total_progression: u32,
/// The total quality needed to make this craft 100% HQ (Deprecated)
#[pyo3(get)]
pub total_quality: u32,
/// The total durability for this craft (Deprecated)
#[pyo3(get)]
pub total_durability: u32,
/// The list of actions, as a string
#[pyo3(get)]
pub actions: Vec<String>,
// /// The amount of solutions found during the first step of the solving (Used for debug) (Deprecated)
// #[pyo3(get)]
// pub step1_solutions: usize,
// /// The amount of solutions found at the end of the second step of solving (Used for debug) (Deprecated)
// #[pyo3(get)]
// pub step2_solutions: usize,
// #[pyo3(get)]
// /// Wether a 100% HQ solution was found (Deprecated)
// pub found_100_percent: bool,
}
/// Global info on the execution
#[derive(Debug)]
#[pyclass]
pub struct Info {
/// The amount of solutions found during the first step of the solving (Used for debug) (Deprecated)
#[pyo3(get)]
pub step1_solutions: usize,
/// The amount of solutions found at the end of the second step of solving (Used for debug) (Deprecated)
#[pyo3(get)]
pub step2_solutions: usize,
#[pyo3(get)]
/// Wether a 100% HQ solution was found (Deprecated)
pub found_100_percent: bool,
}
/// Solution information, contains information about the execution
impl Info {
/// Make a new information struct
pub fn new(
step1_solutions: usize,
step2_solutions: usize,
found_100_percent: bool,
// params: &'Parameters
) -> Self {
Self {
step1_solutions,
step2_solutions,
found_100_percent,
}
}
/// Default value of the info, only used for debug purposes
pub fn default() -> Self {
Self {
step1_solutions: 0,
step2_solutions: 0,
found_100_percent: false,
}
}
}
/// Pretty display for SolverResult
impl Display for SolverResult {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
write!(f, "{:?}", self.actions)
}
}
impl SolverResult {
/// Create a SolverResult from a solution
/// Using this returns a solution, usable by Python
pub fn from_craft(craft: &Craft) -> SolverResult {
let mut actions = craft
.actions
.iter()
.map(|action| format!("{}", action.short_name))
.collect::<Vec<String>>();
// Todo: Stop adding these by hand
let arg = (craft.recipe.progress as f32 - craft.progression as f32)
/ craft.get_base_progression() as f32;
if 0.0 < arg && arg < 1.2 {
actions.push("basicSynth2".to_string());
}
if 1.2 <= arg && arg < 1.8 {
actions.push("carefulSynthesis".to_string());
}
if 1.8 <= arg && arg < 2.0 {
actions.push("observe".to_string());
actions.push("focusedSynthesis".to_string());
}
SolverResult {
steps: craft.step_count,
progression: craft.progression,
quality: craft.quality,
durability: craft.durability,
actions,
total_progression: craft.recipe.progress,
total_quality: craft.recipe.quality,
total_durability: craft.recipe.durability,
cp: craft.cp,
total_cp: craft.stats.max_cp,
}
}
}
#[pymethods]
impl SolverResult {
/// Default method to create an empty solution, only used for debug purposes
/// to test wether the import worked
/// ```py
/// import xiv_csolver_lib
/// print(xiv_csolver_lib.default())
/// ```
#[staticmethod]
pub fn default() -> Self {
Self {
steps: 0,
progression: 0,
quality: 0,
durability: 0,
total_progression: 0,
total_quality: 0,
total_durability: 0,
actions: vec!["Act1".to_string(), "Act2".to_string()],
cp: 0,
total_cp: 0,
}
}
/// Implement a pretty_print method
/// Mainly used for debug purposes
pub fn pretty_print(&self) {
println!(
"Quality: [{}/{}] | Durability: [{}/{}] | Cp : [{}/{}] | Steps : {}",
self.quality,
self.total_quality,
self.durability,
self.total_durability,
self.cp,
self.total_cp,
self.steps
);
println!("{:?}", self.actions);
}
}
////// Python Bindings //////
/// A Python module implemented in Rust.
#[cfg(not(feature = "no_python"))]
#[pymodule]
fn xiv_csolver_lib(_py: Python, m: &PyModule) -> PyResult<()> {
m.add_function(wrap_pyfunction!(test_result, m)?)?;
m.add_function(wrap_pyfunction!(test_final_results, m)?)?;
m.add_function(wrap_pyfunction!(test_info, m)?)?;
m.add_function(wrap_pyfunction!(solve_from_python, m)?)?;
Ok(())
}
/// A test result, useful for debugging, all values are set to zero as per the
/// [`default`](crate::python_bindings::SolverResult::default())
/// ```
/// # use xiv_csolver_lib::python_bindings::SolverResult;
/// SolverResult {
/// steps: 0,
/// progression: 0,
/// quality: 0,
/// durability: 0,
/// total_progression: 0,
/// total_quality: 0,
/// total_durability: 0,
/// actions: vec!["Act1".to_string(), "Act2".to_string()],
/// cp: 0,
/// total_cp: 0,
/// };
/// ```
#[cfg(not(feature = "no_python"))]
#[pyfunction]
pub fn test_result() -> SolverResult {
SolverResult::default()
}
/// A test info, useful for debugging, all values are set to zero as per the
/// [`default`](crate::python_bindings::Info::default())
/// ```
/// # use xiv_csolver_lib::python_bindings::Info;
/// Info {
/// step1_solutions: 0,
/// step2_solutions: 0,
/// found_100_percent: false,
/// };
/// ```
#[cfg(not(feature = "no_python"))]
#[pyfunction]
pub fn test_info() -> Info {
Info::default()
}
/// A test result array, useful for debugging, all values are set to zero as per the
/// [`default`](crate::python_bindings::Info::default())
/// ```
/// # use xiv_csolver_lib::python_bindings::{Info};
/// # use xiv_csolver_lib::python_bindings::SolverResult;
/// (
/// vec![SolverResult::default(), SolverResult::default()],
/// Info::default(),
/// );
/// ```
#[cfg(not(feature = "no_python"))]
#[pyfunction]
pub fn test_final_results() -> (Vec<SolverResult>, Info) {
(
vec![SolverResult::default(), SolverResult::default()],
Info::default(),
)
}
/// Create a stat struct stats with the base values
#[cfg(not(feature = "no_python"))]
use crate::{solve_craft, Recipe, Stats};
/// Solve a craft from parameters given by python
/// The values are all obtained by a `&PyAny`, wich must guaranty that several attributes are
/// accesible by `__getattr__`
///
/// ```python
/// import xiv_craft_solver, rich
///
/// class FeedingClass:
/// durability = 70
/// progress = 3900
/// quality = 10920
/// progress_divider = 130
/// quality_divider = 115
/// progress_modifier = 80
/// quality_modifier = 70
/// craftsmanship = 4041
/// control = 3959
/// max_cp = 602
/// # Config
/// depth = 10
/// byregot_step = 10
/// desperate = False
/// threads = 8
/// verbose = 0
/// crafting_feeder = FeedingClass()
/// rich.inspect(xiv_csolver_lib.solve_from_python(crafting_feeder))
/// ```
#[cfg(not(feature = "no_python"))]
#[pyfunction]
pub fn solve_from_python(
py: Python<'_>,
values: &PyAny,
) -> PyResult<Option<(Vec<SolverResult>, Info)>> {
// Create Recipe
let recipe = Recipe {
durability: values.getattr("durability")?.extract()?,
progress: values.getattr("progress")?.extract()?,
progress_divider: values.getattr("progress_divider")?.extract()?,
progress_modifier: values.getattr("progress_modifier")?.extract()?,
quality: values.getattr("quality")?.extract()?,
quality_divider: values.getattr("quality_divider")?.extract()?,
quality_modifier: values.getattr("quality_modifier")?.extract()?,
};
// Create Stats
let stats = Stats {
craftsmanship: values.getattr("craftsmanship")?.extract()?,
control: values.getattr("control")?.extract()?,
max_cp: values.getattr("max_cp")?.extract()?,
};
// Create parameters
let param = Parameters {
depth: values.getattr("depth")?.extract()?,
byregot_step: values.getattr("byregot_step")?.extract()?,
desperate: values.getattr("desperate")?.extract()?,
threads: values.getattr("threads")?.extract()?,
verbose: values.getattr("verbose")?.extract()?,
};
// println!("{:?} len: {:?} ",values,values.getattr("len()"));
py.allow_threads(move || {
let res = solve_craft(recipe, stats, param);
Ok(res)
})
}
#[cfg(test)]
mod test {
use crate::python_bindings::{test_final_results, test_info, test_result};
#[test]
pub fn test_function_call() {
test_final_results();
test_info();
test_result();
}
}

View File

@ -16,7 +16,7 @@ pub fn next_action_picker_1<'a>(craft: &Craft<'a>) -> Vec<Option<&'a Action>> {
let mut available_actions = Vec::<Option<&'a Action>>::new(); let mut available_actions = Vec::<Option<&'a Action>>::new();
let mut forbidden_actions = Vec::<Option<&'a Action>>::new(); let mut forbidden_actions = Vec::<Option<&'a Action>>::new();
// Optimize the first three steps for massive time save // Optimize the first four steps for massive time save
if craft.step_count == 0 { if craft.step_count == 0 {
return action_vec![ACTIONS.muscle_memory]; return action_vec![ACTIONS.muscle_memory];
} }
@ -26,11 +26,11 @@ pub fn next_action_picker_1<'a>(craft: &Craft<'a>) -> Vec<Option<&'a Action>> {
// Prune some actions if not requested by --long // Prune some actions if not requested by --long
if craft.step_count == 2 { if craft.step_count == 2 {
return action_vec![/*ACTIONS.waste_not, ACTIONS.waste_not_ii, */ ACTIONS.veneration]; return action_vec![/* ACTIONS.waste_not, ACTIONS.waste_not_ii, */ ACTIONS.veneration];
} }
if craft.step_count == 3 { if craft.step_count == 3 {
available_actions.append(&mut action_vec![ available_actions.append(&mut action_vec![
ACTIONS.waste_not_ii /*,ACTIONS.waste_not*/ ACTIONS.waste_not_ii /* ,ACTIONS.waste_not */
]) ])
} }
@ -61,10 +61,11 @@ pub fn next_action_picker_1<'a>(craft: &Craft<'a>) -> Vec<Option<&'a Action>> {
// ACTIONS.groundwork for the --pls // ACTIONS.groundwork for the --pls
if craft.args.desperate { if craft.args.desperate {
available_actions.append(&mut action_vec![ACTIONS.groundwork]); available_actions.append(&mut action_vec![ACTIONS.groundwork]);
available_actions.append(&mut action_vec![ACTIONS.masters_mend]);
} }
// For long first run // For long first run
if craft.step_count > 8 { if craft.step_count > 8 && craft.buffs.waste_not == 0 {
available_actions.append(&mut action_vec![ACTIONS.waste_not_ii, ACTIONS.waste_not]) available_actions.append(&mut action_vec![ACTIONS.waste_not_ii, ACTIONS.waste_not])
}; };
@ -107,9 +108,10 @@ pub fn generate_routes_phase1<'a>(craft: Craft<'a>) -> Vec<Craft<'a>> {
continue; continue;
} else if 0.0 < remaining_prog && remaining_prog <= 1.2 { } else if 0.0 < remaining_prog && remaining_prog <= 1.2 {
// pass // Will finish with basicSynth2 (free) // pass // Will finish with basicSynth2 (free)
} else if 1.2 < remaining_prog && remaining_prog <= 1.2 { // TODO: Test replacing this value with 1.8 that should be the correct value but hasnt be tested
craft.cp -= 7; // Will finish with carefulSynthesis (7cp) // } else if 1.2 < remaining_prog && remaining_prog <= 1.4 {
} else if 1.2 < remaining_prog && remaining_prog <= 2.0 { // craft.cp -= 7; // Will finish with carefulSynthesis (7cp)
} else if 1.4 < remaining_prog && remaining_prog <= 2.0 {
craft.cp -= 12; // Will finish with observe+focusedSynthesis (12cp) craft.cp -= 12; // Will finish with observe+focusedSynthesis (12cp)
} }
craft.durability -= 10; // Save the final step, since we always aim to end with -5dur, it doesn't matter craft.durability -= 10; // Save the final step, since we always aim to end with -5dur, it doesn't matter
@ -191,6 +193,9 @@ pub fn next_action_phase_2<'a>(craft: &Craft<'a>) -> Vec<Option<&'a Action>> {
available_actions.push(&ACTIONS.byregot_blessing); available_actions.push(&ACTIONS.byregot_blessing);
} }
} }
// if craft.durability + 30 < craft.recipe.durability as i32{
// available_actions.push(&ACTIONS.masters_mend);
// }
let mut final_actions: Vec<Option<&Action>> = Vec::new(); let mut final_actions: Vec<Option<&Action>> = Vec::new();
for action in available_actions { for action in available_actions {
@ -242,3 +247,5 @@ pub fn generate_routes_phase2<'a>(craft: Craft<'a>) -> Option<Vec<Craft<'a>>> {
top_routes.push(top_route); top_routes.push(top_route);
Some(top_routes) Some(top_routes)
} }
mod test_solver;

391
src/solver/test_solver.rs Normal file
View File

@ -0,0 +1,391 @@
#[allow(unused_imports)]
use super::*;
#[test]
pub fn test_first_step() {
let mut craft = crate::craft::Craft::two_star();
// Try a failed craft
craft.success = crate::specs::Success::Failure;
let vact = next_action_picker_1(&craft);
assert_eq!(vact, vec![None]);
craft.success = crate::specs::Success::Pending;
// Try the first 4 steps
let vact = next_action_picker_1(&craft);
assert_eq!(vact, action_vec![ACTIONS.muscle_memory]);
craft.run_action(&ACTIONS.muscle_memory);
let vact = next_action_picker_1(&craft);
assert_eq!(vact, action_vec![ACTIONS.manipulation]);
craft.run_action(&ACTIONS.manipulation);
let vact = next_action_picker_1(&craft);
assert_eq!(vact, action_vec![ACTIONS.veneration]);
craft.run_action(&ACTIONS.veneration);
let vact = next_action_picker_1(&craft);
assert_eq!(vact, action_vec![ACTIONS.waste_not_ii, ACTIONS.groundwork]);
craft.run_action(&ACTIONS.waste_not_ii);
// Try the steps 5-8, deterministically
let vact = next_action_picker_1(&craft);
assert_eq!(vact, action_vec![ACTIONS.groundwork]);
craft.run_action(&ACTIONS.careful_synthesis);
let vact = next_action_picker_1(&craft);
assert_eq!(
vact,
action_vec![
ACTIONS.groundwork,
ACTIONS.basic_synthesis,
ACTIONS.careful_synthesis,
ACTIONS.delicate_synthesis
]
);
craft.run_action(&ACTIONS.careful_synthesis);
let vact = next_action_picker_1(&craft);
assert_eq!(
vact,
action_vec![
ACTIONS.groundwork,
ACTIONS.basic_synthesis,
ACTIONS.careful_synthesis,
ACTIONS.delicate_synthesis
]
);
craft.run_action(&ACTIONS.careful_synthesis);
let vact = next_action_picker_1(&craft);
assert_eq!(
vact,
action_vec![
ACTIONS.groundwork,
ACTIONS.basic_synthesis,
ACTIONS.careful_synthesis,
ACTIONS.delicate_synthesis
]
);
craft.run_action(&ACTIONS.careful_synthesis);
// Check odd parameters
craft.buffs.waste_not = 0;
craft.progression = 0;
let vact = next_action_picker_1(&craft);
assert_eq!(
vact,
action_vec![
ACTIONS.basic_synthesis,
ACTIONS.careful_synthesis,
ACTIONS.prudent_synthesis,
ACTIONS.delicate_synthesis
]
);
craft.run_action(&ACTIONS.delicate_synthesis);
let vact = next_action_picker_1(&craft);
assert_eq!(
vact,
action_vec![
ACTIONS.basic_synthesis,
ACTIONS.careful_synthesis,
ACTIONS.prudent_synthesis,
ACTIONS.delicate_synthesis,
ACTIONS.waste_not_ii,
ACTIONS.waste_not
]
);
craft.args.desperate = true;
let vact = next_action_picker_1(&craft);
assert_eq!(
vact,
action_vec![
ACTIONS.basic_synthesis,
ACTIONS.careful_synthesis,
ACTIONS.prudent_synthesis,
ACTIONS.delicate_synthesis,
ACTIONS.groundwork,
ACTIONS.masters_mend,
ACTIONS.waste_not_ii,
ACTIONS.waste_not
]
);
assert_eq!(craft.progression, 250);
assert_eq!(craft.quality, 266);
assert_eq!(craft.cp, 317);
}
#[test]
pub fn test_routes_p1() {
let craft = crate::craft::Craft::two_star();
let mut routes1 = generate_routes_phase1(craft);
for route in routes1.iter() {
println!("{:?}", route.actions);
}
// Literrally any change will break it
// An eq should be implmented to just check a vector of vector versus a route
assert_eq!(routes1.len(), 9);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.waste_not_ii,
&ACTIONS.groundwork,
&ACTIONS.delicate_synthesis,
&ACTIONS.delicate_synthesis
]
);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.waste_not_ii,
&ACTIONS.groundwork,
&ACTIONS.delicate_synthesis,
&ACTIONS.basic_synthesis,
]
);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.waste_not_ii,
&ACTIONS.groundwork,
&ACTIONS.careful_synthesis
]
);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.waste_not_ii,
&ACTIONS.groundwork,
&ACTIONS.basic_synthesis
]
);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.groundwork,
&ACTIONS.delicate_synthesis,
&ACTIONS.delicate_synthesis
]
);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.groundwork,
&ACTIONS.delicate_synthesis,
&ACTIONS.basic_synthesis
]
);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.groundwork,
&ACTIONS.prudent_synthesis
]
);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.groundwork,
&ACTIONS.careful_synthesis
]
);
let route = routes1.pop().unwrap();
assert_eq!(
route.actions,
vec![
&ACTIONS.muscle_memory,
&ACTIONS.manipulation,
&ACTIONS.veneration,
&ACTIONS.groundwork,
&ACTIONS.basic_synthesis
]
);
let route = routes1.pop();
assert!(route.is_none());
}
// Test Custom routes (None and basic synthesis)
#[test]
pub fn test_custom_p1_routes() {
// None route, no more actions
let mut craft = crate::craft::Craft::zero_star();
craft.success = crate::specs::Success::Failure;
let routes1 = generate_routes_phase1(craft.clone());
assert!(routes1.is_empty());
}
// Test step 2 route-finding
#[test]
pub fn test_second_step() {
let mut craft = crate::craft::Craft::two_star();
craft.cp = 10000;
let mut routes1 = generate_routes_phase1(craft);
let mut craft2 = routes1.pop().unwrap();
let vact = next_action_phase_2(&craft2);
assert_eq!(vact, action_vec![ACTIONS.innovation]);
craft2.run_action(&ACTIONS.innovation);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![ACTIONS.basic_touch, ACTIONS.preparatory_touch]
);
craft2.run_action(&ACTIONS.basic_touch);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![ACTIONS.preparatory_touch, ACTIONS.standard_touch]
);
craft2.run_action(&ACTIONS.standard_touch);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![ACTIONS.preparatory_touch, ACTIONS.advanced_touch]
);
craft2.run_action(&ACTIONS.advanced_touch);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![
ACTIONS.basic_touch,
ACTIONS.preparatory_touch,
ACTIONS.manipulation
]
);
craft2.run_action(&ACTIONS.manipulation);
let vact = next_action_phase_2(&craft2);
assert_eq!(vact, action_vec![ACTIONS.innovation]);
craft2.run_action(&ACTIONS.innovation);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![ACTIONS.basic_touch, ACTIONS.prudent_touch]
);
craft2.run_action(&ACTIONS.basic_touch);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![ACTIONS.prudent_touch, ACTIONS.standard_touch]
);
craft2.run_action(&ACTIONS.prudent_touch);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![ACTIONS.basic_touch, ACTIONS.prudent_touch]
);
craft2.run_action(&ACTIONS.prudent_touch);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![ACTIONS.basic_touch, ACTIONS.prudent_touch]
);
craft2.run_action(&ACTIONS.prudent_touch);
let vact = next_action_phase_2(&craft2);
assert_eq!(vact, action_vec![ACTIONS.innovation]);
craft2.run_action(&ACTIONS.innovation);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![ACTIONS.basic_touch, ACTIONS.prudent_touch]
);
craft2.run_action(&ACTIONS.prudent_touch);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![
ACTIONS.basic_touch,
ACTIONS.prudent_touch,
ACTIONS.trained_finesse,
ACTIONS.great_strides
]
);
craft2.run_action(&ACTIONS.great_strides);
let vact = next_action_phase_2(&craft2);
assert_eq!(
vact,
action_vec![
ACTIONS.basic_touch,
ACTIONS.prudent_touch,
ACTIONS.byregot_blessing
]
);
craft2.run_action(&ACTIONS.byregot_blessing);
craft2.success = crate::specs::Success::Success;
assert_eq!(next_action_phase_2(&craft2), vec![None]);
assert_eq!(craft2.progression, 3750);
assert_eq!(craft2.quality, 9899);
assert_eq!(craft2.cp, 9322);
}
#[test]
pub fn test_generate_routes_p2() {
let craft = crate::craft::Craft::two_star();
let mut routes1 = generate_routes_phase1(craft);
let craft1 = routes1.pop().unwrap();
let routes2 = generate_routes_phase2(craft1);
assert_eq!(routes2.unwrap().len(), 241);
// Any modification on the solving will break this test, same as before,
// maybe having a range of expected solution instead is the way to go.
// Nonetheless the solver test will add qualitative testing so some
// results will be thoughrouly checked
// Maybe sampling a handful results and expect them to always exits could also work
}

View File

@ -1,54 +1,106 @@
//! This modules instanciate all the tools needed to load and use the solver
use std::fmt::Debug; use std::fmt::Debug;
use strum_macros::EnumIter; use strum_macros::EnumIter;
/// The recipe to craft
/// On some websites the fields are instead called
/// [Progress, quality, durability, progress difficulty, quality difficulty, extra progress difficulty, extra quality difficulty]
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
pub struct Recipe { pub struct Recipe {
/// The recipe durability (also called solidity) (35, 40, 70 or 80 usually)
pub durability: u32, pub durability: u32,
/// The total recipe progress needed
pub progress: u32, pub progress: u32,
/// The total recipe quality
pub quality: u32, pub quality: u32,
/// How much the progress is hard to set,
/// it's an (hidden) extra progress multiplier,
/// inflicting a -10% to -30% to starred recipes
/// Also called `progress_difficulty`
pub progress_divider: u32, pub progress_divider: u32,
/// The same (hidden) difficulty multiplier, for quality
/// Also called `progress_difficulty`
pub quality_divider: u32, pub quality_divider: u32,
/// Modifies how much the base stats are affecting the craft progress
/// Also called `progress_extra_difficulty`
pub progress_modifier: u32, pub progress_modifier: u32,
/// Modifies how much the base stats are affectif the craft quality
/// Also called `quality_extra_difficulty`
pub quality_modifier: u32, pub quality_modifier: u32,
} }
/// The craftsman stats
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
pub struct Stats { pub struct Stats {
/// The craftsmanship, influences the progress
pub craftsmanship: u32, pub craftsmanship: u32,
/// The control, inluences the quality
pub control: u32, pub control: u32,
/// The amount of cp, ressource used for actions
pub max_cp: u32, pub max_cp: u32,
} }
/// The buffs available for the crafter
#[derive(Debug, Clone, Copy, PartialEq, EnumIter)] #[derive(Debug, Clone, Copy, PartialEq, EnumIter)]
pub enum Buff { pub enum Buff {
/// Gain a stack of Inner Quiet with every increase in quality, up to a maximum of 10.
/// Grants a 10% bonus to the efficiency of Touch actions for each stack.
InnerQuiet, InnerQuiet,
/// Reduces loss of durability by 50%.
WasteNot, WasteNot,
/// Increases the efficiency of next Touch action by 100%.
GreatStrides, GreatStrides,
/// Increases efficiency of Touch actions by 50%.
Innovation, Innovation,
/// Increases efficiency of Synthesis actions by 50%.
Veneration, Veneration,
/// Restores 5 points of durability after each step.
Manipulation, Manipulation,
/// Increases progress.
/// Efficiency: 300%
/// Success Rate: 100%
/// Additional Effect: Efficiency of your next Synthesis action is increased by 100%
/// Available only on the first step.
/// Additional effect is active for five steps.
MuscleMemory, MuscleMemory,
// v Hidden v // v Hidden v
/// (Hidden) Combo with Standart touch costs 18 cp.
BasicTouch, BasicTouch,
/// (Hidden) Combo with Advanced touch costs 18 cp.
StandardTouch, StandardTouch,
/// (Hidden) Do nothing for one step.
Observe, Observe,
} }
/// Keeps track of all the durations remaining on all buffs
/// Also called buff tracker in the docs
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
pub struct BuffState { pub struct BuffState {
/// Caps at 10 for a 100% extra efficiency in quality increase
pub inner_quiet: u8, pub inner_quiet: u8,
/// Lasts for four steps if Waste not was used, height if Waste Not II was.
pub waste_not: u8, pub waste_not: u8,
/// Effect active for three steps, dissipates after a quality action is used.
pub great_strides: u8, pub great_strides: u8,
/// Lasts four steps
pub innovation: u8, pub innovation: u8,
/// Lasts four steps.
pub veneration: u8, pub veneration: u8,
/// Lasts height steps
pub manipulation: u8, pub manipulation: u8,
/// Lasts five steps, dissipate after a progression action is used.
pub muscle_memory: u8, pub muscle_memory: u8,
/// Lasts one step
pub basic_touch: u8, pub basic_touch: u8,
/// Lasts one step
pub standard_touch: u8, pub standard_touch: u8,
/// Lasts one step
pub observe: u8, pub observe: u8,
} }
impl BuffState { impl BuffState {
/// Default state of buffs (all at zero) as per the beggining of craft
pub fn default() -> Self { pub fn default() -> Self {
Self { Self {
inner_quiet: 0, inner_quiet: 0,
@ -64,6 +116,7 @@ impl BuffState {
} }
} }
/// Remove the given buff from the buff tracker
pub fn remove(&mut self, buff: Buff) { pub fn remove(&mut self, buff: Buff) {
match buff { match buff {
Buff::InnerQuiet => self.inner_quiet = 0, Buff::InnerQuiet => self.inner_quiet = 0,
@ -79,6 +132,8 @@ impl BuffState {
} }
} }
/// Apply the given buff to the buff tracker for `value` steps
/// In the case of Inner Quiet, it inseads adds one to the stack counter
pub fn apply(&mut self, buff: Buff, value: u8) { pub fn apply(&mut self, buff: Buff, value: u8) {
match buff { match buff {
Buff::InnerQuiet => { Buff::InnerQuiet => {
@ -96,10 +151,11 @@ impl BuffState {
Buff::MuscleMemory => self.muscle_memory = value, Buff::MuscleMemory => self.muscle_memory = value,
Buff::BasicTouch => self.basic_touch = value, Buff::BasicTouch => self.basic_touch = value,
Buff::StandardTouch => self.standard_touch = value, Buff::StandardTouch => self.standard_touch = value,
Buff::Observe => self.standard_touch = value, Buff::Observe => self.observe = value,
} }
} }
/// Tick downs the remaining duration of all buffs, if up
pub fn tick(&mut self) { pub fn tick(&mut self) {
if self.waste_not > 0 { if self.waste_not > 0 {
self.waste_not -= 1; self.waste_not -= 1;
@ -128,9 +184,94 @@ impl BuffState {
} }
} }
#[derive(Debug, Clone, Copy, PartialEq)] /// State the craft is in, used to keep track of wether the craft
/// is to be worked on, added to the success vector or discarded
#[derive(Debug, Clone, PartialEq)]
pub enum Success { pub enum Success {
/// Pending success and therefor still ongoing
Pending, Pending,
/// Finised, not ongoing and finished without breaking (Doens't take quality into account)
Success, Success,
/// Finised because of lack of remaining durability
Failure, Failure,
} }
// Test unit
#[cfg(test)]
mod tests {
// Test default values
use pretty_assertions::assert_eq;
use strum::IntoEnumIterator;
#[test]
pub fn test_structs() {
format!(
"{:?}",
crate::specs::Recipe {
durability: 0,
progress: 0,
progress_divider: 0,
progress_modifier: 0,
quality: 0,
quality_divider: 0,
quality_modifier: 0,
}
.clone()
);
format!(
"{:?}",
crate::specs::Stats {
craftsmanship: 0,
control: 0,
max_cp: 0,
}
.clone()
);
let iq = crate::specs::Buff::InnerQuiet;
assert_eq!(crate::specs::Buff::InnerQuiet, iq);
for buff in crate::specs::Buff::iter() {
format!("{:?}", buff);
}
format!("{:?}", crate::specs::BuffState::default().clone());
let sc = crate::specs::Success::Pending;
assert!(crate::specs::Success::Pending == sc);
assert!(crate::specs::Success::Success != sc);
format!("{:?}", sc);
}
#[test]
pub fn test_buffstate() {
let mut bbs = crate::specs::BuffState::default();
for buff in crate::specs::Buff::iter() {
bbs.apply(buff, 2);
}
assert_eq!(bbs.inner_quiet, 2);
assert_eq!(bbs.waste_not, 2);
assert_eq!(bbs.great_strides, 2);
assert_eq!(bbs.innovation, 2);
assert_eq!(bbs.veneration, 2);
assert_eq!(bbs.manipulation, 2);
assert_eq!(bbs.muscle_memory, 2);
assert_eq!(bbs.basic_touch, 2);
assert_eq!(bbs.standard_touch, 2);
assert_eq!(bbs.observe, 2);
bbs.apply(crate::specs::Buff::InnerQuiet, 0);
bbs.apply(crate::specs::Buff::Innovation, 5);
assert_eq!(bbs.inner_quiet, 0);
assert_eq!(bbs.innovation, 5);
bbs.apply(crate::specs::Buff::InnerQuiet, 2);
bbs.apply(crate::specs::Buff::InnerQuiet, 1);
assert_eq!(bbs.inner_quiet, 3);
bbs.tick();
assert_eq!(bbs.inner_quiet, 3);
assert_eq!(bbs.innovation, 4);
for buff in crate::specs::Buff::iter() {
bbs.remove(buff);
}
assert_eq!(bbs.inner_quiet, 0);
assert_eq!(bbs.innovation, 0);
}
}