From 18fa9ec829b4ea4e8617bc1c6418d32f2579375d Mon Sep 17 00:00:00 2001
From: rebtd7 <59185507+rebtd7@users.noreply.github.com>
Date: Mon, 23 Dec 2019 23:16:34 -0300
Subject: [PATCH] Create README.md

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2e61099
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# FF13Fix
+Fixes for the PC version of FF13
+
+# Notes
+This is a fork of [OneTweakNG](https://github.com/Nucleoprotein/OneTweakNG), containing additional fixes for FF13.
+
+# Installation
+Download the latest [release](https://github.com/rebtd7/FF13Fix/releases) and add both ```dinput8.dll``` and ```FF13Fix.ini``` to the folder ```FINAL FANTASY XIII\white_data\prog\win\bin```.
+
+You may want to change ```FF13Fix.ini``` if you want to cap the frame rate.
+
+# What this does
+
+## Removes the awful frame pacer
+I don't see the point in it. It is overly aggressive.
+
+## Removes stuttering caused by new controllers being scanned every second
+This caused stuttering specially if you didn't have a connected controller after the last opening of Steam.
+
+Note that if you want to use a controller you need to connect it before opening the game (i.e. this patch removes the hotplugging support)
+
+## Fix the enemy scan text on resolutions over 720p
+The game calls [SetScissorRect](https://docs.microsoft.com/en-us/windows/win32/api/d3d9helper/nf-d3d9helper-idirect3ddevice9-setscissorrect) using a rectangle hardcoded with the 720p coordenates. This patches fixes it.
+
+## Uncaps the frame rate
+I did not see any negatives on unlocking the frame rate, but your mileage may very. If you are having issues, edit ```FF13Fix.ini``` to cap the frame rate.
+
+## Changes to where the memory is allocated on certain vertex buffers
+This seems to improve the frame rate. This fix is not new, it is from [OneTweakNG](https://github.com/Nucleoprotein/OneTweakNG).