[docs] add deps instructions for void linux, alpine, nixOS, update haiku new stuff; add basic coding guidelines

Signed-off-by: lizzie <lizzie@eden-emu.dev>

docs/Caveats.md

@@ -53,6 +53,8 @@ For this reason this patch is NOT applied to default on all platforms (for obvio
 
 `cubeb_devel` will also not work, either disable cubeb or uninstall it.
 
+Still will not run flawlessly until `mesa-24` is available. Modify CMakeCache.txt with the `.so` of libGL and libGLESv2 by doing the incredibly difficult task of copy pasting them (`cp /boot/system/lib/libGL.so .`)
+
 ## OpenBSD
 
 After configuration, you may need to modify `externals/ffmpeg/CMakeFiles/ffmpeg-build/build.make` to use `-j$(nproc)` instead of just `-j`.

docs/Coding.md

@@ -0,0 +1,77 @@
+# Coding guidelines
+
+These are mostly "suggestions", if you feel like your code is readable, comprehensible to others; and most importantly doesn't result in unreadable spaghetti you're fine to go.
+
+But for new developers you may find that following these guidelines will make everything x10 easier.
+
+## Naming conventions
+
+Simply put, types/classes are named as `PascalCase`, same for methods and functions like `AddElement`. Variables are named `like_this_snake_case` and constants are `IN_SCREAMING_CASE`.
+
+Template typenames prefer short names like `T`, `I`, `U`, if a longer name is required either `Iterator` or `perform_action` are fine as well.
+
+Macros must always be in `SCREAMING_CASE`. Do not use short letter macros as systems like Solaris will conflict with them; a good rule of thumb is >5 characters per macro - i.e `THIS_MACRO_IS_GOOD`, `AND_ALSO_THIS_ONE`.
+
+Try not using hungarian notation, if you're able.
+
+## Formatting
+
+Do not put if/while/etc braces after lines:
+```c++
+// no dont do this
+if (thing)
+{
+    some(); // ...
+}
+
+// do this
+if (thing) {
+    some(); // ...
+}
+
+// or this
+if (thing)
+    some(); // ...
+
+// this is also ok
+if (thing) some();
+```
+
+Brace rules are lax, if you can get the point across, do it:
+
+```c++
+// this is fine
+do {
+    if (thing) {
+        return 0;
+    }
+} while (other);
+
+// this is also ok --- albeit a bit more dense
+do if (thing) return 0; while (other);
+
+// ok as well
+do {
+    if (thing) return 0;
+} while (other);
+```
+
+There is no 80-column limit but preferably be mindful of other developer's readability (like don't just put everything onto one line).
+
+```c++
+// someone is going to be mad due to this
+SDL_AudioSpec obtained;
+device_name.empty() ? device = SDL_OpenAudioDevice(nullptr, capture, &spec, &obtained, false) : device = SDL_OpenAudioDevice(device_name.c_str(), capture, &spec, &obtained, false);
+
+// maybe consider this
+SDL_AudioSpec obtained;
+if (device_name.empty()) {
+    device = SDL_OpenAudioDevice(nullptr, capture, &spec, &obtained, false);
+} else {
+    device = SDL_OpenAudioDevice(device_name.c_str(), capture, &spec, &obtained, false);
+}
+
+// or this is fine as well
+SDL_AudioSpec obtained;
+device = SDL_OpenAudioDevice(device_name.empty() ? nullptr : device_name.c_str(), capture, &spec, &obtained, false);
+```

docs/Deps.md

@@ -86,6 +86,8 @@ On riscv64:
 
 These are commands to install all necessary dependencies on various Linux and BSD distributions, as well as macOS. Always review what you're running before you hit Enter!
 
+Notes for writers: Include build tools as well, assume user has NOTHING installed (i.e a fresh install) but that they have updated beforehand so no `upgrade && update` or equivalent should be mentioned - except for rolling release systems like Arch.
+
 Click on the arrows to expand.
 
 <details>
@@ -137,6 +139,33 @@ sudo dnf install qt6-qtbase-private-devel
 </details>
 
 <details>
