Skip to content

Commit fb827ba

Browse files
ArthurKun21ArthurKun21
authored
docs: Update mkdocs (#121)
1 parent cf3a1da commit fb827ba

23 files changed

Lines changed: 634 additions & 77 deletions

‎.vscode/.markdownlint.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"MD007": {
3+
"indent": 4,
4+
"start_indent": 4,
5+
"start_indented": false
6+
},
7+
"MD033": {
8+
"allowed_elements": [
9+
"a",
10+
"img"
11+
]
12+
},
13+
"MD025": false,
14+
"MD013": false
15+
}

‎.vscode/settings.json‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,10 @@
1111
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
1212
"tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
1313
],
14-
"markdownlint.config": {
15-
"MD007": {
16-
"indent": 4
17-
},
18-
"MD033": {
19-
"allowed_elements": [
20-
"a",
21-
"img"
22-
]
23-
}
24-
},
14+
"markdownlint.configFile": ".vscode/.markdownlint.json",
15+
"markdown.extension.list.indentationSize": "inherit",
16+
"[markdown]": {
17+
"editor.formatOnSave": true,
18+
"editor.tabSize": 4
19+
}
2520
}

‎docs/app/.meta.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
title: App Configuration
2+
icon: material/cog
3+
description: FGA Preview app configuration and settings. Requirements, appearance, storage, advanced options, and fine-tuning for optimal performance.
14
search:
25
boost: 1

‎docs/app/advanced.md‎

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,78 @@
1+
---
2+
title: Advanced Settings
3+
description: Configure FGA Preview advanced settings. Service automation, game area customization, permissions, and debugging options for power users.
4+
tags:
5+
- app
6+
- settings
7+
- advanced
8+
- debug
9+
- permissions
10+
---
11+
112
# Advanced Settings
213

3-
Currently work-in-progress.
14+
## Overview
15+
16+
Advanced Settings give you control over automation behavior, screen detection boundaries, Android permissions, and debugging options. Most users can leave these at their defaults, but they become useful when troubleshooting detection issues or running on devices with unusual screen layouts.
17+
18+
## Key Features
19+
20+
### Stop accessibility service when the script finishes
21+
22+
Enable **Auto stop accessibility service** to shut down the accessibility service automatically after stopping service. This ensures there would be no memory leaks and accessibility service would run fresh the next time you start it.
23+
24+
### Launch the service automatically with the app
25+
26+
Turn on **Auto start service** to begin the overlay and accessibility service as soon as you open the app. This saves a tap and gets you into farming faster.
27+
28+
### Adjust the game area detection mode
29+
30+
FGA needs to know where the game is drawn on screen to tap correctly. Three modes are available:
31+
32+
| Mode | When to use |
33+
| ------- | ------------------------------------------------------------------------------------ |
34+
| Default | Works for most phones in single-app view. |
35+
| Duo | Use if you run FGO in a split-screen or floating window alongside another app. |
36+
| Custom | Manually set pixel offsets (left, right, top, bottom) when detection problems occur. |
37+
38+
Custom offsets can compensate for navigation bars, notches, or display cutouts that shift the game image.
39+
40+
### Use thresholded stage counter
41+
42+
Enable this option if FGA has trouble reading the stage counter on some quests. The thresholded mode applies extra image processing to improve accuracy on low-contrast or stylized screens.
43+
44+
### Ignore play button detection warning
45+
46+
Turn this on to suppress the warning that appears when FGA cannot confidently detect the play button. Only enable it if you understand the risk of mis-taps and have verified detection manually.
47+
48+
### Manage system permissions
49+
50+
FGA requires several Android permissions to function correctly:
51+
52+
- **Notifications** – Required to display progress and completion alerts.
53+
- **Ignore battery optimization** – Keeps the service alive during long farming sessions. Without this, Android may pause FGA to save power.
54+
- **Display over other apps (Overlay)** – Allows the floating control panel to appear on top of the game.
55+
56+
Tap each permission row to open the relevant Android settings screen.
57+
58+
### Dump crash logs for troubleshooting
59+
60+
If FGA crashes or behaves unexpectedly, tap **Dump crash logs** to save diagnostic information. Share the resulting file when reporting bugs so developers can investigate.
61+
62+
### Enable debug mode
63+
64+
**Debug mode** shows extra status messages and logs internal actions. Use it when diagnosing problems; disable it afterward because it can slow down the script and clutter the log.
65+
66+
## Tips for Best Results
67+
68+
- Grant **Ignore battery optimization** if FGA stops during very long runs (over one hour).
69+
- After changing game area offsets, run a short test quest to confirm taps land correctly.
70+
- Leave **Debug mode** off unless actively troubleshooting, since extra logging increases overhead.
71+
- **Accessibility service** must always be turned off after every farming session to ensure it would run without issues the next time you start it.
72+
73+
## Troubleshooting
74+
75+
- **Taps land in the wrong place:** Switch to Custom game area mode and adjust offsets until taps align.
76+
- **Service keeps stopping:** Ensure Ignore battery optimization is enabled and no task-killer app is blocking FGA.
77+
- **Overlay does not appear:** Open **Display over other apps** permission and grant access to FGA Preview.
78+
- **Stage counter reads incorrectly:** Enable thresholded stage counter and re-run the quest.

