docs: Update the guide for other scripts#120
Conversation
There was a problem hiding this comment.
Pull request overview
This PR significantly improves documentation for automation scripts in the Fate/Grand Order automation application. The author has rewritten multiple script documentation files to provide comprehensive guides with detailed workflows, settings explanations, and exit conditions. The updates also include minor improvements to the README noting enhanced NP level detection reliability.
Key Changes
- Complete documentation overhaul for 9 automation scripts with standardized structure including Overview, Workflow diagrams, Key Features, Settings tables, and Exit Reasons
- New documentation for the CE EXP Bomb script
- README updates noting migration progress and improved OCR reliability
Reviewed changes
Copilot reviewed 10 out of 29 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/scripts/auto-level-skills.md | Comprehensive rewrite with workflow diagrams, OCR level detection details, and exit state summaries |
| docs/scripts/auto-level-servant.md | Complete documentation including ascension/grail workflow and JP server auto-fill support |
| docs/scripts/auto-level-ce.md | Detailed guide for CE enhancement with filter configuration and smart sort features |
| docs/scripts/auto-level-append.md | Extended documentation covering unlock/upgrade workflows and server-specific append skill counts |
| docs/scripts/auto-ce-exp-bomb.md | New documentation explaining CE Bomb creation strategy and integration with FP Gacha |
| docs/other-scripts/support-image-maker.md | Complete guide for extracting support images including Grand Servant handling |
| docs/other-scripts/lottery.md | Comprehensive lottery automation documentation with present box overflow handling |
| docs/other-scripts/gift-box.md | Detailed guide for ember collection with OCR-based stack size filtering |
| docs/other-scripts/friend-point-gacha.md | Documentation for FP summon automation with inventory management |
| docs/assets/scripts/Lottery.png | New screenshot asset for lottery script settings dialog |
| README.md | Minor updates noting migration progress and improved PaddleOCR-based NP detection |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Technical Difficulties | ||
|
|
||
| - Ran out of QP | ||
| Unlike regular skills, append skills' screen have their level text unable to be read via OCR. Therefore, the script relies on counting upgrade attempts to track levels. |
There was a problem hiding this comment.
Grammatical issue: "have their level text unable to be read" should be "have their level text that is unable to be read" or more naturally "have level text that cannot be read via OCR".
| Unlike regular skills, append skills' screen have their level text unable to be read via OCR. Therefore, the script relies on counting upgrade attempts to track levels. | |
| Unlike regular skills, the append skills screen has level text that cannot be read via OCR. Therefore, the script relies on counting upgrade attempts to track levels. |
|
|
||
| - Use descriptive names for easy identification later | ||
| - For servants, include ascension or costume info | ||
| - Avoid special characters: `< > " | : * ? \ /` |
There was a problem hiding this comment.
The special characters should be properly escaped or formatted in markdown. Consider using code formatting or HTML entities for the characters.
| - Avoid special characters: `< > " | : * ? \ /` | |
| - Avoid special characters: `< > " | : * ? \\ /` |
| - Long Press on Lotto for faster opening of boxes. | ||
| - Find Appends on Support | ||
| - NP Level Detection | ||
| - NP Level Detection(Finally reliable thanks to PaddleOCR) |
There was a problem hiding this comment.
Missing space after "Detection" before the opening parenthesis. Should be "Detection (Finally" not "Detection(Finally".
| - NP Level Detection(Finally reliable thanks to PaddleOCR) | |
| - NP Level Detection (Finally reliable thanks to PaddleOCR) |
|
|
||
| - Support Appends | ||
| - NP Level Detection | ||
| - NP Level Detection(a bit more reliable with PaddleOCR) |
There was a problem hiding this comment.
Missing space after "Detection" before the opening parenthesis. Should be "Detection (a bit" not "Detection(a bit".
| - NP Level Detection(a bit more reliable with PaddleOCR) | |
| - NP Level Detection (a bit more reliable with PaddleOCR) |
| ### Grail Automation | ||
|
|
||
| - There's no plan to support automatic grailing | ||
| - After Grailing servant, you can run the script again to continue leveling |
There was a problem hiding this comment.
Missing article "a" before "servant". Should be "After Grailing a servant" for consistency with other documentation.
| - After Grailing servant, you can run the script again to continue leveling | |
| - After Grailing a servant, you can run the script again to continue leveling |
|
|
||
|  | ||
|
|
||
|  |
There was a problem hiding this comment.
The image reference path appears to be inconsistent. Line 88 references ../assets/other-scripts/lottery.png while line 90 references ../assets/scripts/Lottery.png (note the different subdirectory and capitalization). Verify that both image files exist at their respective paths.
|  | |
|  |
1 participant
Finally motivated a bit to actually do this.