factoriomod-debug 1.1.24

package/readme.md

@@ -0,0 +1,14 @@
+# Factorio Modding Tool Kit
+
+A collection of tools for developing Factorio mods. This package is both an npm package providing the command line tool `fmtk`, and a VS Code Extension providing additional editor integration.
+
+ * [Debug Adapter](doc/debugadapter.md)
+ * [Mod Profiling](doc/profile.md)
+ * [JSON Validation](doc/language-json.md)
+ * [Language Support for Locale and Changelog files](doc/language.md)
+ * [Language Server integration for Lua](doc/language-lua.md) via [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
+ * [Packaging and Publishing](doc/package.md)
+
+## Support FMTK
+
+[<img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi2.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com'/>](https://ko-fi.com/X8X41IE4T)

package/schema/campaign.json

@@ -0,0 +1,42 @@
+{
+  "title": "Factorio Campaign description.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "oneOf": [
+    {
+      "allOf":[
+        {
+          "$ref": "scenario.json"
+        },
+        {
+          "type":"object",
+          "required":[
+            "starting-level"
+          ],
+          "properties": {
+            "starting-level":{
+              "type": "string"
+            },
+            "dependencies":{
+              "type":"array",
+              "description": "List of campaigns that must be completed before this one",
+              "items": {
+                "type":"string"
+              }
+            },
+            "difficulties":{
+              "type":"array",
+              "description": "List of difficulties this campaign supports",
+              "items": {
+                "enum": ["easy","normal","hard"]
+              },
+              "default": ["normal"]
+            }
+          }
+        }
+      ]
+    },
+    {
+      "type":"null"
+    }
+  ]
+}

package/schema/datainfo.json

@@ -0,0 +1,89 @@
+{
+  "title": "Factorio Data info.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "name":{
+      "type":"string",
+      "title": "Internal name of the mod",
+      "pattern": "[a-zA-Z0-9_-]+",
+      "maxLength": 100
+    },
+    "version": {
+      "type":"string",
+      "title": "Version String",
+      "pattern": "(\\d+\\.){2}\\d+"
+    },
+    "title": {
+      "type": "string",
+      "title": "Display name of the mod",
+      "description": "Can be overwritten by locale entry in the `mod-name` category",
+      "maxLength": 100
+    },
+    "author": {
+      "type": "string",
+      "title": "Author of the mod"
+    },
+    "contact": {
+      "type":"string",
+      "title": "Contact for this mod"
+    },
+    "homepage": {
+      "type": "string",
+      "title": "Homepage for the mod",
+      "description": "Please don't put \"None\" here, just leave it empty if none"
+    },
+    "description": {
+      "type": "string",
+      "title": "A short description of the mod to show in-game",
+      "description": "Can be overwritten by locale entry in the `mod-description` category"
+    },
+    "factorio_version": {
+      "type":"string",
+      "title": "The Factorio major version this mod supports",
+      "pattern": "\\d+\\.\\d+"
+    },
+    "dependencies": {
+      "type":"array",
+      "title": "Mods this mod depends on or are incompatible with",
+      "items": {
+        "type":"string",
+        "pattern": "^(([!?~]|\\(\\?\\)) *)?([a-zA-Z0-9_ -]+)( *([<>=]=?) *((\\d+\\.){1,2}\\d+))?$",
+        "defaultSnippets": [
+          {
+            "label": "simple",
+            "body": "${1:modname}"
+          },
+          {
+            "label": "version",
+            "body": "${1:modname} ${2|<,<=,>,>=,==|} ${3:0.0.0}"
+          },
+          {
+            "label": "incompatible",
+            "body": "! ${1:modname}"
+          },
+          {
+            "label": "optional",
+            "body": "? ${1:modname}"
+          },
+          {
+            "label": "hidden",
+            "body": "(?) ${1:modname}"
+          },
+          {
+            "label": "unordered",
+            "body": "~ ${1:modname}"
+          },
+          {
+            "label": "version",
+            "body": "${1:modname} ${2|<,<=,>,>=,==|} ${3:0.0.0}"
+          },
+          {
+            "label": "full",
+            "body": "${1| ,~,?,(?)|} ${2:modname} ${3|<,<=,>,>=,==|} ${4:0.0.0}"
+          }
+        ]
+      }
+    }
+  }
+}

package/schema/localeinfo.json