‎docs/app/appearance.md‎

Lines changed: 71 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,78 @@
1-
# Appearance
1+
---
2+
title: Appearance Settings
3+
description: Customize FGA Preview appearance settings. Configure theme (light/dark/system), language preferences, and date/time formatting for the app interface.
4+
tags:
5+
- app
6+
- settings
7+
- theme
8+
- language
9+
- date-time
10+
---
211

3-
This is where you setup the theme and language of the app.
12+
# Appearance Settings
413

5-
![Appearance Settings](../assets/app/appearance.png)
14+
## Overview
615

7-
## Theme
16+
Appearance Settings control how the app looks and displays information. You can pick a color theme, change the interface language, and choose how dates and times are formatted. These options are cosmetic and do not affect automation behavior.
817

9-
You can choose between a light, dark or system theme for the app. The default is System.
18+
## Key Features
1019

11-
## Language
20+
### Choose your preferred language
1221

13-
You can select the language for the app's interface. The available languages are:
22+
Select the language for all menus, labels, and messages in the app. Available languages:
1423

15-
- English
16-
- Japanese
17-
- Korean
18-
- Chinese
19-
- Taiwanese
20-
- Vietnamese
24+
| Language | Code |
25+
| ------------------------------ | ----- |
26+
| English | en |
27+
| Japanese | ja |
28+
| Korean | ko |
29+
| Chinese (Simplified) | zh-CN |
30+
| Chinese (Traditional / Taiwan) | zh-TW |
31+
| Vietnamese | vi |
32+
33+
The app restarts briefly after changing the language.
34+
35+
### Set the color theme
36+
37+
Pick a theme that matches your preference or environment:
38+
39+
| Theme | Description |
40+
| ------ | -------------------------------------------------------------- |
41+
| Light | Bright backgrounds with dark text. |
42+
| Dark | Dark backgrounds with light text, easier on the eyes at night. |
43+
| System | Follows your device's system-wide dark-mode setting. |
44+
45+
### Show relative time
46+
47+
Enable **Use relative time** to display timestamps like "5 minutes ago" or "yesterday" instead of exact dates. This makes recent activity easier to scan at a glance.
48+
49+
### Use 24-hour clock format
50+
51+
Toggle **24-hour format** on to display times such as 14:30 instead of 2:30 PM. This is common in military and many international contexts.
52+
53+
### Select a date format
54+
55+
Pick a date style that matches your region:
56+
57+
| Format | Example |
58+
| ------------ | ------------------ |
59+
| Default | Uses device locale |
60+
| MM/dd/yy | 12/06/25 |
61+
| dd/MM/yy | 06/12/25 |
62+
| yyyy-MM-dd | 2025-12-06 |
63+
| dd MMM yyyy | 06 Dec 2025 |
64+
| MMM dd, yyyy | Dec 06, 2025 |
65+
66+
The preview in the settings shows a live example of your chosen format.
67+
68+
## Tips for Best Results
69+
70+
- Use **System** theme to automatically switch between light and dark based on your phone's schedule.
71+
- Pick a date format that matches how you read dates locally so config timestamps are intuitive.
72+
- Relative time is handy when sorting by "recently used" in the Library, since you can see how long ago a config ran.
73+
74+
## Troubleshooting
75+
76+
- **Language change did not apply:** The app may need a manual restart if it fails to refresh automatically.
77+
- **Theme flickers or looks wrong:** Force-close the app and reopen it to reload the theme correctly.
78+
- **Date format shows wrong example:** Ensure your device's system locale is set correctly, then re-select the format.

