Factorio Gridlines

Enhance your building layouts with a powerful and flexible grid system! Gridlines adds customizable grids to your world, allowing for precise and efficient designs across multiple layers.

[![][factorio-mod-shield]][factorio-mod-link] [![][typescripttolua-shield]][typescripttolua-link] [![][github-release-shield]][github-release-link] [![][github-releasedate-shield]][github-releasedate-link] [![][github-action-release-shield]][github-action-release-link] [![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link] [![][github-issues-shield]][github-issues-link] [![][github-license-shield]][github-license-link]

[Mod Portal][factorio-mod-link] · Changelog · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]

Trying to develop a Factorio mod using TypeScript, with the grid system inspired by the implementation of ChunkyChunks - Configurable Gridlines.

This project relies on two powerful open-source projects: TypeScriptToLua and Typed Factorio. This mod is entirely written in TypeScript, featuring complete type definitions and debugging capabilities. Additionally, the i18n generation scheme has been optimized to comply with the i18next standard.

---

✨ Features

• 🧇 Flexible Grid System: Provides three grid layers that support flexible configuration, allowing adjustments for color, size, thickness, and offset.
• 🖍️ Map and Personal Settings: Setting the grid on the map enables all online players to share the same grid system, while also allowing individual settings to override it.
• 🌐 Internationalization: Comprehensive i18n translation supporting 17 languages.
• ⌨️ Hotkeys: Supports button and F6 hotkey toggling.

---

| Map Settings | Player Settings | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | | |

---

⌨️ Local Development

You can use Github Codespaces for online development:

[![][github-codespace-shield]][github-codespace-link]

Or clone it for local development:

[![][bun-shield]][bun-link]

$ git clone https://github.com/canisminor1990/factorio-gridlines.git
$ cd factorio-gridlines
$ bun install
$ bun dev

---

🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.

[![][pr-welcome-shield]][pr-welcome-link]

[![][github-contrib-shield]][github-contrib-link]

---

🔗 Credits

• ChunkyChunks - Configurable Gridlines - <https://mods.factorio.com/mod/ChunkyChunks>
• TypescriptToLua - <https://github.com/TypeScriptToLua/TypeScriptToLua>
• Typed Factorio - <https://github.com/GlassBricks/typed-factorio>
• Factoriomod Debug - <https://www.npmjs.com/package/factoriomod-debug>

---

#### 📝 License

Copyright © 2024 [canisminor1990][profile-link]. This project is GPL-3.0 licensed.

[bun-link]: https://bun.sh [bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun&style=for-the-badge [factorio-mod-link]: https://mods.factorio.com/mod/gridlines [factorio-mod-shield]: https://img.shields.io/badge/dynamic/json?labelColor=black&color=ffa200&label=Factorio&style=flat&query=downloads_count&suffix=%20downloads&url=https%3A%2F%2Fmods.factorio.com%2Fapi%2Fmods%2Fgridlines&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyBmaWxsPSJub25lIiB2aWV3Qm94PSIwIDAgMTYgMTYiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxnIGNsaXAtcGF0aD0idXJsKCNhKSI+CjxwYXRoIGQ9Im0xNS4xMjMgNi40MTg3aC0wLjg0ODFjLTAuMTU3Ny0wLjYxNDYyLTAuNDAzOC0xLjE5MDMtMC43MjQ2LTEuNzE2OGwwLjYwOTctMC42MTExNGMwLjE2NDYtMC4xNjQ2MiAwLjI1NTEtMC4zODQyMyAwLjI1NTEtMC42MTc0MSAwLTAuMjMyODMtMC4wOTEyLTAuNDUyNzgtMC4yNTUxLTAuNjE3MDVsLTEuMDE2Mi0xLjAxNTJjLTAuMzI5Ni0wLjMyOTkzLTAuOTA1Ni0wLjMyOTU4LTEuMjMzOC0zLjVlLTRsLTAuNjM1NSAwLjYzMTY4Yy0wLjUyMDctMC4zMDM0OC0xLjA3ODktMC41MzczNi0xLjY5MzktMC42ODc3MXYtMC45MDc2NmMwLTAuNDgxMzItMC4zODQ1OC0wLjg3NzA0LTAuODY1OS0wLjg3NzA0aC0xLjQzNjdjLTAuNDgxMzMgMC0wLjg1OTk4IDAuMzk1NzEtMC44NTk5OCAwLjg3NzA0djAuOTA3MzFjLTAuNjE0NjMgMC4xNS0xLjE3NjQgMC4zODQyMy0xLjY5NzcgMC42ODgwNmwtMC42MzUxNS0wLjYzMTY4Yy0wLjMyOTI0LTAuMzI5OTMtMC45MDU1OC0wLjMyOTU4LTEuMjM1OS0zLjVlLTRsLTEuMDE1NiAxLjAxNTJjLTAuMTYyODggMC4xNjI1My0wLjI1NTggMC4zODczNi0wLjI1NTggMC42MTcwNiAwIDAuMjMyODMgMC4wOTAxNCAwLjQ1MjA5IDAuMjU1MSAwLjYxNjcxbDAuNjA5NzUgMC42MTI1M2MtMC4zMjA1MyAwLjUyNjU3LTAuNTY2OTQgMS4xMDIyLTAuNzI0MjUgMS43MTY4aC0wLjg0ODVjLTAuNDgxNjcgMC0wLjg3MDQyIDAuMzg3MDEtMC44NzA0MiAwLjg2NzN2MS40MzU2YzAgMC40ODE2NyAwLjM4ODc1IDAuODU5OTggMC44NzA0MiAwLjg1OTk4aDAuODQ4NWMwLjE1NzMxIDAuNjE0NTggMC40MDMzNyAxLjE5MzggMC43MjM1NiAxLjcyMDNsLTAuNjA5NzUgMC42MTM2Yy0wLjE2NDk3IDAuMTY0Ni0wLjI1NTQ2IDAuMzg0OS0wLjI1NTQ2IDAuNjE4MXMwLjA5MDg0IDAuNDUzNSAwLjI1NTQ2IDAuNjE4MWwxLjAxNjIgMS4wMTU5YzAuMTY0OTYgMC4xNjQ2IDAuMzgzODcgMC4yNTUxIDAuNjE2NzEgMC4yNTUxIDAuMjMyODMgMCAwLjQ1MjA5LTAuMDkwOCAwLjYxNzA1LTAuMjU1MWwwLjYzNzk0LTAuNjMyYzAuNTIxMzUgMC4zMDM4IDEuMDgzMSAwLjUzNzcgMS42OTc3IDAuNjg4NHYwLjkwNjNjMCAwLjQ4MTMgMC4zNzg2NSAwLjg2OTQgMC44NTk5OC