Updated config wiki, moved images to repo, added rules

.github/workflows/upwiki.yml

@@ -31,7 +31,7 @@ jobs:
 
       - name: Push wiki content
         run: |
-          rsync -av --delete main_repo/docs/wiki/ wiki_repo/ --exclude .git;
+          rsync -av --delete main_repo/docs/wiki/markdown/ wiki_repo/ --exclude .git;
           cd wiki_repo;
           git add .;
           if git commit -m "Update wiki content"; then

docs/README.md

@@ -0,0 +1,23 @@
+# Docs README
+
+## Wiki update rules
+
+### General rules
+1. You should not put anything to root wiki directory (`docs/wiki/`);
+2. All the `.md` files should go to `docs/wiki/markdown/` folder;
+3. Your links should not lead to shady sites;
+4. If you removed screenshot from the markdown code then delete the image itself in the `docs/wiki/markdown/images/` folder.
+
+### Name your wiki files properly!
+1. Do not use the following characters in your wiki page's titles: `\ / : * ? " < > |`;
+2. Use `-` sign instead of space;
+3. Too long name is not good at all, keep it ~32 chars long maximum;
+4. It's cool that GitHub's markup engine supports so much markup languages, but keep it `md` for consistency, please. Markdowns are the easiest to maintain and most common pretty everywhere;
+5. You should write wiki pages **only** in English. We also do not accept translated pages there since GitHub does not support them. The wiki would be a mess if we did accept these changes.
+
+### Add screenshots if needed!
+1. Don't do it too often;
+2. Add screenshots that will actually help;
+3. Draw eye directing arrows or circles of some kind on them, if possible and necessary;
+4. Screenshots should be uploaded to this repository only, there are special folder for these: `docs/wiki/images/`, just use relative \(`/docs/wiki/images/image.png`\) links to add them in your markdown page;
+5. Give your screenshots meaningful file names and put them in sub-directories so they don't get lost.

docs/wiki/markdown/Building-psOff-VSCode.md

@@ -7,44 +7,44 @@
 
 When you open psOff repository with VSCode for the first time, it will show you the notification about installing recommended extensions. You should click `Show Recommenadtions` there.
 
