From 1272403ab4213033d73c160c5c38fa7d67bb23e5 Mon Sep 17 00:00:00 2001 From: KadeDev Date: Wed, 17 Feb 2021 13:04:32 -0800 Subject: [PATCH] Readme update --- readme.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..23da700 --- /dev/null +++ b/readme.md @@ -0,0 +1,41 @@ +# FNFBot Rewrite +## The better version of FNFBot + +### What is FNFBot? + +FNFBot is a bot program that lets users automaticly play Friday Night Funkin Charts. + +### How do I use FNFBot? +FNFBot has 3 main sections, as shown here. +![3Sections](https://i.imgur.com/fwlUZPg.png) + +The **red** section is where you enter all the data. + +Examples: + +- Your games directory +- Selecting Songs + +The **green** area is the console, this outputs useful information. + +Examples + +- What happened when you pressed a keybind +- What notes its planning on hittinh +- When it completes a song + +The **blue** section is where the preview of what the notes *probably* look like. + +### Keybinds +FNFBot currently has 3 keybinds, and in the future will have modifyable keybinds. + +Currently the keybinds are as follows: + +| Keybind | Description | +| ----------- | ----------- | +| F1 | Start/Stop Playing the selected map | +| F2 | Increase the offset | +| F3 | Decrease the offset | + +Offset = the amount of time in miliseconds to hit before/after the note time. +Default: 25 \ No newline at end of file