Initial public release of rem-essentials

README.md

@@ -0,0 +1,37 @@
+# rem-essentials
+
+`rem-essentials` is a Freelancer plugin for the REM mod that collects the
+client/server fixes REM actually needs. The goal is to keep a single, small,
+configurable feature surface that works on native Windows and under
+Wine/Proton.
+
+## Feature surface
+
+Every feature is individually configurable through `rem-essentials.ini`.
+Features cover the mouse/cursor stack, server-side fixes, client stability
+patches, navigation, graphics, saves, screenshots, logging, and more.
+
+The Proton-sensitive mouse stack is split into separate switches:
+
+- hide the in-game cursor when the real cursor is outside the game window
+- prevent Windows cursor flicker at screen borders in borderless windowed mode
+- prevent mouse warps to the center of the game window in windowed modes
+- no server kick when buying the same ship again
+- avoid the quit-message loop hang after the game receives `Quit`
+- patch the rare `alchemy.dll` crash around file offset `0x77cb`
+
+## Documentation
+
+See [docs/architecture.md](docs/architecture.md) for feature registration rules
+and [docs/build.md](docs/build.md) for the current MSVC/x86 build path.
+See [docs/deployment.md](docs/deployment.md) for release validation and packaging.
+See [docs/configuration.md](docs/configuration.md) for INI precedence, Launcher
+overrides, manual installation, and save-directory behavior under Proton.
+
+## Design rules
+
+- Keep every fix independently configurable.
+- Keep client-only and server-only fixes separate.
+- Treat mouse/cursor fixes as Proton-sensitive and test them under Wine/Proton
+  before enabling them by default.
+- Prefer small, named fixes over broad plugin behavior.