-![Code_2024-03-31_18-53-20](https://github.com/igor725/psOff_public/assets/40758030/cf68c43d-880e-455d-861f-e79dd5fbc346)
+![recomends_btn](/docs/wiki/images/vsbuild/recomends_btn.png)
 
 If you missed this notification, then press `Ctrl+Shift+P` and type `Focus on Workspace Recommendations View` and perss this button.
 
-![WindowsSandboxClient_2024-03-31_18-57-38](https://github.com/igor725/psOff_public/assets/40758030/0f880db8-99d3-45a8-bf58-ffd670c83ae7)
+![recomends_help](/docs/wiki/images/vsbuild/recomends_help.png)
 
 Now you'll see the sidebar with all the recommended extensions, you should install all of them. Or just press the `Install Workspace Recommended Extensions` button above, the one with the cloud icon.
 
-![WindowsSandboxClient_2024-03-31_18-53-44](https://github.com/igor725/psOff_public/assets/40758030/f26d29ef-6d83-4dcd-9b6d-54a123f1730f)
+![recomends_install](/docs/wiki/images/vsbuild/recomends_install.png)
 
 It is recommended to restart the VSCode after you finish installing all the recommended extensions.
 
 All you have to do now is switch the default compiler to `clang-cl` if it didn't set automatically and set build target to Release.
 
-![WindowsSandboxClient_2024-03-31_18-55-18](https://github.com/igor725/psOff_public/assets/40758030/07a06620-e44a-4ab9-a98d-d44abd770551)
+![default_compiler](/docs/wiki/images/vsbuild/default_compiler.png)
 
-![WindowsSandboxClient_2024-03-31_18-55-26](https://github.com/igor725/psOff_public/assets/40758030/4b1c1821-d2b4-459f-905f-b06d057dcd38)
+![default_compiler_popup](/docs/wiki/images/vsbuild/default_compiler_popup.png)
 
 Make sure the CMake Extension uses it too:
 
-![Code_2024-03-31_19-44-08](https://github.com/igor725/psOff_public/assets/40758030/d801a28f-8e57-4c1a-9c66-f45861b78e7f)
+![default_compiler_sure](/docs/wiki/images/vsbuild/default_compiler_sure.png)
 
 > [!WARNING]
 > You won't be able to build the Debug version of emulator, you should switch CMake target to Release. But worry not, this target already uses debug symbols the only thing you should do to improve your debugging experience - disable compiler optimizations, open the main `CMakeLists.txt` file and change `CMAKE_CXX_FLAGS_RELEASE` flag `-Ofast` to `-O0`.
 >
-> ![Code_2024-03-31_19-44-15](https://github.com/igor725/psOff_public/assets/40758030/0ba33d03-31c7-4b36-814d-df8b5dd90545)
-> ![Code_2024-04-03_11-09-31](https://github.com/igor725/psOff_public/assets/40758030/525039ee-97e5-48d1-8aef-411e78c26466)
+> ![debug_warning](/docs/wiki/images/vsbuild/debug_warning.png)
+> ![optimizations](/docs/wiki/images/vsbuild/optimizations.png)
 
 If you reading this, it seems you all set! So now you can use VSCode to build psOff modules. Just press `Ctrl+Shift+P` and type `CMake Focus` and press `CMake: Focus on Project Status View` then click on the `Configure` button first:
 
-![firefox_2024-04-03_11-16-29](https://github.com/igor725/psOff_public/assets/40758030/446c7fb1-a4e7-4b21-8ce5-2a3586e95042)
+![cmake_configure](/docs/wiki/images/vsbuild/cmake_configure.png)
 
 Then the `Build` one:
 
-![image](https://github.com/igor725/psOff_public/assets/40758030/e890e20c-cc88-416c-8549-c55764a0dd88)
+![cmake_build](/docs/wiki/images/vsbuild/cmake_build.png)
 
 You can add these command to `Pinned Commands` list and use them there:
 
-![2024-04-03_11-17-57](https://github.com/igor725/psOff_public/assets/40758030/1b83e2ed-d570-437a-bb2b-8b3ccd3cf084)
+![cmake_pins](/docs/wiki/images/vsbuild/cmake_pins.png)
 
 In fact, the only button you need is `Install`. When you press it, cmake will configure the project, build it and then copy ready to use files to `_build/_Install` directory.

docs/wiki/markdown/Config-files.md

@@ -68,6 +68,23 @@ You can change the layout now in _controls.json_, if you want to.
 
 ## general.json
 
+```jsonc
+{
+  "netEnabled": false, // Wether enable networking features or not. Better to keep it disabled, not ready for the actual use.
+  "netMAC": "00:00:00:00:00:00", // Your ethernet adapter's MAC address. Zero-MAC means "first usable device".
+  "profiles": [ // User profiles, you can change your name there
+    {
+      "color": "blue",
+      "name": "Anon"
+    },
+    // More users here...
+  ],
+  "systemlang": 0, // System langauge, see the list below to get these indexes
+  "userIndex": 1 // Current user index
+}
+
+```
+
 Game language can be changed with systemlang : *, default is EnglishUS. Game must support it.
 
   Japanese           = 0 \
@@ -103,11 +120,30 @@ Game language can be changed with systemlang : *, default is EnglishUS. Game mus
 
 ## audio.json
 
-You can specify the audio device here and adjust the master volume
+```jsonc
+{
+  "device": "[default]", // Audio device name, [default] means system default output device
+  "volume": 0.05 // Master volume, 0...1
+}
+```
 
 ## graphics.json
 
-Not implemented yet, no parameters there
+> [!WARNING]
+> The emulator updates this file every time you gracefully stop the emulation \(by closing the emulator window\)!
+
+```jsonc
+{
+  "display": 1, // Your display index, starting from 0
+  "fullscreen": false, // Wether emulator will run in fullscreen mode or not
+
+  "height": 1080, // The emulator window dimensions, ignored in fullscreen mode
+  "width": 1920,
+
+  "xpos": -1, // The emulator window position, -1 means center
+  "ypos": -1
+}
+```
 
 ## logging.json
 
@@ -116,7 +152,7 @@ Not implemented yet, no parameters there
   // Log output
   // Possible values:
   // 1) Baical - to Baical server over network
-  // 2) FileBin - to local binary file
+  // 2) FileBin - to local binary file (you should use this format to post compatibility reports)
   // 3) FileTxt - to local text file
   // 4) Syslog - to system log server
   // 5) Console - to console