Browse Source

Create README.md

TheIllusiveC4 6 years ago
parent
commit
b6b7d81722
1 changed files with 15 additions and 0 deletions
  1. 15 0
      README.md

+ 15 - 0
README.md

@@ -0,0 +1,15 @@
+# Custom FoV [![](http://cf.way2muchnoise.eu/versions/custom-fov.svg)](https://minecraft.curseforge.com/projects/custom-fov) [![](http://cf.way2muchnoise.eu/short_custom-fov_downloads.svg)](https://minecraft.curseforge.com/projects/custom-fov/files) [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+Custom FoV is a mod that allows players to customize various field of view settings through the configuration file. This mod is client-side only, so it is not required on the server-side to function. The current settings allow configuration for flying, aiming, and speed-related field of view changes. The speed-related field of view changes can further be broken down into sprinting and potion effect-related changes.
+
+# Configuration Options
+
+## Static FoV
+
+Disables any and all vanilla field of view changes resulting from flying, aiming, or speed.
+
+## Each of Flying, Aiming, and Speed (Sprinting/Effects)
+* Modifier - A decimal number to multiply by the original FoV modifier, used to soften or strengthen FoV changes
+* Max Value - A decimal number that indicates the maximum FoV value allowed for the FoV modifier
+
+