Merge branch 'next-update'

CHANGES.md

@@ -1,3 +1,107 @@
+# Version 0.7.0 BETA
+
+Released on January 30th, 2024.
+
+This update brings many interface tweaks and additions. Most importantly, we are adding the first version of the mod's own tutorial system, which teaches the basic controls and mechanics, and gives the player small objectives up until they complete their first two technology researches. In addition, how the mod cursor updates and how it syncs with the visual mouse pointer have been vastly improved. The launcher has also been improved, now supporting localization and improved new game setup including new presets.
+
+## New Features
+
+- New launcher features.
+  1. Added launcher localization support including an option to select your language before the main menu.
+  2. The new game settings menu completely revamped to make game setup smoother.
+
+- Map presets have been revised.
+  1. Compass valley remains unchanged as the custom peaceful map with fairly favorable settings and a world seed that is always the same. We recommend it for your first game.
+  2. The "no enemies" preset has default settings except that enemy bases are fully turned off.
+  3. The "peaceful" preset has default settings except that enemies are in peaceful mode, where they do not start any attacks, but still react to being attacked.
+  4. All other presets come directly from the game.
+
+- The tutorial system has been added.
+  * Press "H" to hear the current tutorial step. Press "SHIFT + H" and "CONTROL + H" to go forward and backward along the steps.
+  * To make it easier to review steps, there is a chapter and summary system. You can toggle between hearing step details or their summaries by pressing "CONTROL + SHIFT + H". 
+  * You can jump between the chapters by using "ALT + SHIFT + H" and "ALT + CONTROL + H".
+  * The tutorial system works by giving info in steps. There are over 100 steps spread out over 7 chapters, including objectives, basic info, tips and so on. 
+  * The logic of the system is to teach the controls, and give the player small objectives up until they complete their first research, and provide condensed wiki information about everything they use.
+  * Reading the wiki will now be needed if you want to learn more advanced info such as transport belt lane management, or if you prefer to have the basics explained in extra detail.
+  * Running the tutorial also provides a little gift so that steps are explained in a smoother order, and also the early game becomes very slightly faster.
+  * Feedback is welcome for rebalancing any of the steps.
+
+- Damaged items are considered by the game as not the same as the same items at full health, so the mod now identifies damaged items, so that you can place and repair them.
+  * If you have multiple damaged units of the same item, the inventory system has a shortcut where it groups all damaged units of the item into the same stack and averages their health levels.
+
+- A sound cue can now be heard when you encounter an entity in smooth walking mode. This makes it much easier to detect when you arrive at an ore patch. 
+
+- The player character now visually turns to face the cursor direction correctly.
+
+- Vehicle inventories can now be accessed, including cars, tanks, cargo wagons, and rocket cargo slots.
+
+- You can now take half of an inventory stack when your hand is empty by pressing "RIGHT BRACKET", but for now only from the player inventory menu when it is open by itself or alongside a chest. On the other hand, smart-inserting half a stack by pressing "SHIFT + RIGHT BRACKET" already works from the player inventory inside building menus.
+
+- Small additions
+  * The power load level for steam engines is now expressed in a percentage as a summary before giving the exact numbers as usual.
+  * Steam engines now indicate their fluid contents.
+  * GUI icons were added for the offshore pump building menu.
+  * Visual build previews now include the enlarged cursor if holding paving items, since they can be placed outside of cursor mode too.
+  * A furnace's recipe can now be identified from its output slot if it is inactive otherwise.
+  * Left clicking with the mouse is now also associated with the mod's entity click handling function.
+
+## Changes
+
+- Rotation input behavior has been changed. 
+  * You can now use rotate "R" and reverse rotate "SHIFT + R" universally, including Vanilla Mode. 
+  * The first rotation command now rotates the building instead of simply reading the current direction. This provides parity with vanilla behavior and also the info is already available when an entity is examined.
+
+- Big revisions for how the mouse pointer is visually handled. This minimizes bugs and makes the cursor logic easier to see for those with partial vision.
+  * The pointer is now strongly bound to the mod's cursor with higher accuracy. This is enforced every time you press a key to move the mod cursor or while you have an item in hand. 
+  * If the mod cursor is going off the edge of the screen, the mouse pointer is centered on the player character in the middle.
+  * Entity selection has been fully tied to the mod cursor exclusively, so the mouse pointer clicking on something out of range or on something that is in front of something else will not cause issues.
+  * Vanilla mode bypasses all of these checks and fully unbinds the mouse pointer and re-enables selecting entities with it.
+  * There is also another bypass for those who prefer it: You can middle click the mouse to unbind the mouse and select with it freely until the mod cursor moves again or the menu changes. 
+
+- Mod release files have been cleaned up.
+  * Removed unneeded files from the 0.7.0 release folder. These include the "map presets" folder and DLL files.
+  * The mod's MIT license is now included in the mod's own folder.
+
+- The scanner tool has been tuned to report more accurately when it is finished.
+
+- When you enter Cursor Mode during smooth walking, you will now be repositioned to the center of the nearest tile if it is walkable. The displacement is always less than 1 tile.
+
+- Smooth walking has been made smoother such that info updates and cursor updates are more accurate.
+
+- Improved how transport belts in hand are rotated to match the player direction during build lock mode.
+
+- Improved pipe connection direction reports so that they point to the relevant pipes of a connected entity instead of the whole entity, which may be at a diagonal direction.
+
+- The fast travel system now takes the player position as the reference when creating a new point.
+
+- Other changes
+  * Crafting menu info and some other menu info is better phrased now.
+  * Entity part reading has been made more accurate.
+
+## Bug fixes
+
+- Launcher bugs fixed, such as removing a circular dependency about setting up config files for the first time loading the game.
+
+- Fixed the sync of visual building previews with the mod drawn building preview footprints. This includes rotating objects and using the pipette tool.
+
+- Fixed several cases of missing updates for the cursor highlight box and building preview visuals.
+
+- Cursor reach distance for clicking entities has been made more accurate.
+
+- Mining an access radar now gives you back the access radar instead ofa regular radar.
+
+- Fixed flamethrower turrets causing a crash when you examine their contents.
+
+- Fixed crashes that were happening while reading special tool items in hand.
+
+- Fixed the game crashing when your character dies.
+
+- Fixed the transport belt analyzer crashing due to localization setup errors.
+
+## New known bugs
+
+- There are some cases where the mod cursor and mouse pointer rotation lose sync. You can fix this by using the pipette tool to resync them.
+
 # Version 0.6.0 BETA
 
 Released on January 20th, 2024.
