feat: intro page

docs/_index.md

@@ -6,6 +6,8 @@ This is main documentation page with general info. See sidebar links for [usage]
 
 Download [latest release](https://github.com/rfg-modding/SyncFaction/releases) and place .exe in game folder. That's it!
 
+Also check out [introduction for new players](intro.md) - it's a quickstart guide for anyone wondering if multiplayer is still alive.
+
 > You will need at least **40GiB** of free storage space
 
 ## Features

docs/dev_mode.md

@@ -16,7 +16,7 @@ If you have any issues and want to *help us help you help us all*, press `Genera
 * `Multithreading`: uncheck to make certain operations single-threaded if your PC lags while SF works with files or network
 * `Use CDN`: **some** files from FF are mirrored to SyncFaction CDN. If a file is not mirrored to SF CDN, it is downloaded from FF anyway. If your downloads are slow, uncheck and see if there is any improvement. Maybe downloading directly from FF works better for you.
 
-## Restore
+## Tools
 
 To quickly switch between heavliy-modded and clean MP-compatible game, there are 3 buttons:
 
@@ -35,6 +35,7 @@ Be careful, these options tamper with SF logic and will break your warranty beca
   * `<root>`: open game directory
   * `/data`: open game data directory
   * `/.syncfaction`: open app directory
+  * `<AppData>/kaiko/rfg`: open directory with GOG config
 * Copy Save
   * `to Steam`: copy savegame file from GOG directory to Steam directory
   * `to GOG`: copy savegame file from Steam directory to GOG directory
@@ -44,6 +45,6 @@ Things not intended for users:
 * `Dev and hidden mods`: if enabled, will show mods from SF CDN. Intended for modders to quickly share dev builds. Also will display hidden mods, eg. installed updates
 * `UI: Update required`: uncheck to bypass update nag
 * `UI: Interactive/Busy`: toggle locked buttons and "working" state on/off
-* `Repeat App Initialization`: perform checks and actions done on app startup. Used for debugging
+* `Repeat Init`: perform checks and actions done on app startup. Used for debugging
 * `Switch Theme`: toggle light/dark theme. Used for debugging
 * `Get Logs and Clear Output`: displays logs and removes them from memory, clears text window

docs/intro.md

@@ -0,0 +1,56 @@
+## Introduction for new players
+
+![bright future awaits](_assets/bright_future.png)
+
+## Is multiplayer alive?
+
+> **Yes, it is!**
+
+We have regular parties once a week. Things to know if you want to join:
+
+---
+
+## Short HOWTO
+
+* You need RFG Re-mars-tered. GOG or Steam, clean install without mods
+* Download [SyncFaction](https://github.com/rfg-modding/SyncFaction/releases) and place it in the game folder
+* Run and let it update your game. You will need at least **40GiB** of free storage space and some time to download patches
+* Meanwhile, join [FactionFiles Discord](https://discord.gg/factionfiles), see server events for upcoming RFG Game Night and select RFG Multiplayer role in `#role-selection` channel to receive pings
+* Want to use mods AND play multiplayer? Roll back to unpatched version of the game? SyncFaction lets you switch between versions in 1 click, see [Usage](usage.md)
+
+---
+
+## Detailed guide
+
+<details>
+<summary><code>Expand</code></summary>
+### Community Patch
+
+You'll need to install community-made patches to play. Download size is several gigabytes so please take some time to prepare.
+
+> You will need at least **40GiB** of free storage space
+
+Use [SyncFaction app](https://github.com/rfg-modding/SyncFaction/releases). It is made to keep players updated and simplify process as much as possible. Download and place .exe in game folder. Run it and let it do the thing.
+
+Why do we need patches and a launcher app?
+
+* [Terraform Patch](https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch) adds new maps, weapons, rebalance, fixes game crashes and bugs (you can find kilometer-long changelog in description). It also serves as a base for future modding by restructuring some resources
+* [Reconstructor](https://github.com/rfg-modding/Reconstructor) is a script loader and a game engine patcher. It fixes some crashes, bugs like hardcoded memory limits, and enables scripting in mods
+* RFG is not modding-friendly game. Players will crash if their game files are not the same, that's why we need something to keep everyone updated
+* There is no simple way to auto-download new maps as in other games. Currently they are part of the patch and we release updates to add more
+* Multiplayer is currently broken in GOG version of the game, we fixed that
+
+
+### FactionFiles Discord
+
+Join [Red Faction Community Discord (FactionFiles)](https://discord.gg/factionfiles)
+
+* In `#role-selection` channel select role `RF:G Players (PC)`. This way you'll be notified when somebody gathers people for multiplayer!
+* See server events (above channel list). Subscribe to `RF: Guerrilla Game Night` - you'll get a notification when it starts
+
+![events](_assets/events.png)
+
+Feel free to ask for advice in `#rfg-matchmaking` and `#redfactionguerrilla` channels. Also you can hang out with us in one of the voice channels during game night!
+
+We used to have 2 weekly events: one in American timezone, another for Europe. If current time isn't good for you, let's schedule a new event!
+</details>

docs/usage.md

@@ -53,4 +53,16 @@ Some mods have settings. A panel will appear in the middle to let you select val
 
 When you are ready, press `Apply` and wait. **In case of errors, game state is not automatically cleaned up**, so you will need to undo some mods and try to `Apply` again. If you hit `Apply` with 0 mods, game is effectively cleaned up to latest patched state.
 
-`Refresh` button updates local mod list if you moved some folders.
+`Refresh` button updates local mod list if you moved some folders.
+
+## Switching between vanilla/patch/mods
+
+You want to install mods and still be able to play MP without time-consuming reinstall? You want to play unmodified singleplayer?
+
+SF lets you switch between heavliy-modded, patched MP-compatible, and unmodified game. Enable `Dev Mode` toggle. There are 3 buttons under Tools:
+
+* `Restore to Patch`: removes any mods and cleans up game to the latest Terraform+Reconstructor update. Use this to join MP
+* `Restore Last Mods`: applies mods you have installed before. Use this to get back to your setup after playing MP
+* `Restore to Vanilla`: *it's gonna take you back to the past*, to play original game without any edits
+
+These all work by copying files from backups in `game_root/.syncfaction/.bak*`. That's why SF needs a lot of space to work.