@@ -0,0 +1,21 @@
+{
+  "title": "Factorio Locale info.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required":[
+  ],
+  "properties": {
+    "language-name": {
+      "type":"string"
+    },
+    "font": {
+      "type":"object",
+      "additionalProperties": {
+        "type":"array",
+        "items": {
+          "type":"string"
+        }
+      }
+    }
+  }
+}

package/schema/mapgen.json

@@ -0,0 +1,85 @@
+{
+  "title": "Factorio Map Gen Settings",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "terrain_segmentation": {
+      "type":"number",
+      "description": "Inverse of map scale"
+    },
+    "water":{
+      "type":"number",
+      "description": "Multiplier for water 'coverage' - higher increases the water level.\nWater level = 10 * log2(this value)"
+    },
+    "width":{
+      "type":"integer",
+      "description": "Width of map, in tiles; 0 means infinite"
+    },
+    "height":{
+      "type":"integer",
+      "description": "Height of map, in tiles; 0 means infinite"
+    },
+    "starting_area":{
+      "type":"number",
+      "description": "Multiplier for 'biter free zone radius'"
+    },
+    "peaceful_mode":{
+      "type":"boolean"
+    },
+    "autoplace_controls":{
+      "type":"object",
+      "additionalProperties": {
+        "type":"object",
+        "properties": {
+          "frequency":{"type":"number"},
+          "size":{"type":"number"},
+          "richness":{"type":"number"}
+        }
+      }
+    },
+    "cliff_settings": {
+      "type":"object",
+      "properties": {
+        "name":{
+          "type":"string",
+          "description": "Name of the cliff prototype"
+        },
+        "cliff_elevation_0": {
+          "type":"number",
+          "description": "Elevation of first row of cliffs"
+        },
+        "cliff_elevation_interval": {
+          "type":"number",
+          "description": "Elevation difference between successive rows of cliffs"
+        },
+        "richness": {
+          "type":"number",
+          "description": "Multiplier for cliff continuity; 0 will result in no cliffs, 10 will make all cliff rows completely solid"
+        }
+      }
+    },
+    "property_expression_names": {
+      "description": "Overrides for property value generators\nElevation influences water and cliff placement.\nLeave it blank to get 'normal' terrain.\nUse '0_16-elevation' to reproduce terrain from 0.16.\nUse '0_17-island' to get an island.",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "starting_points":{
+      "type":"array",
+      "items": {
+        "type":"object",
+        "properties": {
+          "x":{"type":"number"},
+          "y":{"type":"number"}
+        }
+      }
+    },
+    "seed": {
+      "description": "Use null for a random seed, number for a specific seed.",
+      "oneOf": [
+        {"type":"null"},
+        {"type":"number"}
+      ]
+    }
+  }
+  }

package/schema/mapsettings.json

