==========================================================================================================
                       FS25_CUSTOM FARM LOGO - USER GUIDE
==========================================================================================================
Author:  Sunil [Sarmy Farm]
Version: 1.0.0.0

Thank you for downloading the Custom Farm Logo mod! 

This tool allows players and contractors to integrate their 
specific virtual farm company or team branding directly into 
the user interface. It creates a more professional, immersive 
roleplay experience.

----------------------------------------------------------------------------------------------------------
1. INSTALLATION & SETUP
----------------------------------------------------------------------------------------------------------
STEP 1: INITIALIZE
- Enable the mod in your savegame.
- Start the game once, then save and exit.
- The mod automatically creates a configuration folder:
  [ Documents/My Games/FarmingSimulator2025/modSettings/FS25_CustomFarmLogo ]
- On first launch, a copy of this user guide will automatically 
  be generated as 'readme.txt' inside that folder.

STEP 2: FILE REQUIREMENTS
- Formats: PNG or DDS (DDS format is recommended for better visual clarity and texture streaming performance).
- Resolution: Supports any resolution but you should always create your logo using a "power of 2" dimension.
  (A resolution of 512x512 is highly recommended for performance optimization and VRAM savings on mid-to-lower end PCs)
- Background: The image background MUST be transparent.

STEP 3: ADD YOUR LOGOS (MULTIPROFILE SLOTS)
- You can now add up to 20 unique logos to switch between!
- Paste your custom images into the folder path from Step 1.
- Rename your files to: logo1, logo2, logo3 ... up to logo20.
  (Must be all lowercase with no spaces or symbols).
- Fallback: A default "My Farm" icon is included inside the 
  mod and will show on any empty or unassigned slots.
- Priority: If both logoX.png and logoX.dds exist for the 
  same slot, the mod will automatically load the .dds file.

----------------------------------------------------------------------------------------------------------
2. IN-GAME CONTROLS (EDIT MODE MENU)
----------------------------------------------------------------------------------------------------------
Note: To ensure compatibility with vehicle controls and other active scripts, Edit Mode is accessible ON FOOT ONLY.

Press [LEFT SHIFT + L] to toggle the Edit Mode HUD panel (Visible in the F1 Menu).

• 1. VISIBLE     -> Press [ O ] to toggle logo overlay ON/OFF.
• 2. LOGO SLOT   -> Press [ I ] (Forward) or [ U ] (Backward).
• 3. MOVE        -> Hold [ RIGHT SHIFT ] + [ K / J / N / M ].
• 4. SIZE        -> Press [ M ] (Increase) or [ N ] (Decrease).
• 5. OPACITY     -> Press [ K ] (Solid) or [ J ] (Transparent).
• 6. RESET       -> Press [ BACKSPACE ] to reset to defaults.
• 7. SAVE & EXIT -> Press [ ENTER ] to close.
• CANCEL CHANGES -> Press [LEFT SHIFT + L] again while editing to completely close the menu, discard your changes,
                    and restore your last saved settings.
					
----------------------------------------------------------------------------------------------------------
3. MULTIPLAYER & ONLINE SESSIONS
----------------------------------------------------------------------------------------------------------
This mod is 100% multiplayer-safe. All settings and logos run entirely on your own PC, giving you total freedom.

• SAFE SEPARATE FILES
  Online layouts save to 'multiplayer_settings.xml'. Your single-player career setups are never overwritten.

• INDEPENDENT HUD SCREENS
  Moving, resizing, or hiding the logo (Key O) only changes your monitor. It will not affect other players.

• PERSONAL CUSTOM LOGOS
  The mod reads your own personal folder, not the server:
  - If you load slot 1 with a Case IH logo, you see Case IH.
  - If a friend loads slot 1 with John Deere, they see John Deere.
  - If a player has no custom files, they see the "My Farm" icon.

• MIXED FORMATS ARE OK
  You can use PNG while others use DDS in the same slot. It will load perfectly with zero server lag or sync issues.

----------------------------------------------------------------------------------------------------------
4. ADVANCED TECHNICAL NOTES
----------------------------------------------------------------------------------------------------------
• EASY GRAPHIC OPTIMIZATION
  While PNG files work perfectly, converting your logos to .DDS format using Paint.net or the GIANTS Texture 
  Tool reduces file sizes, provides better visual clarity and texture streaming performance, and helps 
  the game load your images much faster.
  LINK: https://gdn.giants-software.com/downloads.php

• AUTOMATIC HIDE FEATURE
  The logo is designed to stay out of your way. It automatically hides whenever you turn off the HUD for 
  screenshots, browse the shop, look at the pause map, or open game menus.

• SMART SAVE SLOT MEMORY
  The mod instantly recognizes which savegame slot you are playing on. It saves your logo positions 
  into separate files (like savegame1settings.xml) so your single-player setups and multiplayer layouts 
  never mix up.

• RELIABLE MULTIPLAYER STABILITY
  When playing online or on a dedicated server, the mod safely bundles your settings into a single file 
  called 'multiplayer_settings.xml'. This keeps everything perfectly synchronized with the server.

• SMOOTH LIVE SWITCHING
  When you switch between different logo slots while playing, the mod automatically cleans up the game's 
  temporary image memory. This prevents micro-stutters and keeps your gameplay completely smooth.

----------------------------------------------------------------------------------------------------------
5. SUPPORT & FEEDBACK
----------------------------------------------------------------------------------------------------------
For updates and community feedback, please visit the official ModHub page.
Got a suggestion or a new feature idea? Reach out on our platform!

• Official YouTube Channel: Sarmy Farm  (@SarmyFarm)
  Subscribe for mod updates, showcases, and development tutorials!

Enjoy your custom farm branding!
==========================================================================================================