+<summary>Alpine Linux</summary>
+
+First, enable the community repository; [see here](https://wiki.alpinelinux.org/wiki/Repositories#Enabling_the_community_repository).
+```sh
+# Enable the community repository
+setup-apkrepos -c
+# Install
+apk add g++ git cmake make mbedtls-dev mbedtls-static mesa-dev qt6-qtbase-dev qt6-qtbase-private-dev libquazip1-qt6 ffmpeg-dev libusb-dev libtool boost-dev sdl2-dev zstd-dev vulkan-utility-libraries spirv-tools-dev openssl-dev nlohmann-json lz4-dev opus-dev jq patch
+```
+
+`mbedtls-static` has to be specified otherwise `libeverest.a` and `libp256m.a` will fail to be found.
+
+</details>
+<summary>Void Linux</summary>
+
+```sh
+xbps-install -Su git make cmake clang pkg-config patch mbedtls-devel SPIRV-Tools-devel SPIRV-Headers lz4 liblz4-devel boost-devel ffmpeg6-devel catch2 Vulkan-Utility-Libraries Vulkan-Headers glslang openssl-devel SDL2-devel quazip-qt6-devel qt6-base-devel qt6-qt5compat-devel fmt-devel json-c++ libenet-devel libusb-devel
+```
+
+Yes, `nlohmann-json` is just named `json-c++`. Why?
+
+</details>
+<summary>NixOS</summary>
+
+A convenience script is provided on the root of this project [shell.nix](../shell.nix).
+
+</details>
 <summary>macOS</summary>
 
 Install dependencies from **[Homebrew](https://brew.sh/)**
@@ -227,12 +256,11 @@ pacman -Syu --needed --noconfirm $packages
   * `echo 'PATH=/mingw64/bin:$PATH' >> ~/.bashrc`
   * or `echo 'PATH=/mingw64/bin:$PATH' >> ~/.zshrc`
 </details>
-
 <details>
 <summary>HaikuOS</summary>
 
 ```sh
-pkgman install git cmake libfmt_devel nlohmann_json lz4_devel opus_devel boost1.89_devel vulkan_devel qt6_base_devel libsdl2_devel ffmpeg7_devel libx11_devel enet_devel catch2_devel quazip1_qt6_devel qt6_5compat_devel zydis_devel libusb_devel libz_devel glslang
+pkgman install git cmake patch libfmt_devel nlohmann_json lz4_devel opus_devel boost1.89_devel vulkan_devel qt6_base_devel libsdl2_devel ffmpeg7_devel libx11_devel enet_devel catch2_devel quazip1_qt6_devel qt6_5compat_devel zydis_devel libusb1_devel libz_devel glslang mbedtls3
 ```
 
 [Caveats](./Caveats.md#haikuos).

docs/README.md

@@ -5,6 +5,7 @@ This contains documentation created by developers. This contains build instructi
 - **[General Build Instructions](Build.md)**
 - **[Cross Compiling](CrossCompile.md)**
 - **[Development Guidelines](Development.md)**
+- **[Coding guidelines](Coding.md)**
 - **[Dependencies](Deps.md)**
 - **[Debug Guidelines](./Debug.md)**
 - **[CPM - CMake Package Manager](CPMUtil.md)**

shell.nix

@@ -0,0 +1,19 @@
+let
+  nixpkgs = fetchTarball "https://github.com/NixOS/nixpkgs/tarball/nixos-24.05";
+  pkgs = import nixpkgs { config = {}; overlays = []; };
+in
+pkgs.mkShellNoCC {
+  packages = with pkgs; [
+    # essential programs
+    git cmake clang gnumake patch jq pkg-config
+    # libraries
+    openssl boost fmt nlohmann_json lz4 zlib zstd
+    enet libopus vulkan-headers vulkan-utility-libraries
+    spirv-tools spirv-headers simpleini vulkan-memory-allocator
+    vulkan-loader unzip mbedtls zydis glslang python3 httplib
+    cpp-jwt ffmpeg-headless libusb1 cubeb
+    qt6.full # eden
+    SDL2 # eden-cli
+    discord-rpc gamemode # optional components
+  ];
+}

src/core/CMakeLists.txt

@@ -1181,13 +1181,14 @@ if (MSVC)
 else()
     target_compile_options(core PRIVATE
         -Werror=conversion
-
         -Wno-sign-conversion
         -Wno-cast-function-type
-
         $<$<CXX_COMPILER_ID:Clang>:-fsized-deallocation>
-        $<$<CXX_COMPILER_ID:Clang>:-Wno-cast-function-type-mismatch>
     )
+    # pre-clang19 will spam with "OH DID YOU MEAN THIS?" otherwise...
+    if (CXX_CLANG AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 19)
+        target_compile_options(core PRIVATE -Wno-cast-function-type-mismatch)
+    endif()
 endif()
 
 target_include_directories(core PRIVATE ${OPUS_INCLUDE_DIRS})