summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJacob Palecki <[email protected]>2020-09-08 17:50:19 -0700
committerJacob Palecki <[email protected]>2020-09-08 17:50:19 -0700
commitc3de75b85cc6639eee96d19ae0b1fa3c0936fff1 (patch)
treead0763854dbe2354f2079ab2910f29e126e39dd0
parentClean up chart titles, axes, legends (diff)
downloadrawaccel-c3de75b85cc6639eee96d19ae0b1fa3c0936fff1.tar.xz
rawaccel-c3de75b85cc6639eee96d19ae0b1fa3c0936fff1.zip
Add readme and start of guide
-rw-r--r--grapher/ReadMe/Guide.md10
-rw-r--r--grapher/ReadMe/ReadMe.md14
2 files changed, 24 insertions, 0 deletions
diff --git a/grapher/ReadMe/Guide.md b/grapher/ReadMe/Guide.md
new file mode 100644
index 0000000..fc84441
--- /dev/null
+++ b/grapher/ReadMe/Guide.md
@@ -0,0 +1,10 @@
+# Raw Accel Guide
+
+## Philosophy
+The Raw Accel driver and GUI's workings and exposed parameters are based on our understanding of mouse acceleration. Our understanding includes the concepts of "gain", "whole vs component", and "anisotropy." For clarity, we will outline this understanding here.
+- **Sensitivity**: The ratio of the output speed to the input speed. The "sensitivity" parameter in the program is a multiplier used on the post-calculation output vector.
+- **(Output) Velocity**: The speed of the final output vector. The output vs input velocity curve is perhaps the most important relationship in a particular setup because it directly describes the output for any given input.
+- **Gain**: The slope of the output vs input velocity curve.
+- **Acceleration**: Acceleration is characteristic of a velocity curve. A velocity curve has "acceleration" if at any point the curve is nonlinear. A nonlinear curve results from a non-constant gain and results in a non-constant sensitivity.
+
+### Example
diff --git a/grapher/ReadMe/ReadMe.md b/grapher/ReadMe/ReadMe.md
new file mode 100644
index 0000000..1d0c282
--- /dev/null
+++ b/grapher/ReadMe/ReadMe.md
@@ -0,0 +1,14 @@
+# Raw Accel
+
+Raw Accel is a Windows 10 64-bit kernel driver which allows for the acceleration, or other modification, of mouse input in the raw input stream. It started as a replacement for the InterAccel program and Intercept driver, and has been extended with more acceleration types, charts, and other features.
+
+## Anti-Cheat Friendly
+
+Raw Accel will be signed to run as a fully trusted driver. It modifies mouse input only by a constant set of formulas and parameters, and has a one-second delay on writing settings to the driver, so it cannot be used to cheat.
+
+## Development
+
+Development of Raw Accel is ongoing at https://github.com/a1xd/rawaccel. Being a signed driver, the guts of the Raw Accel driver will be updated infrequently. The GUI can be updated as often was we like, however, so please let us know if you find any bugs.
+
+## Further Help
+For an overview of everything Raw Accel has to offer, please see the guide (guide.md). For a list of frequently asked questions, please see the FAQ (FAQ.md). \ No newline at end of file