factoriomod-debug 1.1.24

package/doc/debugadapter.md

@@ -0,0 +1,29 @@
+# Debug Adapter
+
+## Using Factorio Mod Debug
+
+* Install the **Factorio Mod Debug** extension in VS Code.
+* Switch to the run/debug view (View->Run) and select "create a launch.json file"
+* Select the debug environment "Factorio Mod Debug".
+* Adjust the paths and launch settings as required. Check Intellisense for additional launch options.
+* Press the green 'play' button or F5 to start debugging.
+
+## Debugging inside Zip Files
+
+If [Zip File Explorer](https://marketplace.visualstudio.com/items?itemName=slevesque.vscode-zipexplorer) is also installed, breakpoints and stepping will work inside zipped mods.
+
+## Steam
+
+If you use a Steam install, a file `steam_appid.txt` with content `427520` in the same dir as the factorio binary is required. If the Debug Adapter has write access to the dir, it will create this automatically.
+
+## Runtime Lua Diagnostics
+
+The debugger also injects runtime diagnostics into all hooked mods:
+
+  * Global Assignment: A warning will be issued on the first assignment to an undefined global variable. `__DebugAdapter.defineGlobal(name)` can be used to disable this warning for the given name.
+  * Event Handler Replacement: A warning will be issued when an event handler is registered to an event that already has a handler that is not equal to the new one.
+
+## Advanced Features
+
+  * [Debugger Mod API](doc/debugapi.md)
+  * [Custom Debug Views](doc/variables.md)

package/doc/debugapi.md

@@ -0,0 +1,37 @@
+# Debugger API
+
+## Detecting Debugging
+
+Mods may detect that the debugger is attached by the presence of the global variable `__DebugAdapter`. Mods **MUST NOT** create this variable themselves, or write to any fields within it.
+
+## String Interpolation
+
+Several locations in the interface use string interpolation with expressions in `{}`. The inner expression is evaluated as lua code. `{[}` and `{]}` can be used to emit literal `{` and `}`.
+
+When used with Logpoint expressions, exception strings, and `__DebugAdapter.print()`, the inner expression has access to all locals and upvalues at the current location, and the expression `{...}` will represent the varargs available at that location, if available.
+
+The expression always has access to globals.
+
+## Debug Print
+
+The function `__DebugAdapter.print(expr,alsoLookIn)` can be used to print messages using string interpolation to the vscode debug console. An indexable object `alsoLookIn` may provide additional values for the expressions in the string, which will be used before other variables.
+
+## Manual Breakpoints
+
+If normal breakpoints are unusable for some reason, you can call `__DebugAdapter.breakpoint(mesg:LocalisedString)` to break. If `mesg` is specified, it is displayed in the editor like an exception.
+
+## Terminate Session
+
+`__DebugAdapter.terminate()` can be used to terminate a debug session from mod code.
+
+## Simulate Events
+
+`__DebugAdapter.raise_event(event:defines.events|number|string,data:EventData,modname:string)` can be used to call event handlers directly for testing. `data` is not validated, so you must ensure it is a well-formed event payload for `event` yourself. All event and custom-input handlers are raisable, even those not raisable through `script`.
+
+## Ignore Functions in Stepping
+
+Functions can be excluded from stepping with `__DebugAdapter.stepIgnore(funcOrTable)`.
+
+## Disable dumping for large files
+
+files can be excluded from dumping with `__DebugAdapter.dumpIgnore(nameOrNames)`. These must be exact source names, e.g. `"@__modname__/file.lua"`. This will disable disassembly, breakpoint validation, phobos debug symbols, and possibly other future features in these files. This may be appropriate if you are experiencing long hangs on `require`s of large (5+MB) data files.

package/doc/language-json.md

@@ -0,0 +1,9 @@
+# JSON Validation
+
+JSON Validation and Intellisense is provided for all of Factorio's JSON files:
+  * Mod `info.json`
+  * Scenario and Campaign `description.json`
+  * Locale `info.json`
+  * `map-settings.json`
+  * `map-gen-settings.json`
+  * `server-settings.json`

package/doc/language-lua.md

@@ -0,0 +1,82 @@
+# Sumneko Lua LSP integration
+
+FMTK provides a third party library package for the [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) language server which provides various adaptations to Factorio's Lua environment. The VS Code extension will automatically install this when a Factorio version is selected, or it can be generated manually with `fmtk sumneko-3rd`.
+
+In addition to the runtime-api docs (generated from [`runtime-api.json`](https://lua-api.factorio.com/latest/json-docs.html)), this package includes several static library files, configuration settings and a sumneko plugin that enables enhanced handling of `require`, `global`, event handlers, and `remote` interfaces.
+
+## Runtime API Docs
+
+Factorio's [`runtime-api.json`](https://lua-api.factorio.com/latest/json-docs.html) is used to generate class definitions for most of the runtime API.
+
+Event payload types are generated as subclasses of the generic event payload `EventData`, named like `EventData.on_event_name`.
+
+Some types in the API have multiple definitions for the same type name, especially Concepts which accept both named-keys tables or array-like tables. In these cases the type will be a union of the set of definions, with the subtypes named `TypeName.0`, `TypeName.1`, etc.
+
+In addition to the types listed in the json, a few extra related types are defined:
+ * `LuaObject.object_name`: Union of all LuaObject class names seen in the json.
+ * `BlueprintCircuitConnection`, `BlueprintControlBehavior`: Concepts referenced by the json but not present in it. These are included in the static libraries.
+
+## Libraries
+
+Factorio [modifies some builtin libraries](https://lua-api.factorio.com/latest/Libraries.html), and this package includes corresponding modified definitions for those libraries.
+
+Type definitions are also included for some of the libraries included in `__core__/lualib`, such as `util` and `mod-gui`.
+
+## Configuration
+
+The VS Code extension will automatically configure `"Lua.workspace.userThirdParty"` when installing this package, as well as updating `"Lua.workspace.library"` with a link to `/data` in the selected version.
+
+## Plugin Features
+
+Because Factorio mods run in [several Lua VMs](https://lua-api.factorio.com/latest/Data-Lifecycle.html), some functions have cross-VM behavior that cannot be described fully with type definitions. We handle these by providing a plugin which transforms them into a more easily understood form before the Language Server sees them.
+
+### `require()`
+
+Factorio allows requiring files from another mod with a `__modname__` prefix:
+```lua
+require("__modname__.filename")
+```
+
+The underscores are removed from these, allowing the Language Server to properly locate files if the modname matches a directory in the workspace (or libraries).
+
+### `global`
+
+Each mod has its own private version of [the global named `global`](https://lua-api.factorio.com/latest/Global.html). To allow the Language Server to see this separation, `global` is renamed to `__modname__global` when used as the base variable in indexing or the target of assignment.
+
+### Event Handlers
+
+When inline functions are used as event handlers, a `@param` tag will be automatically inserted for the event-specific payload type, to make all the event fields visible.
+
+### `remote` interfaces
+
+Because `remote` interfaces are registered and called through separate API functions, the Language Server can't make the appropriate connections to provide signature help when calling. To address this, `remote.call` and `remote.add_interface` are transformed to appear as direct access through a virtual table `__typed_interfaces`:
+
+```lua
+remote.add_interface("foo", {
+  ---@param hello string
+  ---@param world string
+  ---@return number
+  bar = function(hello, world)
+    return 42
+  end,
+})
+
+remote.call("foo", "bar", "arg 1", "arg 1")
+```
+Would appear to the Language Server as
+```lua
+remote.__typed_interfaces.foo = ({
+  ---@param hello string
+  ---@param world string
+  ---@return number
+  bar = function(hello, world)
+    return 42
+  end,
+})
+
+remote.__typed_interfaces.foo.bar("arg 1", "arg 2")
+```
+
+### LuaObject Type Tests
+
+To allow the Language Server to see that `LuaObject.object_name` is "like `type()`" for type tests, such as `if obj.object_name == "LuaPlayer" then end`, the plugin rewrites it to appear as an internal function `if __object_name(obj) == "LuaPlayer" then end`, and this function is marked as "like `type()`" in the configuration.

package/doc/language.md

@@ -0,0 +1,15 @@
+# Changelog and Locale
+
+## Syntax Highlighting
+
+Syntax highlighting is provided for Changelog and Locale files with Textmate grammar, and snippets are provided for many common patterns.
+
+## Changelog Language Server
+
+The `fmtk lsp` language server provides support for changelog files, including document outline and syntax validation.
+
+## Locale Language Server
+
+The `fmtk lsp` language server provides support for locale files, including document outline and syntax validation.
+
+In addition, locale keys are provided as completion items when typing strings in Lua, and "Go To Definition" is supported on locale key strings in Lua.

package/doc/package.md

@@ -0,0 +1,49 @@
+# Automatic Mod Packaging and Publishing
+
+Mods can be automatically Packaged and Published from the "Factorio Mod Packages" panel (in SCM view by default, View->Open View...-> "Factorio Mod Packages" if you can't find it).
+
+## API Key
+
+Uploading to the mod portal requires an API key with the `ModPortal: Upload Mods` usage, which can be created on https://factorio.com/profile. You will be prompted for this key when it is first required.
+
+## Tasks
+
+These tasks can also be accessed in VSCode's Tasks system. Custom scripts will run inside the mod directory and have the environment variables `FACTORIO_MODNAME` and `FACTORIO_MODVERSION` provided. Tasks can also be run from command line with `fmtk`.
+
+### Run Script
+  * run any script from `info.json#/package/scripts[name]`
+
+### Datestamp
+  * if changelog.txt present and has a section for the current version, update its date to today
+  * run `info.json#/package/scripts/datestamp` if set
+
+### Package
+  * run `info.json#/package/scripts/compile` if set
+  * run `info.json#/package/scripts/prepackage` if set
+  * build a zip including all files in the mod directory except dotfiles, zip files named `modname_*.zip`, and files matching the list of globs in `info.json#/package/ignore`. If you need to include other files, you can list additional root directories in `info.json#/package/extra`. You are responsible for ensuring that you don't include directories that result in two files of the same name in the zip! (Because my zip library doesn't tell me when this happens.)
+
+### Increment Version
+  * increment version in info.json
+  * if changelog.txt present, add new empty section to changelog.txt
+  * run `info.json#/package/scripts/version` if set
+
+### Upload
+  * select a package in mod directory
+  * upload to mod portal
+
+### Publish
+
+All-in-one command.
+
+  * verify no uncommitted changes, on default branch (`git config init.defaultBranch`, or branch set in `info.json#/package/git_publish_branch`)
+  * run `info.json#/package/scripts/prepublish` if set
+  * run **Datestamp**
+  * git commit "preparing release of version x.y.z", tag x.y.z
+  * run **Package**
+  * git tag, unless `info.json#/package/no_git_tag` is set
+  * run `info.json#/package/scripts/publish` if set
+  * upload to mod portal, unless `info.json#/package/no_portal_upload` is set
+  * run `info.json#/package/scripts/postpublish` if set, with extra environment variable `FACTORIO_MODPACKAGE` with the filename of the built zip in a temporary folder.
+  * run **Increment Version**
+  * commit "moved to version x.y.z"
+  * push to git upstream, unless `info.json#/package/no_git_push` is set

package/doc/profile.md

@@ -0,0 +1,9 @@
+# Profiling
+
+Setting `"hookMode": "profile"` in your launch config to enables profiling. This mode does not provide debug feaures (stepping, inspection, etc), but instead provides inline timing/hitcount data for every line and function executed in control stage. Flamegraph, highlighting and rulers are also provided to assist in finding hotspots. Mods may recognize the this mode by the presence of the global variable `__Profiler`. Mods **MUST NOT** create this variable themselves, or write to any fields within it.
+
+The profiler also provides a remote inteface `profiler` with the following functions:
+
+  * `dump()` - dump all timers immediately
+  * `slow()` - return to slow-start mode (dumping on return from every event temporarily)
+  * `save(name)` - return to slow-start mode and trigger an autosave with the given name. Defaults to "profiler" if unspecified.

package/doc/variables.md

@@ -0,0 +1,21 @@
+# Custom Debug Views
+
+The debug views of tables can be customized using metatables to override default rendering.
+
+The default lineitem for a table can be overridden by the metamethod `__debugline`, which can be either a string or a function `__debugline(self)->string` which takes the table as an argument and returns a string. If `__debugline` is a string, [String Interpolation](./debugapi.md#string-interpolation) will be applied, with members of the current object avaliable to expressions, as well as the object itself as `self`.
+
+The typename for a table can be overridden by a string in the metatable field `__debugtype`. This is only used for display in the DAP client.
+
+By default, the metatable will be listed as a virtual member `<metatable>`.The displayed contents of the table can be overridden with `__debugcontents` which can be `false` to omit contents entirely, or a function `__debugcontents(self,extra?)->__debugnext,t,k` which returns an iterator `__debugnext(t,k)->nextk,nextv,renderOpts?`. You may use the functions in `__debugadapter__/iterutil.lua` to assist in creating these iterators.
+
+```lua
+---@class DebugAdapter.RenderOptions
+---@field rawName? boolean
+---@field rawValue? boolean
+---@field virtual? boolean
+---@field ref? table|function @ Object to expand children of instead of this value
+---@field fetchable? boolean @ if ref or value is function, treat as fetchable property instead of raw function
+---@field extra? any @ Extra object to pass back to `__debugcontents`
+```
+
+If using [hediet.debug-visualizer](https://marketplace.visualstudio.com/items?itemName=hediet.debug-visualizer), you can configure it to use `"context": "visualize"` to get json output on its eval requests. You must provide your own object conversions to produce objects compatible with the visualizer interface types. If the eval result has a `__debugvisualize(self)` metamethod, it will be called automatically before being converted to json.

package/doc/workspace.md

@@ -0,0 +1,35 @@
+# Setting up your workspace for Modding
+
+A lot of people ask how to set up a workspace when they first start modding, so I thought I'd write down some of the repeated answers I give. This isn't the only way to do things, but this is how I do it, and I find it works pretty well.
+
+## Workspace Layout
+
+I open the Factorio `mods` directory as the root of my workspace in VSCode, and check out each mod's git repo directory into that. This simplifies debugger config as it is able to detect `mod-list.json` in the workspace and automatically configure all unspecified `modsPath`s in `launch.json`.
+
+  * `mods/`
+    * `.vscode/`
+      * `launch.json`
+      * `settings.json`
+    * `modname/`
+      * `.git/...`
+      * `info.json`
+      * `control.lua`
+      * `data.lua`
+      * ...
+    * `anothermod/`
+      * ...
+
+
+## Editor & Extensions
+
+I use [VScode](https://code.visualstudio.com/) (imagine that!), but it needs a few extensions to really shine in this context:
+
+ * [Factorio Mod Debugger](https://marketplace.visualstudio.com/items?itemName=justarandomgeek.factoriomod-debug) - You are here
+ * A Lua language server. I like to use [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua), and the Factorio Mod Debugger has some extended support for it.
+ * Optional: [Zip File Explorer](https://marketplace.visualstudio.com/items?itemName=slevesque.vscode-zipexplorer). Enables viewing files inside zips, which allows breakpoints/stepping inside them as well.
+ * Optional: [indent-rainbow](https://marketplace.visualstudio.com/items?itemName=oderwat.indent-rainbow)
+ * Optional: [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph). I happen to like the graph git log view this extension gives as a place to do manual git operations more complicated than the builtin SCM view provides for.
+
+To provide Factorio Lua API autocompletion, the Factorio mod debugger extension generates EmmyLua docs from the Factorio JSON docs, which are then used by the [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) language server for its autocompletion feature. Click the Factorio version selection in the status bar to get started!
+
+Don't forget to read [the readme](../readme.md) for information about using the Factorio Mod Debugger itself.

package/images/viewicon.svg

@@ -0,0 +1,30 @@
+<?xml version='1.0' encoding='ascii'?>
+<svg xmlns="http://www.w3.org/2000/svg" height="141" version="1.1" width="128">
+    <g id="View Layer_LineSet" inkscape:groupmode="lineset" inkscape:label="View Layer_LineSet" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape">
+        <g id="strokes" inkscape:groupmode="layer" inkscape:label="strokes" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape">
+            <path d=" M 24.226, 47.492 14.885, 51.063 11.282, 52.439 21.179, 53.871 31.076, 55.303 33.793, 55.696 33.912, 55.713 43.809, 57.145 47.797, 57.722 51.795, 58.300 54.414, 58.679 64.311, 60.111 74.208, 61.542 77.135, 61.966 86.476, 58.396 95.989, 54.760 96.329, 54.630 105.670, 51.059 115.011, 47.489 117.649, 46.481 107.752, 45.049 105.712, 44.754 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 11.282, 89.730 11.282, 99.730 11.282, 109.730 11.282, 119.730 11.282, 127.589 21.179, 129.020 31.076, 130.452 40.973, 131.884 50.870, 133.316 60.767, 134.747 70.664, 136.179 77.135, 137.115 86.476, 133.545 95.817, 129.975 105.158, 126.404 114.499, 122.834 117.649, 121.630 117.649, 111.630 117.649, 101.630 117.649, 91.630 117.649, 85.107 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 77.135, 61.966 77.135, 71.966 77.135, 73.642 77.135, 75.518 77.135, 85.518 77.135, 95.518 77.135, 105.518 77.135, 115.518 77.135, 125.518 77.135, 135.518 77.135, 137.115 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 117.649, 46.481 119.443, 56.319 121.237, 66.156 123.031, 75.994 124.234, 82.590 117.649, 85.107 108.308, 88.677 98.967, 92.247 89.626, 95.817 83.721, 98.074 81.927, 88.237 80.132, 78.399 79.402, 74.393 79.322, 73.958 79.281, 73.730 77.487, 63.892 77.135, 61.966 76.038, 71.905 75.867, 73.458 75.669, 75.251 75.588, 75.982 74.491, 85.921 73.394, 95.861 73.084, 98.670 63.187, 97.239 53.290, 95.807 51.795, 95.591 41.898, 94.159 32.001, 92.727 22.104, 91.296 12.207, 89.864 11.282, 89.730 7.231, 89.144 7.631, 85.521 8.728, 75.582 9.825, 65.642 10.922, 55.703 11.282, 52.439 9.392, 62.259 7.501, 72.079 5.610, 81.898 4.697, 86.643 7.631, 85.521 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 51.504, 47.045 51.795, 48.012 52.233, 49.462 53.483, 51.808 53.604, 51.955 55.169, 53.866 57.226, 55.556 59.575, 56.813 62.126, 57.589 64.780, 57.854 67.435, 57.599 69.990, 56.832 72.346, 55.584 74.413, 53.902 76.111, 51.851 77.376, 49.510 78.158, 46.968 78.427, 44.324 78.226, 42.231 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 96.329, 54.630 97.303, 51.462 105.288, 50.923 105.733, 45.055 105.712, 44.754 105.323, 39.185 105.232, 38.505 97.250, 37.936 95.387, 31.757 92.610, 26.547 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 78.249, 47.647 77.467, 50.189 76.203, 52.530 74.504, 54.582 72.438, 56.264 70.081, 57.512 67.526, 58.278 64.871, 58.534 62.217, 58.268 59.667, 57.492 57.318, 56.235 55.261, 54.545 53.684, 52.621 53.574, 52.488 52.324, 50.142 51.795, 48.388 51.557, 47.597 51.504, 47.045 51.303, 44.952 51.573, 42.308 51.795, 41.583 52.196, 40.280 52.354, 39.766 53.619, 37.425 53.771, 37.240 55.317, 35.374 57.384, 33.692 59.740, 32.443 62.295, 31.677 64.951, 31.421 67.604, 31.687 70.155, 32.463 72.504, 33.720 74.561, 35.410 76.247, 37.467 77.498, 39.813 77.768, 40.712 78.226, 42.231 78.264, 42.358 78.518, 45.003 78.249, 47.647 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 105.323, 39.185 97.341, 38.616 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 97.250, 37.936 97.341, 38.616 95.479, 32.436 92.442, 26.739 92.610, 26.547 97.711, 20.733 97.620, 20.054 93.770, 15.595 89.313, 11.738 83.260, 16.959 77.555, 13.906 71.408, 12.035 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 97.711, 20.733 93.861, 16.275 89.404, 12.417 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 89.313, 11.738 89.404, 12.417 83.351, 17.638 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 83.260, 16.959 83.351, 17.638 77.646, 14.585 71.453, 12.700 71.408, 12.035 70.920, 4.745 70.829, 4.066 64.939, 3.629 59.046, 4.044 58.467, 11.996 52.262, 13.858 46.540, 16.889 40.517, 11.646 36.038, 15.486 32.161, 19.930 32.253, 20.610 37.205, 26.310 37.487, 26.635 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 70.920, 4.745 65.030, 4.309 59.138, 4.723 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 59.046, 4.044 59.138, 4.723 58.559, 12.675 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 58.467, 11.996 58.559, 12.675 52.354, 14.537 46.631, 17.569 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 46.540, 16.889 46.631, 17.569 40.609, 12.325 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 40.517, 11.646 40.609, 12.325 36.130, 16.166 32.253, 20.610 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 37.205, 26.310 34.325, 31.642 32.427, 37.814 24.442, 38.353 23.997, 44.221 24.226, 47.492 24.407, 50.091 24.499, 50.770 32.480, 51.339 33.793, 55.696 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 37.487, 26.635 34.417, 32.321 32.518, 38.493 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 32.427, 37.814 32.518, 38.493 24.533, 39.032 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 24.442, 38.353 24.533, 39.032 24.088, 44.900 24.268, 47.476 24.499, 50.770 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 51.795, 41.583 51.795, 48.012 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+            <path d=" M 77.768, 40.712 67.871, 39.280 57.974, 37.848 53.771, 37.240 " fill="none" stroke="rgb(0, 0, 0)" stroke-linecap="butt" stroke-linejoin="round" stroke-opacity="1.0" stroke-width="6.0" />
+        </g>
+    </g>
+</svg>

package/language/factorio-changelog.json

@@ -0,0 +1,28 @@
+{
+  "Version Block": {
+    "prefix": ["versionblock"],
+    "body": [
+      "---------------------------------------------------------------------------------------------------",
+      "Version: ${1:${TM_DIRECTORY/^.+_(\\d+\\.\\d+\\.\\d+)$/${1:0.0.0}/}}",
+      "Date: ${2:????}",
+      "  ${3:Changes}:",
+      "    - $0"
+    ],
+    "description": "A new version block"
+  },
+  "Version": {
+    "prefix": ["version"],
+    "body": ["Version: ${1:${TM_DIRECTORY/^.+_(\\d+\\.\\d+\\.\\d+)$/${1:0.0.0}/}}"],
+    "description": "Version line with auto-detected version"
+  },
+  "Date": {
+    "prefix": ["date"],
+    "body": ["Date: ${1:$CURRENT_YEAR}-${2:$CURRENT_MONTH}-${3:$CURRENT_DATE}"],
+    "description": "Date line"
+  },
+  "Unspecified Date": {
+    "prefix": ["undate"],
+    "body": ["Date: ${1:????}"],
+    "description": "Date line with unspecified date"
+  }
+}

package/language/factorio-changelog.language-configuration.json

@@ -0,0 +1,13 @@
+{
+    "comments": {
+    },
+    // symbols used as brackets
+    "brackets": [
+    ],
+    // symbols that are auto closed when typing
+    "autoClosingPairs": [
+    ],
+    // symbols that that can be used to surround a selection
+    "surroundingPairs": [
+    ]
+}

package/language/factorio-changelog.tmLanguage.json

@@ -0,0 +1,77 @@
+{
+	"$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
+	"name": "Factorio Changelog",
+	"patterns": [
+		{
+			"name": "keyword.control.factorio-changelog",
+			"match": "^-{99}$"
+		},
+		{
+			"name": "invalid.keyword.control.factorio-changelog",
+			"match": "^-{1,98}$"
+		},
+		{
+			"name": "invalid.keyword.control.factorio-changelog",
+			"match": "^-{100,}$"
+		},
+		{
+			"name": "variable.language.version.factorio-changelog",
+			"match": "^Version: ((?:\\d+)\\.(?:\\d+)(?:\\.(?:\\d+))?)(.*)$",
+			"captures": {
+				"1": {
+					"name": "constant.numeric.version.factorio-changelog"
+				},
+				"2": {
+					"name": "comment.line.version.extra.factorio-changelog"
+				}
+
+			}
+		},
+		{
+			"name": "variable.language.date.factorio-changelog",
+			"match": "^Date: (.+)$",
+			"captures": {
+				"1": {
+					"name": "string.unquoted.date.factorio-changelog"
+				}
+			}
+		},
+		{
+			"match": "^  (((Major|Minor) )?Features|Graphics|Sounds|Optimi[sz]ations|(Combat )?Balancing|Circuit Network|Changes|Bugfixes|Modding|Scripting|Gui|Control|Translation|Debug|Ease of use|Info|Locale|Other):$",
+			"captures": {
+				"1": {
+					"name": "entity.name.class.factorio-changelog"
+				}
+			}
+		},
+		{
+			"match": "^  ([^ ].+):$",
+			"captures": {
+				"1": {
+					"name": "entity.name.function.factorio-changelog"
+				}
+			}
+		},
+		{
+			"match": "^    - (.+)$",
+			"captures": {
+				"1": {
+					"name": "string.unquoted.change.factorio-changelog"
+				}
+			}
+		},
+		{
+			"match": "^      (.+)$",
+			"captures": {
+				"1": {
+					"name": "string.unquoted.change.continue.factorio-changelog"
+				}
+			}
+		},
+		{
+			"name": "invalid.unknown.factorio-changelog",
+			"match": "^.*$"
+		}
+	],
+	"scopeName": "source.factorio-changelog"
+}

package/language/factorio-locale.json

@@ -0,0 +1,131 @@
+{
+  "color": {
+    "prefix": ["color"],
+    "body": "[color=${1:red}]$0[/color]"
+  },
+  "font": {
+    "prefix": ["font"],
+    "body": "[font=${1:default-bold}]$0[/font]"
+  },
+
+  "img": {
+    "prefix": ["img"],
+    "body": "[img=${1:item/iron-plate}]"
+  },
+  "item": {
+    "prefix": ["item"],
+    "body": "[item=${1:iron-plate}]"
+  },
+  "item-group": {
+    "prefix": ["item-group"],
+    "body": "[item-group=${1:combat}]"
+  },
+  "special-item": {
+    "prefix": ["special-item"],
+    "body": "[special-item=${1|blueprint_string,__1__|}]"
+  },
+  "entity": {
+    "prefix": ["entity"],
+    "body": "[entity=${1:iron-chest}]"
+  },
+  "technology": {
+    "prefix": ["technology"],
+    "body": "[technology=${1:logistics}]"
+  },
+  "recipe": {
+    "prefix": ["recipe"],
+    "body": "[recipe=${1:basic-oil-processing}]"
+  },
+  "fluid": {
+    "prefix": ["fluid"],
+    "body": "[fluid=${1:water}]"
+  },
+  "tile": {
+    "prefix": ["tile"],
+    "body": "[tile=${1:grass-1}]"
+  },
+  "virtual-signal": {
+    "prefix": ["virtual-signal"],
+    "body": "[virtual-signal=${1:signal-A}]"
+  },
+  "achievement": {
+    "prefix": ["achievement"],
+    "body": "[achievement=${1:minions}]"
+  },
+  "gps": {
+    "prefix": ["gps"],
+    "body": "[gps=${1:0,0}]"
+  },
+  "armor": {
+    "prefix": ["armor"],
+    "body": "[armor=${1|player,__1__|}]"
+  },
+  "train": {
+    "prefix": ["train"],
+    "body": "[train=${1|42,__1__|}]"
+  },
+  "train-stop": {
+    "prefix": ["train-stop"],
+    "body": "[train-stop=${1:|42,__1__|}]"
+  },
+
+  "param": {
+    "prefix": ["__1__"],
+    "body": "__${1:1}__"
+  },
+
+  "plural_for_param": {
+    "prefix": ["plural","__plural_for_parameter"],
+    "body": "__plural_for_parameter_${1:1}_{$0}__"
+  },
+
+  "rest": {
+    "prefix": ["rest"],
+    "body": "rest=$0|"
+  },
+  "ends in": {
+    "prefix": ["ends in"],
+    "body": "ends in ${1:1}=$0|"
+  },
+
+  "CONTROL": {
+    "prefix": ["__CONTROL__", "CONTROL"],
+    "body": "__CONTROL__${1:build}__"
+  },
+  "CONTROL_MODIFIER": {
+    "prefix": ["__CONTROL_MODIFIER__", "CONTROL_MODIFIER"],
+    "body": "__CONTROL_MODIFIER__${1:build}__"
+  },
+  "CONTROL_MOVE": {
+    "prefix": ["__CONTROL_MOVE__", "CONTROL_MOVE"],
+    "body": "__CONTROL_MOVE__"
+  },
+  "ENTITY": {
+    "prefix": ["__ENTITY__", "ENTITY"],
+    "body": "__ENTITY__${1:iron-chest}__"
+  },
+  "ITEM": {
+    "prefix": ["__ITEM__", "ITEM"],
+    "body": "__ITEM__${1:iron-plate}__"
+  },
+  "TILE": {
+    "prefix": ["__TILE__", "TILE"],
+    "body": "__TILE__${1:grass-1}__"
+  },
+  "FLUID": {
+    "prefix": ["__FLUID__", "FLUID"],
+    "body": "__FLUID__${1:water}__"
+  },
+  "ALT_CONTROL": {
+    "prefix": ["__ALT_CONTROL__", "ALT_CONTROL"],
+    "body": "__ALT_CONTROL__${1:1}__${2:build}__"
+  },
+  "CONTROL_STYLE": {
+    "prefix": ["__CONTROL_STYLE__", "CONTROL_STYLE"],
+    "body": "__CONTROL_STYLE_${1|BEGIN,END|}__"
+  },
+  "REMARK_COLOR": {
+    "prefix": ["__REMARK_COLOR__", "REMARK_COLOR"],
+    "body": "__REMARK_COLOR_${1|BEGIN,END|}__"
+  }
+}

package/language/factorio-locale.language-configuration.json

@@ -0,0 +1,15 @@
+{
+    "comments": {
+        "lineComment": "#"
+    },
+    // symbols used as brackets
+    "brackets": [],
+    // symbols that are auto closed when typing
+    "autoClosingPairs": [
+        { "open": "[", "close": "]", "notIn": ["string"] }
+    ],
+    // symbols that that can be used to surround a selection
+    "surroundingPairs": [
+        ["[", "]"]
+    ]
+}