@@ -0,0 +1,166 @@
+{
+  "title": "Factorio Map Settings",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "difficulty_settings":
+    {
+      "type":"object",
+      "properties": {
+        "recipe_difficulty": {"type":"number"},
+        "technology_difficulty": {"type":"number"},
+        "technology_price_multiplier": {"type":"number"},
+        "research_queue_setting": {
+          "type":"string",
+          "enum": ["after-victory"]
+        }
+      }
+    },
+    "pollution":
+    {
+      "type":"object",
+      "properties": {
+        "enabled": {"type":"boolean"},
+        "diffusion_ratio": {"type":"number"},
+        "min_to_diffuse": {
+          "type":"number",
+          "description": "these are values for 60 ticks (1 simulated second)\namount that is diffused to neighboring chunk"
+        },
+        "ageing": {"type":"number"},
+        "expected_max_per_chunk": {"type":"number"},
+        "min_to_show_per_chunk": {"type":"number"},
+        "min_pollution_to_damage_trees": {"type":"number"},
+        "pollution_with_max_forest_damage": {"type":"number"},
+        "pollution_per_tree_damage": {"type":"number"},
+        "pollution_restored_per_tree_damage": {"type":"number"},
+        "max_pollution_to_restore_trees": {"type":"number"},
+        "enemy_attack_pollution_consumption_modifier": {"type":"number"}
+      }
+    },
+    "enemy_evolution":
+    {
+      "type":"object",
+      "properties": {
+        "enabled": {"type":"boolean"},
+        "time_factor": {"type":"number"},
+        "destroy_factor": {"type":"number"},
+        "pollution_factor": {"type":"number"}
+      }
+    },
+    "enemy_expansion":
+    {
+      "type":"object",
+      "properties": {
+        "enabled": {"type":"boolean"},
+        "min_base_spacing": {"type":"number"},
+        "max_expansion_distance": {"type":"number"},
+        "friendly_base_influence_radius": {"type":"number"},
+        "enemy_building_influence_radius": {"type":"number"},
+        "building_coefficient": {"type":"number"},
+        "other_base_coefficient": {"type":"number"},
+        "neighbouring_chunk_coefficient": {"type":"number"},
+        "neighbouring_base_chunk_coefficient": {"type":"number"},
+        "max_colliding_tiles_coefficient": {"type":"number"},
+        "settler_group_min_size": {"type":"number"},
+        "settler_group_max_size": {"type":"number"},
+        "min_expansion_cooldown": {"type":"number"},
+        "max_expansion_cooldown": {"type":"number"}
+      }
+    },
+    "unit_group":
+    {
+      "type":"object",
+      "properties": {
+        "min_group_gathering_time": {"type":"number"},
+        "max_group_gathering_time": {"type":"number"},
+        "max_wait_time_for_late_members": {"type":"number"},
+        "max_group_radius": {"type":"number"},
+        "min_group_radius": {"type":"number"},
+        "max_member_speedup_when_behind": {"type":"number"},
+        "max_member_slowdown_when_ahead": {"type":"number"},
+        "max_group_slowdown_factor": {"type":"number"},
+        "max_group_member_fallback_factor": {"type":"number"},
+        "member_disown_distance": {"type":"number"},
+        "tick_tolerance_when_member_arrives": {"type":"number"},
+        "max_gathering_unit_groups": {"type":"number"},
+        "max_unit_group_size": {"type":"number"}
+      }
+    },
+    "steering":
+    {
+      "type":"object",
+      "properties": {
+        "default":
+        {
+          "type":"object",
+          "properties": {
+            "radius": {"type":"number"},
+            "separation_force": {"type":"number"},
+            "separation_factor": {"type":"number"},
+            "force_unit_fuzzy_goto_behavior": {"type":"boolean"}
+          }
+        },
+        "moving":
+        {
+          "type":"object",
+          "properties": {
+            "radius": {"type":"number"},
+            "separation_force": {"type":"number"},
+            "separation_factor": {"type":"number"},
+            "force_unit_fuzzy_goto_behavior": {"type":"boolean"}
+          }
+        }
+      }
+    },
+    "path_finder":
+    {
+      "type":"object",
+      "properties": {
+        "fwd2bwd_ratio": {"type":"number"},
+        "goal_pressure_ratio": {"type":"number"},
+        "max_steps_worked_per_tick": {"type":"number"},
+        "max_work_done_per_tick": {"type":"number"},
+        "use_path_cache": {"type":"boolean"},
+        "short_cache_size": {"type":"number"},
+        "long_cache_size": {"type":"number"},
+        "short_cache_min_cacheable_distance": {"type":"number"},
+        "short_cache_min_algo_steps_to_cache": {"type":"number"},
+        "long_cache_min_cacheable_distance": {"type":"number"},
+        "cache_max_connect_to_cache_steps_multiplier": {"type":"number"},
+        "cache_accept_path_start_distance_ratio": {"type":"number"},
+        "cache_accept_path_end_distance_ratio": {"type":"number"},
+        "negative_cache_accept_path_start_distance_ratio": {"type":"number"},
+        "negative_cache_accept_path_end_distance_ratio": {"type":"number"},
+        "cache_path_start_distance_rating_multiplier": {"type":"number"},
+        "cache_path_end_distance_rating_multiplier": {"type":"number"},
+        "stale_enemy_with_same_destination_collision_penalty": {"type":"number"},
+        "ignore_moving_enemy_collision_distance": {"type":"number"},
+        "enemy_with_different_destination_collision_penalty": {"type":"number"},
+        "general_entity_collision_penalty": {"type":"number"},
+        "general_entity_subsequent_collision_penalty": {"type":"number"},
+        "extended_collision_penalty": {"type":"number"},
+        "max_clients_to_accept_any_new_request": {"type":"number"},
+        "max_clients_to_accept_short_new_request": {"type":"number"},
+        "direct_distance_to_consider_short_request": {"type":"number"},
+        "short_request_max_steps": {"type":"number"},
+        "short_request_ratio": {"type":"number"},
+        "min_steps_to_check_path_find_termination": {"type":"number"},
+        "start_to_goal_cost_multiplier_to_terminate_path_find": {"type":"number"},
+        "overload_levels": {
+          "type":"array",
+          "items": {
+            "type":"number"
+          }
+        },
+        "overload_multipliers": {
+          "type":"array",
+          "items": {
+            "type":"number"
+          }
+        }
+      }
+    },
+    "max_failed_behavior_count": {"type":"number"}
+    }
+
+  }

