Add wiki files to main repo so everyone can edit them

.github/workflows/ci.yml

@@ -10,6 +10,7 @@ on:
       - '*.md'
       - 'LICENSE'
       - 'custom-game-area/**'
+      - 'docs/**'
   push:
     branches:
       - master
@@ -23,6 +24,7 @@ on:
       - 'renovate.json'
       - 'custom-game-area/**'
       - 'FUNDING.yml'
+      - 'docs/**'
   workflow_dispatch:
 env:
   JAVA_VERSION: 17

.github/workflows/publish-wiki.yml

@@ -0,0 +1,22 @@
+name: Publish wiki
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'wiki/**'
+      - '.github/workflows/publish-wiki.yml'
+  workflow_dispatch:
+
+concurrency:
+  group: publish-wiki
+  cancel-in-progress: true
+permissions:
+  contents: write
+jobs:
+  publish-wiki:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: Andrew-Chen-Wang/github-wiki-action@v4

wiki/Donations.md

@@ -0,0 +1,58 @@
+You can donate over at [Ko-Fi](https://ko-fi.com/fategrandautomata). Your support will help keeping the project alive.
+
+Past supporters:
+
+|                                 |              |
+|---------------------------------|--------------|
+| Vítor Martins Salustiano        | R$ 100.00 BRL |
+| Fred Hong	                  | $ 50.00 USD  |
+| Ji Hoon Kim                     | $ 10.00 USD  |
+| Nathan Farrar                   | $ 5.00 USD   |
+| Federico Rapetti                | € 3.00 EUR   |
+| William Lu                      | $ 20.00 USD  |
+| @sleeping-player                | $ 100.00 USD |
+| Riya                            | $ 10.00 USD  |
+| Roman Furman                    | $ 5.00 USD   |
+| Georges FANG                    | $ 10.00 USD  |
+| Rysu                            | $ 25.00 USD  |
+| Golemming                       | $ 5.00 USD   |
+| Oscar Ezeigbk                   | $ 10.00 CAD  |
+| 1993                            | $ 10.00 USD  |
+| ---                             | $ 10.00 USD  |
+| @Whatwaq                        | Discord Nitro for a month |
+| Miles Chan                      | $ 5.00 USD   |
+| Matthew Uy                      | $ 5.00 USD   |
+| Viet Hong Vu                    | $ 5.00 USD   |
+| Zane                            | $ 10.00 USD  |
+| Brian R                         | $ 10.00 USD  |
+| Zhenjue Huang                   | $ 10.00 USD  |
+| Jelsin                          | $ 5.00 USD   |
+| Peng Xia                        | $ 6.00 USD   |
+| Hermann Probst                  | $ 10.00 USD  |
+| 赫 王                           | $ 1.00 USD   |
+| SHENKAI                         | $ 1.11 USD   |
+| 严​明                             | $ 10.00 USD |
+| Jürgen Blume                    | € 55.55 EUR |
+| Ibrahim Jadoon                  | $ 15.00 USD |
+| Meemoo .                        | $ 10.00 USD |
+| Frederic Baudoin                | $ 5.00 USD  |
+| Michael Allen                   | $ 20.00 AUD |
+| Billy Jaya                      | $ 20.00 USD |
+| Lê Trung Quân Lê Trung Quân     | $ 3.00 USD  |
+| Thinh Ha                        | $ 10.00 USD |
+| Vincent Tam                     | $ 10.00 USD |
+| ---                             | $ 57.25 USD |
+| itscakebuffet                   | $ 50.00 USD |
+| Trung                           | $ 3.00 USD  |
+| ---                             | $ 10.00 USD |
+| Rafael Stolarczyk               | $ 11.12 USD |
+| Junhao Zhu                      | $ 5.45 USD  |
+| Cipher                          | $ 4.00 USD  |
+| Kenneth Burcham                 | $ 10.00 USD |
+| ---                             | $ 50.00 USD |
+| Javier Alejandro Bahena Nuñez   | $ 4.57 USD |
+| Amir Fuhaira Bin Mohd Fuad      | $ 10.00 USD |
+| William Lu                      | $ 20.00 USD |
+| ZenMagus                        | $ 5.00 USD |
+| Eikel Perez | $ 5.00 USD |
+| Willard McDougal | $ 50.00 USD |

wiki/Fine-tune.md

@@ -0,0 +1,24 @@
+First things first, before reporting any issues, try resetting these to defaults. 
+The defaults should be good enough. Don't be too dumb when setting the values and complain to me that things don't work. Ideal values will vary between phones and potatoes.
+
+### Wait after clicking (ms)
+Delay after each click/tap unless clicking repeatedly. Some time is needed for the game's animations to finish.
+
+### Click duration (ms)
+Every tap/click is like a hold and release performed quickly. This sets the time difference between the two.
+
+### Multi-click delay (ms)
+Delay between individual taps/clicks when doing so repeatedly like at the end of battles, friend point summon and lottery script.
+
+### Wait after swiping (ms)
+Wait after all swipes.
+Right now, it is only used when searching for friend supports and in Gift Box script, but will also be used for cases where any other swipes get added in future. Some time is needed for the game's animations to finish.
+
+### Swipe duration (ms)
+Time taken to swipe. Swiping faster will scroll more, slower will scroll less.
+
+### Support Swipe Multiplier (%)
+Control the length of swipes in support screen. This multiples with the number of pixels to swipe over. Use along with swipe duration to tweak it to your needs.
+
+### Wait Multiplier (%)
+This multiples to every wait/delay. So, you can make the overall script slower/faster by using this.

wiki/Friend-Point-Summon.md

@@ -0,0 +1,13 @@
+Friend Point Summon script won't do the daily free summon. You have to do the daily free summon yourself.
+
+<img src="img/free-summon.png" width="500">
+
+It can start after you've done the daily free summon:
+
+<img src="img/fp.jpg" width="500">
+
+Or, you can also start it from the summon results screen:
+
+<img src="img/fp-new.jpg" width="500">
+
+This script won't start on Saint Quartz summon screen as a safeguard, unless you start from the summon results screen.

wiki/Game-Area-detection.md

@@ -0,0 +1,87 @@
+## How FGO should look with wide-screen update
+
+**JP, CN, KR, NA:** Should fill the entire screen including the notch.    
+**TW:** Turn ON `More options/Advanced/Ignore notch calculation` if FGO doesn't leave the notch area black.
+
+Only use Ignore Notch on TW servers, otherwise it has no effect.
+
+There should be no black bars on the screen.
+
+## FGO looks different on my phone
+
+### CASE 1: Borders around FGO are black
+
+On some devices, FGO isn't covering the full screen. This could be because of system settings or because of Android 12 Gesture Navigation.
+
+This is an example which causes problems for FGA:  
+<img src="img/samsung-black.jpg" width="300">
+
+If your device is made by Huawei, LG, Samsung or Xiaomi, you can fix the black bars with System Settings.
+
+Fullscreen settings per manufacturer:
+<table>
+  <tr>
+    <th>Manufacturer</th>
+    <th>Guide</th>
+  </tr>
+  <tr>
+    <td>Huawei</td>
+    <td>
+      <ul>
+        <li>Open <em>Settings</em> app</li>
+        <li>Go to <em>Display & brightness > More display settings > Full-Screen Display</em></li>
+        <li>Turn ON the switch for FGO</li>
+      </ul>
+    </td>
+  </tr>
+  <tr>
+    <td>LG</td>
+    <td>
+      <ul>
+        <li>Open <em>Settings</em> app</li>
+        <li>Go to <em>Display > App scaling</em></li>
+        <li>Set FGO to Full Screen</li>
+      </ul>
+    </td>
+  </tr>
+  <tr>
+    <td>Samsung</td>
+    <td>
+      <ul>
+        <li>Open <em>Settings</em> app</li>
+        <li>Search for and select <em>Full screen apps</em></li>
+        <li>Turn ON the switch for FGO</li>
+      </ul>
+    </td>
+  </tr>
+  <tr>
+    <td>Xiaomi</td>
+    <td>
+      <ul>
+        <li>Open <em>Settings</em> app</li>
+        <li>Go to <em>Display > Fullscreen mode</em></li>
+        <li>Turn ON the switch for FGO</li>
+      </ul>
+    </td>
+  </tr>
+</table>
+
+If you have any other device, try switching to 3-Button Navigation (Triangle, Circle, Square). If that doesn't work or you want to keep using Gesture Navigation Mode, check the [Custom Game Area megathread](https://github.com/Fate-Grand-Automata/FGA/issues/1347).
+
+### CASE 2: Your phone has borders around FGO even at the bottom of screen
+
+LGv60                                  | Google Pixel 4L
+---------------------------------------|-----------------------
+<img src="img/lg-v60.png" width="300"> | <img src="img/pixel-4L.png" width="300">
+
+The black border are for gesture navigation.
+
+To get rid of them:
+- Go to `Settings > System > Gestures > System Navigation`.
+- Change to `3-button navigation`.
+
+If that doesn't work, check the [Custom Game Area megathread](https://github.com/Fate-Grand-Automata/FGA/issues/1347).
+
+### CASE 3: Your phone is Android 7 or 8 and has a notch
+
+Notch detection is only possible on Android 9 and above. Either update your phone or find a way to disable notch in your phone's settings.

wiki/Gift-Box.md

@@ -0,0 +1,13 @@
+Gift Box script is just for receiving all Silver and some Gold embers from your present Box.
+
+![Lottery](https://cdn.discordapp.com/attachments/1117932403571294228/1137078014228824134/Screenshot_20230803-042802.png "Lottery UI - with Gift Box")
+![Gift Box](https://cdn.discordapp.com/attachments/1117932403571294228/1137078258874204331/Screenshot_20230803-042836.png "Lottery UI")
+___
+"Max Gold ember set size" setting explanation:
+___
+0 = For no gold ember (will only pick silver embers)
+Any number more than zero, will pick Gold embers that are lower or equal to the selected number.
+
+E.g.  Based on the images posted above,
+FGA will select Gold (and silver) embers that are equal to or less than 10.
+

wiki/Home.md

@@ -0,0 +1,16 @@
+Welcome to the Fate-Grand-Automata wiki!
+
+WIKI IS UNDER CONSTRUCTION
+
+#### Things we're absolutely against
+
+This app is only meant to automate repetitive farming battles.  
+We don't plan on supporting things that could possibly lead to the creation of bot accounts which need no supervision from users OR things that will be blatant violation of FGO's ToS.
+
+We won't provide support for:
+1. Re-rolling scripts
+2. Automatically logging in at the reset times
+3. Doing the story for you
+4. Messing with the game data or network connections
+5. Playing with screen turned OFF or FGO not in foreground
+6. Playing offline (someone did DM me for this if you're wondering)

wiki/Privacy-Policy.md

@@ -0,0 +1,8 @@
+We don't store your data. PERIOD.
+We don't even have a server to store them.
+
+What you do on your phone stays only on your phone or with the cloud backup providers you setup.
+
+The app doesn't have INTERNET permission either.
+
+For the crash reports on Google Play, we only get the Device model and the place in the code the error occurred and no other personal information that could be used to track you.

wiki/Running-on-Emulators.md

@@ -0,0 +1,32 @@
+## Nox
+
+On Nox, FGA needs Root to work since MediaProjection doesn't seem to work.
+
+- Make sure you're using an **Android 7** instance of Nox.
+  Use [MultiDrive](https://www.bignox.com/blog/how-to-run-multiple-android-instances-with-nox-app-player/) for managing/creating Nox instances.
+- Go to `More options` in the app and turn ON `Use Root for Screenshots`.
+- You also need to enable `Root` from Nox's settings. See [How to root Nox](https://www.bignox.com/blog/how-to-root-nox-app-player/).
+
+## Bluestacks
+
+These settings are tested, some other may also work:
+
+- Install Bluestacks X
+- Start the Multi-Instance Manager as Admin and create a 64-bit Pie instance in the 
+- DON'T use root for screenshots
+- Change to High Performance mode:
+  - Open Bluestack's settings
+  - Go to `Performance` tab.
+  - Set `Performancer mode` to `High Performance`
+  - Save settings and Restart Bluestacks.
+- Install FGA from the Play Store, not from Github
+- In order to start the FGA service, rotate the screen to portrait mode first. See [this comment](https://github.com/Fate-Grand-Automata/FGA/issues/967#issuecomment-974652785) for more details.
+
+## MEmu
+
+- Enable Root Mode in the MEmu's `Engine` settings
+- Enable `Use Root for Screenshots` under `More options` -> `Advanced`
+
+## LDPLAYER 
+
+- Works without needing any changes to ldplayer settings