More formatting

Lines weren't properly seperated by spaces

CHANGES.md

@@ -1,60 +1,113 @@
-# Version 0.0.5
+#Version 0.0.5
 Updated 06/23/22
+
 New Features:
+
 -Manual Recalibration: Press CONTROL + END to recallibrate.  Very useful if you frequently zoom in
+
 -Sort by number of entities found in a scan: Press SHIFT + PAGEUP and SHIFT + PAGEDOWN to alternate between scanning modes
+
 -Modular Cursor:  Change the size of your cursor with CONTROL + I and CONTROL + SHIFT + I
+
    note:  The cursor is only modular in cursor mode, so you will need to press I first in order to enter cursor mode.
+
 -Scan Summary: The modular cursor will give a list of important information for the area scanned, in addition to adding the normal elements to your scan list.  For now end only triggers the normal re-scan around the player's location.
+
 -Building filters are now accessible
+
 -New Item selector:  Only implemented for filter building slots currently, if popular could make navigating recipes and technologies easier too.
+
 -Examining a resource tile will now speak the amount of resources left to be mined.
+
 -Added more descriptive feedback regarding entities that cannot be rotated
+
 Various bugfixes:
+
    -Fixed bug where teleporting wouldn't properly update the cursor and player locations
+
    -Fixed bug where electric poles wouldn't speak connected/not connected while over a resource
+
    -Fixed bug where offshore pumps wouldn't read output correctly
+
    -fixed bug(hopefully) where a scanned item would disappear from the scan list requiring a re-scan
+
    -fixed bug where opening inventory during callibration would bypass callibration
-# Version 0.0.4
+
+#Version 0.0.4
 Updated 6/16/22
+
 -Variety of bug fixes:
+
    -Game will no longer crash when changing category before the initial scan
+
    -Electric poles now correctly say connected based on cursor location, not player location
+
    -Belts that become invalid should no longer crash the game
+
    -Oddly shaped buildings should now read all input/output regardless of orientation
+
 -Brand new movement modes brought by @Eph on Discord.  Toggle between them with Control+W
+
    -Telestep: The good old movement you all know and try to love
+
    -Step-By-Walk: Should be the same as telestep but with footstep sound effects.  
+
    -Smooth-Walking: Effectively turns off the read tile system unless you walk into something you cannot pass through.  Great for navigating forests, squeezing between furnaces, and getting places quickly.  No more angry tapping.
+
 Note: The new movement system may have some undiscovered bugs, so please be patient and report in the Issues channel on Discord.
+
 -Significant improvements to scanning and initialization performance.
+
 -A fresh new .jkm file for Jaws users.  This should also speed up performance.  Consult the readme for instructions on how to install this file.
 
-# Version 0.0.3
+
+#Version 0.0.3
 Updated 6/15/22
+
 -Added accessible menu for placing offshore pumps
+
 -Added f to the list of keybinds in the readme
 
-# Version 0.0.2
+
+#Version 0.0.2
 Updated 6/15/22
+
 -Started a changelog, version numbers will be reflected here but not in the mods folder just to keep things simple
+
 -Added tile based descriptions of a buildings input/output.  To see this information, use cursor mode and move around the perimeter of the building.  
+
    For instance: moving the cursor over the top left corner of a burner mining drill will speak "output 1 north" indicating that things come out of the building, and this occurs 1 tile north of the cursor.
+
 -Added descriptions for direction a building is facing
+
 --Added power output description when cursor is over a generator type building
+
    note: solar panels are programmed differently, so will require more work for power output information.
+
 -Added total network power production to description when cursor is on electric poles
+
 -Added several new categories for scanning
+
 -Empty categories will now be ignored, and the player will not have to move through them.
+
 -Added a Jump to Scanned feature, whereby the player can jump their cursor to the location of something in the scan list.
+
    This is done with control+home and can only be done while in cursor mode
+
 -Underground belts and pipes are now somewhat accessible.  Once placed they will indicate the location of their connected partner. 
+
    Note, these objects do not yet speak "connected" or "not connected" while placing them, but that too will be added this week.
+
 -Modified building logic to be more reliable.
+
 -Building from cursor now supported.  Player must be in range of the target location, and the target location must be unoccupied
+
 -Removed unnecessary empty inventories from buildings
+
 -Callibration once again has a failsafe.  If your callibration failed, you will be prompted to callibrate again.
+
 -Player will now be notified at the end of every autosave, and at the beginning of any autosave triggered by pressing F1
+
    Note: Notifying at the start of game triggered autosaves is a work in progress, and should be done by end of week.
--Fixed crash triggered by selecting "back" option in launcher save file list
+
+-Fixed crash triggered by selecting "back" option in launcher save file list

README.md

@@ -2,109 +2,214 @@
 
 This is an accessibility mod for the popular game Factorio.  The goal of this mod is to make the game completely accessible to the blind and visually impaired.
 
+
 To install the full version, follow the instructions for .zip install.
+
 To update to the most recent patch, follow instructions for patch install
+
 Note:  If you have done a full installation using the .zip instructions, there is no need to follow the patch install directions until a new patch comes out.  
+
 Final note: Jaws users should also follow the instructions for installing the .jkm file
 
+
 # .zip install:
+
 1.  Download "Factorio Access.zip"
+
 2.  Open the .zip file and copy its contents
+
 3.  Navigate to the folder you have factorio installed.  It should already contain a /bin folder, a /data folder etc.  