‎docs/app/fine-tune.md‎

Lines changed: 124 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,126 @@
1+
---
2+
title: Fine Tune Settings
3+
description: Fine tune FGA Preview performance settings. Adjust click delays, swipe speeds, image matching thresholds, and timing parameters.
4+
tags:
5+
- app
6+
- settings
7+
- fine-tune
8+
- performance
9+
---
10+
111
# Fine Tune Settings
212

3-
Currently work-in-progress.
13+
Adjust timing, sensitivity, and performance parameters to optimize FGA on your device.
14+
15+
## Overview
16+
17+
The Fine Tune screen provides advanced control over FGA's automation behavior. These settings allow you to customize how fast FGA interacts with the game, how strictly it matches images, and how it handles scrolling. While the default settings work for most users, fine-tuning can help resolve specific issues or improve efficiency on different devices.
18+
19+
## Key Features
20+
21+
- **Timing Control**: Adjust specific delays for clicks, swipes, and skills to match your device's speed.
22+
- **Detection Sensitivity**: Customize similarity thresholds for image recognition.
23+
- **Scroll Behavior**: Modify how FGA searches through lists.
24+
- **Performance Optimization**: Balance CPU usage and detection speed.
25+
26+
## How to Access
27+
28+
1. Open the FGA app.
29+
2. Tap **Fine Tune** (usually represented by a sliders icon or in the main menu).
30+
31+
---
32+
33+
## Support Settings
34+
35+
Control how FGA searches through the support list.
36+
37+
| Setting | Default | Range | Description |
38+
| :--- | :--- | :--- | :--- |
39+
| **Swipes Per Update** | 10 | 0-35 | Number of times FGA swipes down the support list before refreshing. **Tip**: Use lower values if your preferred support is usually near the top. |
40+
| **Max Updates** | 25 | 0-35 | Maximum number of times FGA will refresh the support list before giving up. **Tip**: Set higher if you are looking for a rare support setup. |
41+
42+
## Similarity Settings
43+
44+
Control how strictly FGA matches images.
45+
46+
| Setting | Default | Range | Description |
47+
| :--- | :--- | :--- | :--- |
48+
| **Minimum Similarity** | 80% | 50-100% | How closely an image must match for FGA to consider it a match. **Tip**: Decrease if FGA fails to recognize buttons; increase if it clicks the wrong things. |
49+
| **MLB Similarity** | 70% | 50-100% | Threshold for detecting Max Limit Broken (MLB) Craft Essences. **Tip**: Lower slightly if FGA misses MLB stars due to screen brightness or rendering. |
50+
| **Stage Counter Similarity** | 85% | 50-100% | Threshold for detecting the wave/stage counter during battle. **Tip**: Adjust if FGA misidentifies the current wave. |
51+
52+
## Optimization Settings
53+
54+
Performance tuning options for the automation engine.
55+
56+
| Setting | Default | Range | Description |
57+
| :--- | :--- | :--- | :--- |
58+
| **Parallel Card Check** | 3 | 1-5 | Number of command cards to analyze simultaneously. **Tip**: Higher values are faster but use more CPU. Lower this if your device overheats or lags. |
59+
60+
## Click Settings
61+
62+
Control tap and click behavior.
63+
64+
| Setting | Default | Range | Description |
65+
| :--- | :--- | :--- | :--- |
66+
| **Wait After Clicking** | 300ms | 0-2000ms | Time to wait after each click before proceeding. **Tip**: Increase if the game has slow animations or network lag. |
67+
| **Click Duration** | 50ms | 1-200ms | How long each tap is held down. **Tip**: Increase if clicks are not registering on your device. |
68+
| **Click Delay** | 10ms | 0-50ms | Delay between the start of a click action and the actual touch event. |
69+
| **Lotto Clicks** | 20 | 10-20 | Number of clicks per lottery spin action. |
70+
71+
## Swipe Settings
72+
73+
Control swipe and scroll behavior.
74+
75+
| Setting | Default | Range | Description |
76+
| :--- | :--- | :--- | :--- |
77+
| **Wait After Swiping** | 700ms | 50-3000ms | Time to wait after each swipe before proceeding. **Tip**: Increase if scrolling happens before images fully load. |
78+
| **Swipe Duration** | 300ms | 50-1000ms | How long each swipe gesture takes to complete. |
79+
| **Swipe Multiplier** | 100% | 50-200% | Multiplies the distance of every swipe. **Tip**: Adjust if FGA scrolls past too many items or not enough. |
80+
81+
## Drag Settings
82+
83+
Control drag-and-drop behavior (used for card selection and adjustments).
84+
85+
| Setting | Default | Range | Description |
86+
| :--- | :--- | :--- | :--- |
87+
| **Long Press Duration** | 750ms | 500-3000ms | Time to hold before a press matches a "long press". |
88+
| **Drag Duration** | 50ms | 50-1000ms | How long drag gestures take to complete. |
89+
90+
## Wait Settings
91+
92+
Control delays during battle and general script execution.
93+
94+
| Setting | Default | Range | Description |
95+
| :--- | :--- | :--- | :--- |
96+
| **Skill Delay** | 500ms | 0-2000ms | Wait time after using a skill before the next action. **Tip**: Increase if skills are skipped or the script moves too fast during skill chains. |
97+
| **Wait Before Turn** | 500ms | 0-2000ms | Wait time at the start of each turn (allows animations to finish). |
98+
| **Wait Before Cards** | 2000ms | 0-6000ms | Wait time before reading command cards. **Tip**: Critical for card detection. Increase if cards are misread or the attack screen loads slowly. |
99+
| **Wait Multiplier** | 100% | 50-200% | Multiplies all wait times globally. **Tip**: Use this (>100%) to quickly slow down the entire script without changing individual settings. |
100+
| **Wait at Tips Screen** | 10s | 5-15s | How long to wait when the loading tips screen appears. |
101+
102+
---
103+
104+
## Tips for Best Results
105+
106+
1. **Start with defaults**: The default values are tuned for the majority of devices. Only change them if you encounter a specific problem.
107+
2. **Change one thing at a time**: Modify one setting, test the script, and observe the result. This makes it easier to tell what worked.
108+
3. **Use the Wait Multiplier**: If the script is generally too fast for your device, try setting **Wait Multiplier** to 110% or 120% first.
109+
4. **Reset if stuck**: Use the **RESET** button next to any setting to return it to the default value if you mess up.
110+
5. **Network affects timing**: If you are on a slow connection, you might need to increase **Wait After Swiping** and **Wait After Clicking**.
111+
112+
## Troubleshooting
113+
114+
| Problem | Solution |
115+
| :--- | :--- |
116+
| **Script running too fast / Clicks ignored** | Increase **Wait After Clicking** or increase **Wait Multiplier** globally. |
117+
| **Support list scrolling is erratic** | Increase **Swipe Duration** or **Wait After Swiping** (if images take time to load). |
118+
| **FGA doesn't see Supports** | Increase **Swipes Per Update** or slightly decrease **Minimum Similarity** (e.g., to 75%). |
119+
| **FGA clicks wrong cards/skills** | Increase **Skill Delay**, **Wait Before Cards**, or adjust **Parallel Card Check**. |
120+
| **Buttons are not detected** | Decrease **Minimum Similarity** and ensure no overlays (like blue light filters) are interfering. |
121+
122+
## Related Documentation
123+
124+
- [Battle Launcher](../battle-setup/launcher.md)
125+
- [Preferred Support](../battle-setup/support.md)
126+
- [Auto Battle](../in-battle/auto-battle.md)

0 commit comments

Comments
 (0)