@@ -65,7 +169,7 @@ This update brings several new features and changes to increase overall accessib
 ## Changes
 
 - Some mod controls have been changed. Please note:
-  * The "Q" key now empties the hand and runs the smart pippette tool, like in vanilla keybinds. Reading the hand is now done with "SHIFT + Q". Therefore, the two keybinds have simply switched places. This is for several reasons: Parity with vanilla gameplay, the hand emptying and pippette being used more frequently overall than hand reading, and symmetry with "SHIFT + E" reading the current menu and with "E" opening and closing menus.
+  * The "Q" key now empties the hand and runs the smart pipette tool, like in vanilla keybinds. Reading the hand is now done with "SHIFT + Q". Therefore, the two keybinds have simply switched places. This is for several reasons: Parity with vanilla gameplay, the hand emptying and pipette being used more frequently overall than hand reading, and symmetry with "SHIFT + E" reading the current menu and with "E" opening and closing menus.
   * The menu search function is now activated by pressing "CONTROL + F", instead of pressing "ENTER". This prevents unintentionally boarding or exiting vehicles when trying to open the search, and it is also a more intuitive keybind that matches most other computer programs.
   * Scan result list sorting now uses "N" to sort by distance to your current position because it is used more often than sorting by total count, which now uses "SHIFT + N".
 

LICENSE

@@ -1,6 +1,7 @@
+Factorio Access Mod Project
 MIT License
 
-Copyright (c) 2022 Ordermark
+Copyright (c) 2024 Crimso
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.txt

@@ -0,0 +1,22 @@
+Factorio Access Mod
+MIT License
+
+Copyright (c) 2024 Crimso
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

config_changes/AB_initial.ini

@@ -17,9 +17,6 @@ check-updates=false
 
 [controls]
 
-;This is an additional keybind for a mouse action.
-open-gui-alternative=LEFTBRACKET
-
 ;This is an additional keybind for a mouse action.
 mine-alternative=X
 

config_changes/AC_comprehensive.ini

@@ -6,13 +6,6 @@
 ;changes must be in the correct section to get applied correctly.
 ;empty sections can be left out
 
-[general]
-
-;Enter the two letter code for language you want to use. Choosing nothing will default to English or the language chosen by the game itself. 
-;The mod is mainly in English while we have limited translation support and ongoing translation efforts from our community.
-;Example language codes: Czech is "cs", English is "en", French is "fr", German is "de", Hungarian is "hu, Russian is "ru", Spanish is "es", Turkish is "tr" 
-locale=
-
 [other]
 
 ; This setting normally makes newly installed mods enable themselves, including Factorio Access and compatible mods.