-5.  Paste the files into your factorio folder
-6.  That's it!  You are now ready to run launcher.exe in admin mode
-7.  If you are a jaws user you may want to do the following:
+
+4.  Paste the files into your factorio folder
+
+5.  That's it!  You are now ready to run launcher.exe in admin mode
+
+6.  If you are a jaws user you may want to do the following:
+
    Copy Factorio.jkm from the .zip into your JAWS settings folder in your user appdata
+
    an example file path is "C:\Users\Crimso\AppData\Roaming\Freedom Scientific\JAWS\2022\Settings\enu\"
 
+
+
 # Patch Install:
+
 1.  Download control.lua, data.lua, and config.ini 
+
 2.  Navigate to your Factorio folder
+
 3.  Go to mods/FactorioAccess_0.0.1
+
 4.  Paste both control.lua and data.lua in this folder
+
 5.  Navigate back to your factorio folder
+
 6.  Go to the /config folder.  
+
 7. Paste config.ini into this folder
+
 8.  All done!  You can now run launcher.exe in admin mode to play the game with the new patch
 
+
+
 # Mod Controls:
+
 Movement:  W A S D
+
 note: When you change direction, your character doesn't immediately move a tile in that direction.  Think of it like turning your head before taking a step.
+
 Change movement mode: CONTROL + W
+
 Note the 3 movement types are as follows:
+
    1- Telestep: Press a direction to turn in that direction, then continue pressing in that direction to move
+
    2- Step-By-Walk:  This mode is similar to Telestep, however the player character will physically take steps in the direction chosen.  The biggest difference is footsteps.
+
    3- Smooth-Walking: In this mode the character will move similarly to in a sighted game.  The player will be notified if they run into something, but otherwise will not be notified of entities they are passing.  Very fast, and great for getting around!
+
 Mine: X
+
 Open a building's menu: [
+
 Open Inventory: E
+
 Speak cursor coordinates: K
+
 Place building: [
+
 Rotate: R
+
 Note: If you have something in your hand, you will rotate that.  Otherwise you will rotate the building your cursor is over.
+
 Additional Note:  The first time you press the rotate key, it will simply say the direction a building is facing.  Subsequent presses will actually rotate the building
+
 Cursor mode: I
+
 Increase cursor size: CONTROL + I
+
 Decrease cursor size: CONTROL + SHIFT + I
+
 note: You must be in cursor mode for the size of the cursor to make any difference
+
 Jump cursor to character: J
+
 Teleport player to cursor: shift T
+
 Quickbar: Any number key
+
 Recalibrate: CONTROL + END
+
 Note: If you zoom in and out frequently, you should also recalibrate in order for certain actions like mining and opening buildings to work
+
 Scan for nearby entities: END
+
 navigate scanned entity list: PAGE UP and PAGE DOWN
+
 Change scanned category:  CONTROL PAGE UP and CONTROL PAGE DOWN
+
 Change Sorting mode for scanned list: SHIFT + PAGEUP and SHIFT + PAGEDOWN
+
 Repeat scanned entry: HOME
+
 Move cursor to scanned target: CONTROL + HOME
+
 Note: This only works while in cursor mode
+
 Time of day and current research: T
+
 Save game: F1
+
 While in a menu:
+
 Note: Many functions are implemented only in the inventory screen, such as shift tab and item information.  Soon these features will be in building menus, but for now it is expected behavior
+
 Change tabs within a menu: tab/shift tab
+
 Select Item: [
+
 Coordinates of current inventory slot: K
+
 Crafting components required: K
+
 Item information: L
+
 Craft 1 item: [
+
 Craft 5 items: ]
+
 Craft as many items as possible:  shift [
+
 Unqueue 1 item:  [
+
 Unqueue 5 items: ]
+
 Unqueue all items:  shift [
+
 Smart Insert/Smart Withdrawal: SHIFT + LEFT BRACKET
+
 note: This will insert an item stack, or withdraw an item stack from a building.  It is smart because it will decide the proper inventory to send the item to.  For instance, smart inserting coal into a furnace will attempt to put it in the fuel category, as opposed to the input category.
+
 In item selector:
+
 Press Left-Bracket or s to select a category.
+
 Press W to jump to previous category level
+
 Press A and d to select a category from the currently selected tier.
+
 Set Quickbar #: CONTROL any number
 
+
+
 # FAQ:
+
 Q: Does this mod work with the steam version?
+
 A:  Not yet, however if you buy the game on steam you can use your product key to redeem the standalone version on factorio.com
 
+
+
 Q: Does this mod work with the demo?
+
 A:  No, in fact no mods work with the demo.
 
+
+
 Q:  Can this mod run the tutorial?
+
 A:  Not yet.  There are plans to create a custom tutorial, and to make the built in tutorial accessible, but these things are still at least a week away.
 
+
+
 Q:  My game crashed, what gives?
+
 A:  This mod is currently still in early access.  Bugs are normal and expectted.  Please post about it in the issues channel of Discord.
 
+
+
 Q:  Do I have to pay to use the mod?
+
 A:  The mod is and always will be free.  The game itself costs $30 on [Factorio.com](www.factorio.com)
 
+
+
 # Help and Support
+
 If your question wasn't answered here, please check out our [Discord](https://discord.gg/CC4QA6KtzP) server, and ask your question there.
 
+
+
 # Changes
+
 An updated changelog can be found [here](https://github.com/Crimso777/Factorio-Access/blob/main/CHANGES.md)
 
+
+
 # Donations
+
 While this mod is completely free for all, I am a full time student working on this mod in my free time, thus any and all support is greatly appreciated.
+
 If you are so inclined, you can donate at my [Patreon](https://www.patreon.com/Crimso777)
 
+