ClaudeMetz · Master-Killer · Oct 22, 2024 · Oct 22, 2024 · Oct 22, 2024 · Oct 27, 2024
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: therenas
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,30 @@
+name: Bug report
+description: Encounter any crash or other issue? I'd like to fix that.
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        *Before filing a bug, please check if it wasn't already reported previously.*
+  - type: textarea
+    attributes:
+      label: Problem Description
+      description: |
+        What went wrong? What did you expect to happen?
+        Please include any context you can, like the crash message, screenshots, or relevant mods.
+      placeholder: I tried to start a new game, but the game crashed.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        **Including the `factorio-current.log` file and a copy of your save is very helpful.**
+        They can be dropped right into the above textfield, if below 25MB in size.
+        Alternatively, you can upload them [here](https://drive.google.com/drive/folders/1JZErOFq7ibpk09dSeMV5BwPmG6xzhQNu?usp=sharing) with a descriptive name.
+  - type: textarea
+    attributes:
+      label: Reproduction
+      description: Let me know the exact steps you took to get the crash to happen, if possible.
+      placeholder: |
+        1. Start a new game
+        2. Crash happens!
diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml
@@ -0,0 +1,14 @@
+name: Improvement or feature suggestion
+description: Have an idea for how to improve the mod? Let me know!
+labels: ["improvement"]
+body:
+  - type: textarea
+    attributes:
+      label: Suggestion
+      description: What's your idea for something to improve on? What problem of yours does it solve?
+      placeholder: I'd like the mod to be able to read my mind.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: I appreciate any and all suggestions, but be aware that it might take me quite a while to get to them.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+.DS_Store
+.vscode
+modfiles/scenarios
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,6 @@
+[submodule "scripts"]
+	path = scripts
+	url = https://github.com/ClaudeMetz/FactorioScripts
+[submodule "locale"]
+	path = locale
+	url = https://github.com/ClaudeMetz/FactoryPlannerLocale
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Claude Metz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,3 +1,21 @@
 # Factory Planner
 
-[Placeholder]
+Factory Planner is a mod for the game [Factorio](https://www.factorio.com). It is published in zip-format on the Factorio [mod portal](https://mods.factorio.com/mod/factoryplanner), which allows it to be downloaded and updated by players in-game.
+
+It enables players to plan out their production in detail, specifying the recipes, machines and modules to use. It allows for conceptual separation of assembly lines through the use of separate floors that can be nested infinitely. There exist calculators on the web that can do this already, but a big advantage a mod has is that it can incorporate the exact combination of mods the user has installed, with up-to-date information, which is something that external solutions struggle to provide.
+
+My focus when creating the interface for this mod was on making it as clear and intuitive as possible while offering all the features that power users need. To that end, users should be able to get started on their first plans relatively easily, after which they can gradually explore all the functionality that is offered. The interface was created with all the modern design standards and interaction paradigms in mind, making it conform well to both user's expectations and the rest of the game.
+
+There is a public [project board](https://github.com/users/ClaudeMetz/projects/1) organizing what's on my radar. Suggestions and bug reports are centralized here on Github. Feel free to join the Factory Planner [Discord](https://discord.gg/ABqNEQc) to talk to me and others in a more casual way.
+
+## Contribute
+
+If you want to contribute to Factory Planner, please join the [Discord](https://discord.gg/ABqNEQc) and talk to me about what you have in mind first. I'm happy to hear about any ideas you have, but this mod is still in active development and I might already have a plan for what you're thinking about. You can of course also open an issue to talk about your ideas.
+
+### Localisation
+
+Localisation of Factory Planner is handled entirely through a [separate project](https://github.com/ClaudeMetz/FactoryPlannerLocale) on Github. If you're interested in helping out, feel free take a look. There are further explanations on the project's page. If you have any technical questions, please open an issue on that repo.
+
+## License
+
+This mod is licensed under [MIT](https://en.wikipedia.org/wiki/Public_domain), with the exception of the localisation, which is in the [public domain](https://github.com/ClaudeMetz/FactoryPlannerLocale?tab=Unlicense-1-ov-file).
diff --git a/TODO.txt b/TODO.txt
diff --git a/control.lua b/control.lua
diff --git a/data.lua b/data.lua
diff --git a/data/init.lua b/data/init.lua
diff --git a/data/subfactory.lua b/data/subfactory.lua
diff --git a/info.json b/info.json
diff --git a/locale b/locale
diff --git a/locale/en/config.cfg b/locale/en/config.cfg