readme revamp

readme.md

@@ -1,31 +1,37 @@
 # GBF Asset Lookup  
 [![pages-build-deployment](https://github.com/MizaGBF/GBFAL/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/MizaGBF/GBFAL/actions/workflows/pages/pages-build-deployment)  
-Web page to search for GBF assets.  
+Web page to search for Granblue Fantasy assets.  
 Click [Here](https://mizagbf.github.io/GBFAL) to access it.  
 
 ### Updater Requirements  
 * Python 3.11.
 * Run `pip install -r requirements.txt` in a command prompt.
 * See [requirements.txt](https://github.com/MizaGBF/GBFAP/blob/master/requirements.txt) for a list of third-party modules.  
 
-## Front-End  
-The project consists of a single HTML, javascript and css files.  
-[Github Pages](https://pages.github.com/) are used for hosting but it can technically be hosted anywhere.  
+# Front-End  
+There are two pages:  
+- The Asset Lookup, to search assets, consisting of one HTML, one javascript and one css files.  
+- The Spark Maker, for users to keep track of their "spark", which has its own HTML, javascript and css files too, on top of reusing the Asset Lookup javascript and css files. 
 
-## Back-End  
+> [!INFORMATION]  
+> These pages are static and are currently hosted on [Github Pages](https://pages.github.com/), but it can technically be hosted anywhere.  
+  
+# Back-End  
 Two of the JSON files in the `json` folder are the core of the system:  
 - [changelog.json](https://github.com/MizaGBF/GBFAL/blob/main/json/changelog.json) is the first file loaded upon opening the page. It contains the timestamp of the last update and a list of recently updated elements.  
 - [data.json](https://github.com/MizaGBF/GBFAL/blob/main/json/data.json) is loaded next and contains the data used to catalog all the assets, and more.  
 
 Others JSON files are used for debug or update purpose:  
 - [job_data_export.json](https://github.com/MizaGBF/GBFAL/blob/main/json/job_data_export.json) is used to quickly link some MC jobs to their weapon animations using the built-in CLI.  
-- [manual_lookup.json](https://github.com/MizaGBF/GBFAL/blob/main/json/manual_lookup.json) is used to fill lookup entries without wiki data.
+- [manual_lookup.json](https://github.com/MizaGBF/GBFAL/blob/main/json/manual_lookup.json) is used to fill lookup entries without wiki data.  
 
-More JSON files not specified here might appear in this folder.  
+More JSON files not specified here might appear in this folder, for development or testing purpose.  
 
-## [updater.py](https://github.com/MizaGBF/GBFAL/blob/main/updater.py)  
+# [updater.py](https://github.com/MizaGBF/GBFAL/blob/main/updater.py)  
 This script is in charge of updating the JSON files.  
-Do note than using it can be time and bandwidth consuming and the code isn't always optimized (especially for recent additions).  
+> [!CAUTION]  
+> Using it can be time and bandwidth consuming.  
+  
 Running `python updater.py` without any parameters will give you an up-to-date list of parameters, but here's a description of them at the time of writing this README:
 Start parameters:
 - `-wait`: Wait for GBF to update before running.  
@@ -58,8 +64,34 @@ Action parameters (Only one of those can be used at a time):
 - `-buff`: Update all buff datas. Time consuming.  
 - `-bg`: Update all background datas. Time consuming.  
 
-## Other Informations  
+> [!TIP]  
+> For an "every day" use case, you'll only need:  
+> Use `-run` after game updates.  
+> Use `-update` for element uncaps or if an older NPC got new arts, with their IDs.  
+> Use `-eventedit` if a new event didn't get its thumbnail automatically set.  
+> Use `-job` and `-jobedit` when new MC classes or skins are released to find and set their datas.  
+  
+> [!TIP]  
+> For maintenance purpose, you might need the following, once in a while:  
+> Use `-lookup` to manually update the lookup table. It's usually called automatically after `-update`.  
+> Use `-scenefull` or its variants to update specific scene files. For example, if a new file name has been noticed to be missing, you can add the related suffixes in `updater.py` to `SCENE_SUFFIXES` and then run `-scenefull` followed by the suffix to only search for those files and save on time and bandwidth. This commands supports resuming.  
+> Use `-sound` to update sound files. Unlike `-scenefull`, you can't search for specific files but you can set IDs to update. Or you can `update_chara_sound_file_prep` in `updater.py` to reduce the scope to certain files and save time.  This commands supports resuming.  
+> Use `-buff` to update old buffs with their new variants.  
+  
+# Pause  
+You can pause `updater.py` with a simple `CTRL+C`. It opens a CLI letting you save, exit or resume with text commands.  
+It'll also show you the current number of cleared tasks.  
+This number can be provided to some commands (like `-scenefull` and `-sound`) to resume later.  
+
+> [!TIP] 
+> For example, let's say you must stop `-scenefull`.
+> Do `CTRL+C`. Type `save` to save any pending changes.  
+> Take note of the current State shown. For our example, let's say it's 3547/11763.  
+> If you wish to resume this command later, you can do `python updater.py -scenefull 3500`, plus whatever other parameters you used for that command.  
+> Due to the asynchronous nature of the script, always use a slightly lower number (3500 for 3547 in this example) to be sure to catch any non completed tasks.  
+  
+# Additional Notes   
 - Use one of the `server` scripts to start a Python HTTP server and test the project locally, in your web browser.  
-- On other OS, just run `python-m http.server` in a terminal, in the project folder.  
+- Or, on other OS, just run `python-m http.server` in a terminal, in the project folder.  
 - [GBFAP](https://github.com/MizaGBF/GBFAP) is the sister project, dealing with character animations.  
-- For developpers, I documented some things in this [file](https://github.com/MizaGBF/GBFAL/blob/main/docs.md).  
+- For developers, I documented some things in this [file](https://github.com/MizaGBF/GBFAL/blob/main/docs.md).