Merge of the Doc #22
|
|
@ -7,6 +7,7 @@ expected_values.md
|
|||
releases/*
|
||||
.whl
|
||||
pyinstaller_log.txt
|
||||
llvm/*
|
||||
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
|
|
|
|||
|
|
@ -63,6 +63,22 @@ dependencies = [
|
|||
"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]]
|
||||
name = "errno"
|
||||
version = "0.2.8"
|
||||
|
|
@ -192,6 +208,15 @@ version = "6.4.1"
|
|||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
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]]
|
||||
name = "parking_lot"
|
||||
version = "0.12.1"
|
||||
|
|
@ -215,6 +240,18 @@ dependencies = [
|
|||
"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]]
|
||||
name = "proc-macro-error"
|
||||
version = "1.0.4"
|
||||
|
|
@ -553,13 +590,20 @@ checksum = "447660ad36a13288b1db4d4248e857b510e8c3a225c822ba4fb748c0aafecffd"
|
|||
|
||||
[[package]]
|
||||
name = "xiv_csolver"
|
||||
version = "0.1.5"
|
||||
version = "0.2.0"
|
||||
dependencies = [
|
||||
"clap",
|
||||
"lazy_static",
|
||||
"pretty_assertions",
|
||||
"pyo3",
|
||||
"strum",
|
||||
"strum_macros",
|
||||
"threadpool",
|
||||
"toml",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "yansi"
|
||||
version = "0.5.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "09041cd90cf85f7f8b2df60c646f853b7f535ce68f85244eb6731cf89fa498ec"
|
||||
|
|
|
|||
14
Cargo.toml
|
|
@ -1,13 +1,13 @@
|
|||
[package]
|
||||
name = "xiv_csolver"
|
||||
version = "0.1.5"
|
||||
version = "0.1.6"
|
||||
edition = "2021"
|
||||
authors = ["谭俊健","Dandaedre","Vkyfox"]
|
||||
description = "Small XIV solver library in rust, with python and rust bindings"
|
||||
homepage = "https://proxy.dandaedre.com/gitea/Dandaedre/xiv_csolver"
|
||||
documentation = "https://proxy.dandaedre.com/gitea/Dandaedre/xiv_csolver"
|
||||
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
|
||||
|
||||
|
|
@ -27,6 +27,9 @@ pyo3 = { version = "0.18.0", features = ["extension-module"] }
|
|||
# [build]
|
||||
# target = ["x86_64-unknown-linux-gnu", "x86_64-unknown-windows-gnu"]
|
||||
|
||||
[dev-dependencies]
|
||||
pretty_assertions = "1"
|
||||
|
||||
[profile.release]
|
||||
panic = 'abort'
|
||||
opt-level = 3
|
||||
|
|
@ -39,13 +42,10 @@ no_python = [] # Removes the python bindings
|
|||
fast = [] # Remove some under optimisations that try to find other routes
|
||||
|
||||
[lib]
|
||||
name = "xiv_csolver_lib" # Pending rename xiv_csolver_lib
|
||||
name = "xiv_csolver_lib"
|
||||
path = "src/lib.rs"
|
||||
crate-type = ["cdylib","rlib"]
|
||||
|
||||
[[bin]]
|
||||
name = "xiv_csolver_cli"
|
||||
path = "src/bin/xiv_csolver.rs"
|
||||
|
||||
[tool.maturin]
|
||||
python-source = "python"
|
||||
path = "src/bin/xiv_csolver.rs"
|
||||
|
|
@ -23,6 +23,16 @@ install_crate = "rustfmt"
|
|||
command = "cargo"
|
||||
args = ["fmt", "--", "--emit=files"]
|
||||
|
||||
[tasks.testcov]
|
||||
script_runner = "@shell"
|
||||
ignore_errors = true
|
||||
script = [
|
||||
"mkdir -p coverage",
|
||||
"mkdir -p coverage/html",
|
||||
"CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' 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 '/*' -o coverage/html/"
|
||||
]
|
||||
|
||||
[tasks.clean]
|
||||
command = "cargo"
|
||||
args = ["clean"]
|
||||
|
|
|
|||
|
|
@ -4,6 +4,9 @@ A rust program for solving FFXIV craft recipe.
|
|||
Originaly written by [RikaKagurasaka](https://github.com/RikaKagurasaka/xiv_craft_solver),
|
||||
it now is widely improved and provides python bindings for a GUI (or anything else really)
|
||||
|
||||
|
||||

|
||||
|
||||
### Basic RUST CLI Usage
|
||||
Everything is done through the regular cargo interface
|
||||
1. Download the latest release.
|
||||
|
|
@ -43,6 +46,7 @@ Options:
|
|||
-V, --version
|
||||
Print version
|
||||
```
|
||||
|
||||
## Developpement
|
||||
Please remember to set and use a venv before building
|
||||
While not mandatory, using ``cargo-make`` will provide you with the commands:
|
||||
|
|
|
|||
2
Todo.md
|
|
@ -12,8 +12,10 @@
|
|||
✅ (PKG) Have cargo-make setup for release/cleanup/build
|
||||
✅ (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
|
||||
🟩 (GUI) Refactor code
|
||||
🟩 (GUI) Restore GUI state
|
||||
|
||||
# Roadmap
|
||||
## v1.0.0
|
||||
|
|
|
|||
|
|
@ -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: 10%">
|
||||
<title>coverage: 10%</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="#e05d44"/>
|
||||
<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">10%</text>
|
||||
<text x="775" y="140" transform="scale(.1)" fill="#fff" textLength="250">10%</text>
|
||||
</g>
|
||||
<script xmlns=""/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.3 KiB |
|
|
@ -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: 10%">
|
||||
<title>coverage: 10%</title>
|
||||
<g shape-rendering="crispEdges">
|
||||
<rect width="61" height="20" fill="#555"/>
|
||||
<rect x="61" width="35" height="20" fill="#e05d44"/>
|
||||
</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">10%</text>
|
||||
</g>
|
||||
<script xmlns=""/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 712 B |
|
|
@ -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: 10%">
|
||||
<title>COVERAGE: 10%</title>
|
||||
<g shape-rendering="crispEdges">
|
||||
<rect width="91" height="28" fill="#555"/>
|
||||
<rect x="91" width="51.5" height="28" fill="#e05d44"/>
|
||||
</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">10%</text>
|
||||
</g>
|
||||
<script xmlns=""/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 739 B |
|
|
@ -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: 10%">
|
||||
<title>coverage: 10%</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="#e05d44"/>
|
||||
<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">10%</text>
|
||||
<text x="775" y="130" transform="scale(.1)" fill="#fff" textLength="250">10%</text>
|
||||
</g>
|
||||
<script xmlns=""/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.4 KiB |
|
|
@ -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: 10%">
|
||||
<title>Coverage: 10%</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">10%</text>
|
||||
<text id="rlink" x="825" y="140" transform="scale(.1)" textLength="230">10%</text>
|
||||
</g>
|
||||
<script xmlns=""/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.7 KiB |
|
|
@ -0,0 +1 @@
|
|||
{"schemaVersion":1,"label":"coverage","message":"10%","color":"red"}
|
||||
|
|
@ -0,0 +1,129 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en-us">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Grcov report - top_level </title>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.1/css/bulma.min.css"></head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<nav class="breadcrumb is-right" aria-label="breadcrumbs">
|
||||
<ul><li class="is-active"><a href="#">top_level</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="level">
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Lines</p>
|
||||
<p class="title has-text-danger">
|
||||
<abbr title="118 / 1124">10.5 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Functions</p>
|
||||
<p class="title has-text-danger">
|
||||
<abbr title="32 / 347">9.22 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Branches</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="0 / 0">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<table class="table is-fullwidth">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Directory</th>
|
||||
<th class="has-text-centered" colspan="3">Line Coverage</th>
|
||||
<th class="has-text-centered" colspan="2">Functions</th>
|
||||
<th class="has-text-centered" colspan="2">Branches</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr>
|
||||
<th><a href="src/index.html">src</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="10.838831291234683"
|
||||
max="100">
|
||||
10.84%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
10.84%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
115 / 1061
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">8.53%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">29 / 340 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="src/bin/index.html">src/bin</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="1.639344262295082"
|
||||
max="100">
|
||||
1.64%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
1.64%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
1 / 61
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">20%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">1 / 5 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="tests/index.html">tests</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-success is-large"
|
||||
value="100"
|
||||
max="100">
|
||||
100%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-success p-2">
|
||||
100%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-success p-2">
|
||||
2 / 2
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">2 / 2 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<footer class="footer">
|
||||
<div class="content has-text-centered">
|
||||
<p class="heading">Date: 2023-03-01 23:03</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en-us">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Grcov report - src/bin </title>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.1/css/bulma.min.css"></head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<nav class="breadcrumb is-right" aria-label="breadcrumbs">
|
||||
<ul><li><a href="../index.html">top_level</a></li><li class="is-active"><a href="#">src/bin</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="level">
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Lines</p>
|
||||
<p class="title has-text-danger">
|
||||
<abbr title="1 / 61">1.64 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Functions</p>
|
||||
<p class="title has-text-danger">
|
||||
<abbr title="1 / 5">20 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Branches</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="0 / 0">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<table class="table is-fullwidth">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>File</th>
|
||||
<th class="has-text-centered" colspan="3">Line Coverage</th>
|
||||
<th class="has-text-centered" colspan="2">Functions</th>
|
||||
<th class="has-text-centered" colspan="2">Branches</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr>
|
||||
<th><a href="xiv_csolver.rs.html">xiv_csolver.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="1.639344262295082"
|
||||
max="100">
|
||||
1.64%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
1.64%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
1 / 61
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">20%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">1 / 5 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<footer class="footer">
|
||||
<div class="content has-text-centered">
|
||||
<p class="heading">Date: 2023-03-01 23:03</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en-us">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Grcov report - src </title>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.1/css/bulma.min.css"></head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<nav class="breadcrumb is-right" aria-label="breadcrumbs">
|
||||
<ul><li><a href="../index.html">top_level</a></li><li class="is-active"><a href="#">src</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="level">
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Lines</p>
|
||||
<p class="title has-text-danger">
|
||||
<abbr title="115 / 1061">10.84 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Functions</p>
|
||||
<p class="title has-text-danger">
|
||||
<abbr title="29 / 340">8.53 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Branches</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="0 / 0">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<table class="table is-fullwidth">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>File</th>
|
||||
<th class="has-text-centered" colspan="3">Line Coverage</th>
|
||||
<th class="has-text-centered" colspan="2">Functions</th>
|
||||
<th class="has-text-centered" colspan="2">Branches</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr>
|
||||
<th><a href="action.rs.html">action.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="0"
|
||||
max="100">
|
||||
0%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0 / 239
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">0%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">0 / 36 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="craft.rs.html">craft.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="0"
|
||||
max="100">
|
||||
0%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0 / 102
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">0%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">0 / 14 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="io.rs.html">io.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="53.77358490566038"
|
||||
max="100">
|
||||
53.77%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
53.77%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
114 / 212
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">13.4%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">28 / 209 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="lib.rs.html">lib.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="0.43478260869565216"
|
||||
max="100">
|
||||
0.43%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0.43%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
1 / 230
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">4.76%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">1 / 21 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="solver.rs.html">solver.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="0"
|
||||
max="100">
|
||||
0%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0 / 203
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">0%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">0 / 12 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="specs.rs.html">specs.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-danger is-large"
|
||||
value="0"
|
||||
max="100">
|
||||
0%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-danger p-2">
|
||||
0 / 75
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-danger p-2">0%</td>
|
||||
<td class="has-text-centered has-background-danger p-2">0 / 48 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<footer class="footer">
|
||||
<div class="content has-text-centered">
|
||||
<p class="heading">Date: 2023-03-01 23:03</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en-us">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Grcov report - tests </title>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.1/css/bulma.min.css"></head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<nav class="breadcrumb is-right" aria-label="breadcrumbs">
|
||||
<ul><li><a href="../index.html">top_level</a></li><li class="is-active"><a href="#">tests</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="level">
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Lines</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="2 / 2">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Functions</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="2 / 2">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Branches</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="0 / 0">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<table class="table is-fullwidth">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>File</th>
|
||||
<th class="has-text-centered" colspan="3">Line Coverage</th>
|
||||
<th class="has-text-centered" colspan="2">Functions</th>
|
||||
<th class="has-text-centered" colspan="2">Branches</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr>
|
||||
<th><a href="io.rs.html">io.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-success is-large"
|
||||
value="100"
|
||||
max="100">
|
||||
100%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-success p-2">
|
||||
100%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-success p-2">
|
||||
1 / 1
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">1 / 1 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="lib.rs.html">lib.rs</a></th>
|
||||
<!-- -->
|
||||
<td class="p-2">
|
||||
<progress
|
||||
class="progress is-success is-large"
|
||||
value="100"
|
||||
max="100">
|
||||
100%
|
||||
</progress>
|
||||
</td>
|
||||
<td class="has-text-centered has-background-success p-2">
|
||||
100%
|
||||
</td>
|
||||
<td class="has-text-centered has-background-success p-2">
|
||||
1 / 1
|
||||
</td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">1 / 1 </td>
|
||||
<!-- -->
|
||||
<td class="has-text-centered has-background-success p-2">100%</td>
|
||||
<td class="has-text-centered has-background-success p-2">0 / 0</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<footer class="footer">
|
||||
<div class="content has-text-centered">
|
||||
<p class="heading">Date: 2023-03-01 23:03</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en-us">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Grcov report - io.rs </title>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.1/css/bulma.min.css"></head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<nav class="breadcrumb is-right" aria-label="breadcrumbs">
|
||||
<ul><li><a href="../index.html">top_level</a></li><li><a href="./index.html">tests</a></li><li class="is-active"><a href="#">io.rs</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="level">
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Lines</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="1 / 1">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Functions</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="1 / 1">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Branches</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="0 / 0">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<div role="table" aria-label="Coverage report"><div class="columns p-0 m-0" role="row">
|
||||
<div
|
||||
class="column is-1 is-narrow p-0 has-text-centered"
|
||||
id="1"
|
||||
role="cell">
|
||||
<a href="#1">1</a>
|
||||
</div>
|
||||
<div
|
||||
class="column is-1 is-narrow p-0 has-text-centered has-text-success-light has-background-success"
|
||||
role="cell" aria-label="11">
|
||||
11
|
||||
</div>
|
||||
<div class="column has-background-success-light p-0"
|
||||
role="cell">
|
||||
<pre class="has-background-success-light py-0 px-2"></pre>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<footer class="footer">
|
||||
<div class="content has-text-centered">
|
||||
<p class="heading">Date: 2023-03-01 23:03</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en-us">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Grcov report - lib.rs </title>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.1/css/bulma.min.css"></head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<nav class="breadcrumb is-right" aria-label="breadcrumbs">
|
||||
<ul><li><a href="../index.html">top_level</a></li><li><a href="./index.html">tests</a></li><li class="is-active"><a href="#">lib.rs</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="level">
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Lines</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="1 / 1">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Functions</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="1 / 1">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="level-item has-text-centered">
|
||||
<div>
|
||||
<p class="heading">Branches</p>
|
||||
<p class="title has-text-success">
|
||||
<abbr title="0 / 0">100 %</abbr></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<div role="table" aria-label="Coverage report"><div class="columns p-0 m-0" role="row">
|
||||
<div
|
||||
class="column is-1 is-narrow p-0 has-text-centered"
|
||||
id="1"
|
||||
role="cell">
|
||||
<a href="#1">1</a>
|
||||
</div>
|
||||
<div
|
||||
class="column is-1 is-narrow p-0 has-text-centered has-text-success-light has-background-success"
|
||||
role="cell" aria-label="11">
|
||||
11
|
||||
</div>
|
||||
<div class="column has-background-success-light p-0"
|
||||
role="cell">
|
||||
<pre class="has-background-success-light py-0 px-2"></pre>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<footer class="footer">
|
||||
<div class="content has-text-centered">
|
||||
<p class="heading">Date: 2023-03-01 23:03</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -5,7 +5,7 @@ build-backend = "maturin"
|
|||
[project] # The rust bindings
|
||||
name = "xiv_csolver_lib"
|
||||
requires-python = ">=3.7"
|
||||
version = "0.1.5"
|
||||
version = "0.1.6"
|
||||
classifiers = [
|
||||
"Programming Language :: Rust",
|
||||
"Programming Language :: Python :: Implementation :: CPython",
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ authors = [
|
|||
{name="Dandaedre"},
|
||||
]
|
||||
requires-python = ">=3.7"
|
||||
version = "0.1.5"
|
||||
version = "0.1.6"
|
||||
license = {text="Mozilla Public License Version 2.0"}
|
||||
classifiers = [
|
||||
"Programming Language :: Rust",
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 248 KiB |
|
Before Width: | Height: | Size: 352 KiB |
154
src/action.rs
|
|
@ -1,24 +1,55 @@
|
|||
//! 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::specs::{Buff, Success};
|
||||
use lazy_static::lazy_static;
|
||||
#[allow(dead_code)]
|
||||
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 {
|
||||
/// The action name, in a human readable format, it will be used to generate a short_name
|
||||
pub name: String,
|
||||
/// The natural durability cost, without buff or reductions
|
||||
pub dur: u32,
|
||||
/// The cost in cp
|
||||
pub cp: u32,
|
||||
/// The amount of progression provided in percent (not the actual value added to the craft)
|
||||
pub progress: u32,
|
||||
/// The amount of quality provided in percent (not the acual value added to the craft)
|
||||
pub quality: u32,
|
||||
/// The name of the buff given, if any
|
||||
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,
|
||||
}
|
||||
|
||||
/// Builds an action based on an action
|
||||
///
|
||||
/// Made to initialize lazy_static and nothing more
|
||||
pub struct ActionBuilder {
|
||||
action: Action,
|
||||
}
|
||||
|
||||
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 {
|
||||
let mut short_name = name.to_string();
|
||||
short_name = short_name.replace("II", "2");
|
||||
|
|
@ -46,31 +77,46 @@ impl ActionBuilder {
|
|||
},
|
||||
}
|
||||
}
|
||||
/// Changes the durability consumption of an action
|
||||
pub fn dur(mut self, dur: u32) -> Self {
|
||||
self.action.dur = dur;
|
||||
self
|
||||
}
|
||||
|
||||
/// Changes the crafting points (cp) consumption of an action
|
||||
pub fn cp(mut self, cp: u32) -> Self {
|
||||
self.action.cp = cp;
|
||||
self
|
||||
}
|
||||
/// Changes the amount of progress of an action
|
||||
pub fn progress(mut self, progress: u32) -> Self {
|
||||
self.action.progress = progress;
|
||||
self
|
||||
}
|
||||
/// Changes the amount of quality of an action
|
||||
pub fn quality(mut self, quality: u32) -> Self {
|
||||
self.action.quality = quality;
|
||||
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 {
|
||||
self.action.buff = buff;
|
||||
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 {
|
||||
self.action
|
||||
}
|
||||
}
|
||||
|
||||
/// Custom implementation of the equality operator, it is used to compare actions during the
|
||||
/// the crafting process
|
||||
impl PartialEq for Action {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.cp == other.cp
|
||||
|
|
@ -80,10 +126,14 @@ impl PartialEq for Action {
|
|||
}
|
||||
}
|
||||
|
||||
/// A craft action, after compilation (with lazy_static)
|
||||
// no other actions should be created
|
||||
impl Action {
|
||||
/// Get the printable name of the action
|
||||
pub fn get_name(&self) -> String {
|
||||
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 {
|
||||
if self == &ACTIONS.standard_touch && _craft.buffs.basic_touch > 0 {
|
||||
return 18;
|
||||
|
|
@ -93,6 +143,8 @@ impl Action {
|
|||
};
|
||||
self.cp
|
||||
}
|
||||
/// 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**.
|
||||
pub fn get_durability_cost(&self, _craft: &Craft) -> u32 {
|
||||
if self == &ACTIONS.masters_mend {
|
||||
return 30;
|
||||
|
|
@ -109,6 +161,14 @@ impl Action {
|
|||
}
|
||||
dur
|
||||
}
|
||||
/// 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 {
|
||||
let mut prog = self.progress as f64;
|
||||
if self.dur == 20 && _craft.durability < self.get_durability_cost(_craft) as i32 {
|
||||
|
|
@ -123,6 +183,9 @@ impl Action {
|
|||
}
|
||||
(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 {
|
||||
let mut qual = self.quality as f64;
|
||||
if self == &ACTIONS.byregot_blessing {
|
||||
|
|
@ -141,9 +204,19 @@ impl Action {
|
|||
let iq_mult = (_craft.buffs.inner_quiet as f64 * 0.1) + 1.0;
|
||||
(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)> {
|
||||
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 {
|
||||
if self.get_cp_cost(_craft) > _craft.cp as u32 {
|
||||
return false;
|
||||
|
|
@ -170,32 +243,110 @@ impl Debug for Action {
|
|||
}
|
||||
}
|
||||
|
||||
/// The callable actionlist, to be used in conjunction with lazy_static
|
||||
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,
|
||||
/// 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,
|
||||
/// Increases progress.
|
||||
/// Efficiency: 120%
|
||||
/// Success Rate: 100%
|
||||
pub basic_synthesis: Action,
|
||||
/// Increases progress.
|
||||
/// Efficiency: 120%
|
||||
/// Success Rate: 100%
|
||||
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,
|
||||
/// 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,
|
||||
/// Increases both progress and quality.
|
||||
/// Efficiency: 100%
|
||||
/// Success Rate: 100%
|
||||
pub delicate_synthesis: Action,
|
||||
/// Increases quality.
|
||||
/// Efficiency: 100%
|
||||
/// Success Rate: 100%
|
||||
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,
|
||||
/// 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,
|
||||
/// 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,
|
||||
/// 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,
|
||||
/// Increases quality.
|
||||
/// Efficiency: 150%
|
||||
/// Success Rate: 100%
|
||||
/// Combo action: Standard Touch
|
||||
/// Combo bonus: CP cost reduced to 18
|
||||
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,
|
||||
/// Restores item durability by 30.
|
||||
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,
|
||||
/// Reduces loss of durability by 50% for the next eight steps.
|
||||
pub waste_not_ii: Action,
|
||||
/// Restores 5 points of durability after each step for the next eight steps.
|
||||
pub manipulation: Action,
|
||||
/// Increases efficiency of Synthesis actions by 50% for the next four steps.
|
||||
pub veneration: Action,
|
||||
/// Increases the efficiency of next Touch action by 100%.
|
||||
/// Effect active for three steps.
|
||||
pub great_strides: Action,
|
||||
/// Increases efficiency of Touch actions by 50% for the next four steps.
|
||||
pub innovation: Action,
|
||||
// Do nothing for one step.
|
||||
//pub observe: Action,
|
||||
// Increases progress.
|
||||
// Efficiency: 200%
|
||||
// Success Rate: 50%
|
||||
// Combo Action: Observe
|
||||
// Combo Bonus: Increases success rate to 100%
|
||||
//pub focused_synthesis: Action,
|
||||
}
|
||||
|
||||
/// Create all base actions as a default (for lazy_static)
|
||||
impl Default for ActionList {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
|
|
@ -300,5 +451,6 @@ impl Default for ActionList {
|
|||
}
|
||||
|
||||
lazy_static! {
|
||||
/// Initialize a static pseudo &Craft: ACTIONS
|
||||
pub static ref ACTIONS: ActionList = ActionList::default();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,100 @@
|
|||
// #![warn(missing_docs,unsafe_code,unstable_features,)]
|
||||
//! # 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`](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 clap::Parser;
|
||||
use std::time::Instant;
|
||||
|
|
|
|||
40
src/craft.rs
|
|
@ -1,24 +1,48 @@
|
|||
//! 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::specs::{Buff, BuffState, Recipe, Stats, Success};
|
||||
use crate::Parameters;
|
||||
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)]
|
||||
pub struct Craft<'a> {
|
||||
/// The recipe used, contains all needed information on the difficulty and target
|
||||
pub recipe: Recipe,
|
||||
/// The stats of the crafter
|
||||
pub stats: Stats,
|
||||
/// The buffs currently running
|
||||
pub buffs: BuffState,
|
||||
/// The step count, aka number of steps done from the beggining of the craft
|
||||
pub step_count: u32,
|
||||
/// The remaining durability
|
||||
pub durability: i32,
|
||||
/// The current progression
|
||||
pub progression: u32,
|
||||
/// The current quality
|
||||
pub quality: u32,
|
||||
/// The cp currently remaining
|
||||
pub cp: i32,
|
||||
/// Wether the craft has succeded, is pending sucess, or failed
|
||||
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>,
|
||||
/// 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,
|
||||
}
|
||||
|
||||
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> {
|
||||
Self {
|
||||
recipe,
|
||||
|
|
@ -35,13 +59,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 {
|
||||
let base_value = (self.stats.craftsmanship as f64 / 10.0)
|
||||
/ (self.recipe.progress_divider as f64 / 100.0)
|
||||
+ 2.0;
|
||||
(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 {
|
||||
let base_value = (self.stats.control as f64 / 10.0)
|
||||
/ (self.recipe.quality_divider as f64 / 100.0)
|
||||
|
|
@ -49,6 +78,15 @@ impl<'a> Craft<'a> {
|
|||
(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> {
|
||||
if !action.can_use(self) {
|
||||
self.success = Success::Failure;
|
||||
|
|
|
|||
183
src/io.rs
|
|
@ -1,3 +1,9 @@
|
|||
//! The main IO module
|
||||
//! For now it contains the python bindings, the Args bindings (for clap) and the struct
|
||||
//! needed to hold all parameters needed at runtime
|
||||
//!
|
||||
//! Moving the bindings and making them non mandatory is a WIP
|
||||
|
||||
use crate::Craft;
|
||||
use clap::Parser;
|
||||
use core::fmt::Display;
|
||||
|
|
@ -5,15 +11,27 @@ 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)]
|
||||
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,
|
||||
/// The level of verbosity from 0 to 3
|
||||
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,
|
||||
/// Wether to try every mesure to finish the craft or not
|
||||
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,
|
||||
}
|
||||
|
||||
/// The args passed to the CLI, used by clap to generate a nice argument parser
|
||||
#[derive(Parser, Debug, Clone)]
|
||||
#[command(author, version, about, long_about = None)]
|
||||
pub struct Args {
|
||||
|
|
@ -52,47 +70,61 @@ pub struct Args {
|
|||
|
||||
/// A final stripped down version of a craft
|
||||
/// used for final print and talking with python
|
||||
/// TODO: Half of these parameter are unique and SHOULD NOT be replicated on every solution
|
||||
#[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,
|
||||
}
|
||||
|
||||
/// Pretty display for SolverResult
|
||||
impl Display for SolverResult {
|
||||
fn fmt(&self, _f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
|
||||
println!("{:?}", self.actions);
|
||||
Ok(())
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
|
||||
write!(f, "{:?}", self.actions)
|
||||
}
|
||||
}
|
||||
|
||||
//#[pymethods]
|
||||
impl SolverResult {
|
||||
/// Create a SolverResult from a solution
|
||||
/// Using this returns a solution, usable by Python
|
||||
pub fn from_craft(
|
||||
craft: &Craft,
|
||||
step1_solutions: usize,
|
||||
|
|
@ -104,6 +136,7 @@ impl SolverResult {
|
|||
.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 {
|
||||
|
|
@ -136,6 +169,12 @@ impl SolverResult {
|
|||
|
||||
#[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 {
|
||||
|
|
@ -155,6 +194,8 @@ impl SolverResult {
|
|||
}
|
||||
}
|
||||
|
||||
/// Implement a pretty_print method
|
||||
/// Mainly used for debug purposes
|
||||
pub fn pretty_print(&self) {
|
||||
println!(
|
||||
"Quality: [{}/{}] | Durability: [{}/{}] | Cp : [{}/{}] | Steps : {}",
|
||||
|
|
@ -171,6 +212,7 @@ impl SolverResult {
|
|||
}
|
||||
|
||||
impl Parameters {
|
||||
/// Create parameters from the arguments parsed by clap
|
||||
pub fn from_args(args: &Args) -> Self {
|
||||
Self {
|
||||
depth: if args.desperate { 11 } else { 8 },
|
||||
|
|
@ -204,10 +246,37 @@ pub fn test_result() -> SolverResult {
|
|||
#[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(values: &PyAny) -> PyResult<Option<Vec<SolverResult>>> {
|
||||
// // Create Recipe
|
||||
// Create Recipe
|
||||
let recipe = Recipe {
|
||||
durability: values.getattr("durability")?.extract()?,
|
||||
progress: values.getattr("progress")?.extract()?,
|
||||
|
|
@ -238,3 +307,107 @@ pub fn solve_from_python(values: &PyAny) -> PyResult<Option<Vec<SolverResult>>>
|
|||
let res = solve_craft(recipe, stats, param);
|
||||
Ok(res)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use crate::io::Args;
|
||||
use crate::{Parameters, SolverResult};
|
||||
use clap::Parser;
|
||||
use pretty_assertions::{assert_eq, assert_ne};
|
||||
|
||||
impl PartialEq for Parameters {
|
||||
fn eq(&self, rhs: &Parameters) -> bool {
|
||||
(self.byregot_step == rhs.byregot_step)
|
||||
& (self.depth == rhs.depth)
|
||||
& (self.desperate == rhs.desperate)
|
||||
& (self.threads == rhs.threads)
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
pub fn test_parameters_derived_attributes() {
|
||||
let def = Parameters {
|
||||
byregot_step: 0,
|
||||
depth: 0,
|
||||
desperate: false,
|
||||
threads: 42,
|
||||
verbose: 1,
|
||||
};
|
||||
let def2 = def;
|
||||
let def3 = def2.clone();
|
||||
|
||||
assert_eq!(def2, def3);
|
||||
}
|
||||
|
||||
#[test]
|
||||
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 = 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);
|
||||
|
||||
// Test default parameters
|
||||
let a4 = Args::parse_from(["bobGZ"]);
|
||||
assert_eq!(a4.recipe_name, "default_recipe");
|
||||
assert_eq!(a4.character_name, "default_character");
|
||||
assert_eq!(a4.file_name, "craft.toml");
|
||||
assert_eq!(a4.verbose, 0);
|
||||
assert_eq!(a4.depth, 8);
|
||||
assert_eq!(a4.threads, 4);
|
||||
assert_eq!(a4.desperate, false);
|
||||
assert_eq!(a4.long, false);
|
||||
}
|
||||
|
||||
#[test]
|
||||
pub fn test_parameters() {}
|
||||
}
|
||||
|
|
|
|||
100
src/lib.rs
|
|
@ -1,3 +1,101 @@
|
|||
//! # 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`](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::io::SolverResult;
|
||||
use crate::{
|
||||
craft::Craft,
|
||||
|
|
@ -11,7 +109,7 @@ pub mod action;
|
|||
pub mod craft;
|
||||
pub mod io;
|
||||
mod solver;
|
||||
mod specs;
|
||||
pub mod specs;
|
||||
|
||||
/// Solve the craft with given arguments, this functions calls threads and must own it's values
|
||||
pub fn solve_craft<'a>(
|
||||
|
|
|
|||
61
src/specs.rs
|
|
@ -1,54 +1,106 @@
|
|||
//! This modules instanciate all the tools needed to load and use the solver
|
||||
|
||||
use std::fmt::Debug;
|
||||
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)]
|
||||
pub struct Recipe {
|
||||
/// The recipe durability (also called solidity) (35, 40, 70 or 80 usually)
|
||||
pub durability: u32,
|
||||
/// The total recipe progress needed
|
||||
pub progress: u32,
|
||||
/// The total recipe quality
|
||||
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,
|
||||
/// The same (hidden) difficulty multiplier, for quality
|
||||
/// Also called `progress_difficulty`
|
||||
pub quality_divider: u32,
|
||||
/// Modifies how much the base stats are affecting the craft progress
|
||||
/// Also called `progress_extra_difficulty`
|
||||
pub progress_modifier: u32,
|
||||
/// Modifies how much the base stats are affectif the craft quality
|
||||
/// Also called `quality_extra_difficulty`
|
||||
pub quality_modifier: u32,
|
||||
}
|
||||
|
||||
/// The craftsman stats
|
||||
#[derive(Debug, Clone, Copy)]
|
||||
pub struct Stats {
|
||||
/// The craftsmanship, influences the progress
|
||||
pub craftsmanship: u32,
|
||||
/// The control, inluences the quality
|
||||
pub control: u32,
|
||||
/// The amount of cp, ressource used for actions
|
||||
pub max_cp: u32,
|
||||
}
|
||||
|
||||
/// The buffs available for the crafter
|
||||
#[derive(Debug, Clone, Copy, PartialEq, EnumIter)]
|
||||
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,
|
||||
/// Reduces loss of durability by 50%.
|
||||
WasteNot,
|
||||
/// Increases the efficiency of next Touch action by 100%.
|
||||
GreatStrides,
|
||||
/// Increases efficiency of Touch actions by 50%.
|
||||
Innovation,
|
||||
/// Increases efficiency of Synthesis actions by 50%.
|
||||
Veneration,
|
||||
/// Restores 5 points of durability after each step.
|
||||
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,
|
||||
// v Hidden v
|
||||
/// (Hidden) Combo with Standart touch costs 18 cp.
|
||||
BasicTouch,
|
||||
/// (Hidden) Combo with Advanced touch costs 18 cp.
|
||||
StandardTouch,
|
||||
/// (Hidden) Do nothing for one step.
|
||||
Observe,
|
||||
}
|
||||
|
||||
/// Keeps track of all the durations remaining on all buffs
|
||||
/// Also called buff tracker in the docs
|
||||
#[derive(Debug, Clone, Copy)]
|
||||
pub struct BuffState {
|
||||
/// Caps at 10 for a 100% extra efficiency in quality increase
|
||||
pub inner_quiet: u8,
|
||||
/// Lasts for four steps if Waste not was used, height if Waste Not II was.
|
||||
pub waste_not: u8,
|
||||
/// Effect active for three steps, dissipates after a quality action is used.
|
||||
pub great_strides: u8,
|
||||
/// Lasts four steps
|
||||
pub innovation: u8,
|
||||
/// Lasts four steps.
|
||||
pub veneration: u8,
|
||||
/// Lasts height steps
|
||||
pub manipulation: u8,
|
||||
/// Lasts five steps, dissipate after a progression action is used.
|
||||
pub muscle_memory: u8,
|
||||
/// Lasts one step
|
||||
pub basic_touch: u8,
|
||||
/// Lasts one step
|
||||
pub standard_touch: u8,
|
||||
/// Lasts one step
|
||||
pub observe: u8,
|
||||
}
|
||||
|
||||
impl BuffState {
|
||||
/// Default state of buffs (all at zero) as per the beggining of craft
|
||||
pub fn default() -> Self {
|
||||
Self {
|
||||
inner_quiet: 0,
|
||||
|
|
@ -64,6 +116,7 @@ impl BuffState {
|
|||
}
|
||||
}
|
||||
|
||||
/// Remove the given buff from the buff tracker
|
||||
pub fn remove(&mut self, buff: Buff) {
|
||||
match buff {
|
||||
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) {
|
||||
match buff {
|
||||
Buff::InnerQuiet => {
|
||||
|
|
@ -100,6 +155,7 @@ impl BuffState {
|
|||
}
|
||||
}
|
||||
|
||||
/// Tick downs the remaining duration of all buffs, if up
|
||||
pub fn tick(&mut self) {
|
||||
if self.waste_not > 0 {
|
||||
self.waste_not -= 1;
|
||||
|
|
@ -128,9 +184,14 @@ impl BuffState {
|
|||
}
|
||||
}
|
||||
|
||||
/// 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, Copy, PartialEq)]
|
||||
pub enum Success {
|
||||
/// Pending success and therefor still ongoing
|
||||
Pending,
|
||||
/// Finised, not ongoing and finished without breaking (Doens't take quality into account)
|
||||
Success,
|
||||
/// Finised because of lack of remaining durability
|
||||
Failure,
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
|
||||
|
|
@ -0,0 +1 @@
|
|||
|
||||