package/schema/modinfo.json

@@ -0,0 +1,124 @@
+{
+  "title": "Factorio Mod info.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "allOf":[
+    {
+      "$ref": "datainfo.json"
+    },
+    {
+      "type": "object",
+      "required":[
+        "name", "version", "title", "author", "factorio_version"
+      ],
+      "defaultSnippets": [
+        {
+            "label": "mod",
+            "body": {
+              "name": "$1",
+              "title": "$2",
+              "description": "$3",
+              "version": "${4:0.0.0}",
+              "author": "$5",
+              "factorio_version": "1.1"
+            }
+        }
+      ],
+      "properties": {
+        "factorio_version": {
+          "default": "1.1"
+        },
+        "package": {
+          "type":"object",
+          "description": "Configuration for automatically packaging and publishing this mod [VSCode Extension]",
+          "properties": {
+            "ignore":{
+              "type":"array",
+              "description": "Globs to ignore when building zip package",
+              "items": {
+                "type":"string",
+                "format": "glob"
+              }
+            },
+            "extra":{
+              "type":"array",
+              "description": "Directories containing extra files to include in the zip package",
+              "items": {
+                "type":"object",
+                "required": ["root"],
+                "properties":{
+                  "root":{
+                    "type":"string",
+                    "description": "Directory containing extra files to include in the zip package"
+                  },
+                  "glob":{
+                    "type":"string",
+                    "description": "Glob for matching files to include from this directory",
+                    "default": "**"
+                  },
+                  "ignore":{
+                    "type":"array",
+                    "description": "Globs to ignore in this root",
+                    "items": {
+                      "type":"string",
+                      "format": "glob"
+                    }
+                  }
+                }
+              }
+            },
+            "no_git_push": {
+              "type":"boolean",
+              "description": "Don't automatically `git push` in Publish"
+            },
+            "no_git_tag": {
+              "type":"boolean",
+              "description": "Don't automatically `git tag` in Publish"
+            },
+            "git_publish_branch": {
+              "type":["string", "null"],
+              "description": "Name of branch to Publish from. Defaults to the value of `git config init.defaultBranch` if not present. Set `null` to allow any branch."
+            },
+            "no_portal_upload": {
+              "type":"boolean",
+              "description": "Don't automatically upload to the mod portal in Publish"
+            },
+            "scripts":{
+              "type":"object",
+              "description": "Additional scripts to run while packaging/publishing mods",
+              "additionalProperties": {
+                "type":"string",
+                "description": "Additional scripts to run with `fmtk run name`"
+              },
+              "properties": {
+                "prepublish": {
+                  "type":"string",
+                  "description": "Command to run while preparing the pre-publish commit. Files added to git during this command will be included in that commit."
+                },
+                "datestamp": {
+                  "type":"string",
+                  "description": "Command to run after datestamping the changelog."
+                },
+                "prepackage": {
+                  "type":"string",
+                  "description": "Command to run while preparing the zip package. Files created/changed during this command will be included in the zip."
+                },
+                "version": {
+                  "type":"string",
+                  "description": "Command to run after incrementing the version."
+                },
+                "publish": {
+                  "type":"string",
+                  "description": "Command to run while preparing the post-publish commit, after incrementing the version. Files added to git during this command will be included in that commit."
+                },
+                "postpublish": {
+                  "type":"string",
+                  "description": "Command to run after automatic uploads."
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/schema/scenario.json

@@ -0,0 +1,28 @@
+{
+  "title": "Factorio Scenario description.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "oneOf": [
+    {
+      "type": "object",
+      "required":[
+        "order", "multiplayer-compatible"
+      ],
+      "properties": {
+        "order":{
+          "type":"string"
+        },
+        "multiplayer-compatible":{
+          "type": "boolean",
+          "default": false
+        },
+        "is-main-game":{
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
+    {
+      "type": "null"
+    }
+  ]
+}