Map Structure

This documentation explains the complete structure of generated map files and directories. Understanding this organization will help you navigate and customize your maps effectively.

Archive Naming Convention

Generated map archives follow a standardized naming pattern that includes essential metadata:

Format: [Date]_[Time]_[Latitude]_[Longitude]_[GameVersion]

Components:

  • Game Version: FS25 (Farming Simulator 25)

  • Latitude: Center point latitude (e.g., 45.28571)

  • Longitude: Center point longitude (e.g., 20.23743)

  • Date: Generation date (e.g., 2024-12-10)

  • Time: Generation time (e.g., 23-43-55)

Directory Structure Overview

Background Terrain

Location: background/ and assets/background/

Contains the essential components for creating realistic background terrain meshes. This directory includes both 2D elevation data and 3D mesh files generated from Digital Elevation Models (DEM).

Key Files:

  • PNG Images: Raw DEM data files (can be safely removed after mesh generation)

  • FULL.obj: Complete 3D mesh file for background terrain rendering

Automated Assets: When Download Satellite Images and Generate Background are both enabled, Maps4FS automatically creates:

  • assets/background/background_terrain.i3d: Ready-to-import Giants Editor file

  • assets/background/textured_mesh/: Complete textured mesh files (obj, mtl, texture)

Usage:

  • Simply import assets/background/background_terrain.i3d directly into Giants Editor

For detailed implementation guidance, see the Background Terrain tutorial.

Water Planes

Location: water/ and assets/water/

Contains components for creating realistic water body meshes and planes. This directory includes both 2D water resource data and 3D mesh files generated from water areas in your map data.

Key Files:

  • PNG Images: Water resource data files

  • polygon_water.obj: Polygon-based water mesh source

  • polyline_water.obj: Polyline-based water mesh source (if applicable)

Automated Assets: When Generate Water is enabled, Maps4FS automatically creates:

  • assets/water/polygon_water.i3d: Ready-to-import Giants Editor file with proper ocean shader configuration

Usage:

  • Simply import assets/water/polygon_water.i3d directly into Giants Editor, then configure water properties

For detailed implementation guidance, see the Water Planes tutorial.

Core Map Components

Location: map/

Contains the primary map files and configuration data. This is the heart of your Farming Simulator map.

Configuration Files

Location: map/config/

XML configuration files that define various map behaviors and properties. While most files are auto-generated, some require manual configuration.

Critical Configuration: Farmlands

File: farmLands.xml

⚠️ IMPORTANT: This file requires manual configuration to match the farmlands InfoLayer in Giants Editor. Without proper configuration, land purchasing will not function in-game.

Configuration Example:

Key Attributes:

  • pricePerHa: Global land price per hectare

  • id: Unique farmland identifier

  • priceScale: Price multiplier for individual plots

  • npcName: Owner NPC designation

For comprehensive farmland configuration guidance, see the Farmlands documentation.

Map Data Directory

Location: map/data/

⚠️ CRITICAL: This directory contains all essential map assets. Missing files will cause Giants Editor crashes.

Texture Weight Files

Defines texture distribution across the map surface. Each weight file corresponds to a specific terrain texture.

For detailed texture management, see the Textures documentation.

InfoLayer Images

Specialized images that define various map properties including fields, farmlands, and collision data. While you don't need to manually edit these files, they're essential for map functionality.

Note: InfoLayers require editing in Giants Editor, particularly for Farmlands setup.

Digital Elevation Model (DEM)

Location: map/data/

Essential terrain elevation data that defines your map's topography.

Key Files:

  • dem.png: Primary elevation data used by Giants Editor and in-game

  • unprocessedHeightMap.png: Original elevation data before processing **

Version Note: The unprocessed height map is only available in Farming Simulator 25.

For comprehensive terrain elevation guidance, see the DEM documentation.

Map Definition Files

Primary Map File

File: map.i3d

The core map definition file containing all 3D geometry, lighting, and object placement data. While this XML-based file can be edited manually, it's recommended to use Giants Editor for modifications.

Map Configuration

File: map.xml

Contains references and paths to various map components. Manual editing should only be performed by experienced users who understand the file structure.

Visual Assets

In-Game Map Display

File: overview.dds

The minimap image displayed in-game.

New: Automatically generated when Download Satellite Images is enabled - no manual creation required!

Preview Assets

Location: previews/

Contains development and preview files generated during the map creation process. These files are safe to remove if not needed for future reference or debugging.

Generation Metadata

File: generation_info.json

Comprehensive metadata about the map generation process, including data sources, coordinates, and processing parameters. Valuable for recreating maps or accessing original data sources.

For complete metadata documentation, see the Generation Info documentation.

File: generation_logs.json

NEW: Detailed logging information from the map generation process, automatically collected and organized by log level for debugging and analysis purposes.

Structure:

Key Features:

  • Comprehensive Coverage: Includes ALL log levels (DEBUG, INFO, WARNING, ERROR, CRITICAL) regardless of console output level

  • Detailed Timestamps: Precise timing information for troubleshooting performance issues

  • Organized by Level: Easy filtering and analysis of specific log types

  • Session-Specific: Only contains logs from the specific generation session

  • Automatic Generation: No user configuration required - generated automatically during map creation

Usage:

  • Debugging: Identify specific issues during map generation

  • Performance Analysis: Track component processing times and bottlenecks

  • Support: Provide detailed logs when requesting help or reporting issues

  • Development: Analyze generation patterns and optimize workflows

Note: This file is safe to remove if detailed logging information is not needed for your use case.

Mod Package Files

Visual Identity

  • preview.dds: Map preview image (2048×2048 pixels)

Both files use the DDS format. For conversion tools and optimization, see the Getting Help documentation.

Mod Descriptor

File: modDesc.xml

Standard mod metadata including name, description, author information, and version details. This follows standard Farming Simulator modding conventions.

Complete Directory Tree

Below is the complete file structure of a generated map package:

Last updated