Factorio Mod Maker: Difference between revisions

From AdamProjects
No edit summary
No edit summary
 
(18 intermediate revisions by one other user not shown)
Line 1: Line 1:
Note: This is currently being rewritten in [https://www.rust-lang.org Rust] using [https://slint.dev Slint].
== Info ==
== Info ==
The Factorio Mod Maker is an in-development app written in python to make it easy for creating mods for [https://wiki.factorio.com/ Factorio]. It is currently unavailable to anyone else. I soon plan to put it on my [https://github.com/adamalbu GitHub].
The Factorio Mod Maker is an in-development app inspired by [https://mcreator.net/ MCreator] written in the [[wikipedia:Python_(programming_language)|Python]] programming language to make it easy for creating mods for [https://wiki.factorio.com/ Factorio]. It is currently unavailable, but will soon be released on [https://github.com/adamalbu GitHub].


== Setup ==
== Setup ==
When you first open the app, you will see a window with a button on the bottom with the text ''"Setup"''.[[File:Factorio Mod Maker Main Window Setup.png|left|thumb|The main window when you first open the Factorio Mod Maker]]
[[File:Factorio Mod Maker Main Window Setup.png|left|The main window when you first open Factorio Mod Maker|thumb]]
[[Category:Ongoing]]
When you first open the app, you will see a window with a button on the bottom with the text ''"Setup"''.[[File:FMM new mod dialog with some fields filled in valid.png|thumb|The new mod dialog where all the fields are filled in]]After you press the button, a dialog will show prompting you to put in the location of  where Factorio stores its data (usually at <code>%AppData%/Factorio</code> or <code>C:/Users/''[Your Username]''/AppData/Roaming/Factorio</code>) and where the exe is located (usually at <code>C:/Program Files/Factorio/bin/x64/Factorio.exe</code>).
Once both paths are put in, the text below each textbox should turn green and say that the location is valid. If they are both valid, click the OK button.
[[File:FMM setup dialog valid fields.png|thumb|The setup dialog when all the paths are valid|left]]
Now the button at the button of the window should say ''"New Project"''. Press that button and a new dialog should open. Alternatively, you can press the ''"File"'' button in the menu bar and select ''"New"'' or press <code>Ctrl + N</code>  To create the project, fill in the required fields (marked by a *). The ''Name'' field can only contain alphanumeric characters, dashes and underscores because of how Factorio's mod portal handles mod names. You can also fill in the optional fields to give more info. More detail on these fields and the file it generates can be found [https://wiki.factorio.com/Tutorial:Mod_structure#info.json here]. Once the fields have been filled in, click the OK button.
 
== Tips ==
 
=== Navigating the GUI ===
* You can hold <code>Alt</code> and press the underlined letter to quickly jump to the textbox or press the button.[[File:FMM main window menu bar file options shown.png|thumb|The shortcut <code>Ctrl + N</code> is shown next to the ''"New"'' menu item]]
** If you can't see the underlined letters, press <code>Alt</code> once.
** Example: pressing <code>Alt + N</code> on the main window will press the ''"New Project"'' button.
** Example: pressing <code>Alt + T</code> on the new mod dialog will quickly jump to the "''Title"'' textbox.
* Shortcuts are displayed next to menu items. Pressing that shortcut press that menu item, even when the menu item is not currently shown in the window.
** Example: pressing <code>Ctrl + N</code> will create a new project.
* You can press <code>Tab</code> (⭾) to quickly jump to the next textbox.
** Example: pressing <code>Tab</code> when in the first box of the version field, it will automatically focus on the second box of the version field.
 
[[Category:Factorio Mod Maker]]

Latest revision as of 10:29, 18 September 2024

Note: This is currently being rewritten in Rust using Slint.

Info[edit | edit source]

The Factorio Mod Maker is an in-development app inspired by MCreator written in the Python programming language to make it easy for creating mods for Factorio. It is currently unavailable, but will soon be released on GitHub.

Setup[edit | edit source]

The main window when you first open Factorio Mod Maker

When you first open the app, you will see a window with a button on the bottom with the text "Setup".

The new mod dialog where all the fields are filled in

After you press the button, a dialog will show prompting you to put in the location of where Factorio stores its data (usually at %AppData%/Factorio or C:/Users/[Your Username]/AppData/Roaming/Factorio) and where the exe is located (usually at C:/Program Files/Factorio/bin/x64/Factorio.exe).

Once both paths are put in, the text below each textbox should turn green and say that the location is valid. If they are both valid, click the OK button.

The setup dialog when all the paths are valid

Now the button at the button of the window should say "New Project". Press that button and a new dialog should open. Alternatively, you can press the "File" button in the menu bar and select "New" or press Ctrl + N To create the project, fill in the required fields (marked by a *). The Name field can only contain alphanumeric characters, dashes and underscores because of how Factorio's mod portal handles mod names. You can also fill in the optional fields to give more info. More detail on these fields and the file it generates can be found here. Once the fields have been filled in, click the OK button.

Tips[edit | edit source]

Navigating the GUI[edit | edit source]

  • You can hold Alt and press the underlined letter to quickly jump to the textbox or press the button.
    The shortcut Ctrl + N is shown next to the "New" menu item
    • If you can't see the underlined letters, press Alt once.
    • Example: pressing Alt + N on the main window will press the "New Project" button.
    • Example: pressing Alt + T on the new mod dialog will quickly jump to the "Title" textbox.
  • Shortcuts are displayed next to menu items. Pressing that shortcut press that menu item, even when the menu item is not currently shown in the window.
    • Example: pressing Ctrl + N will create a new project.
  • You can press Tab (⭾) to quickly jump to the next textbox.
    • Example: pressing Tab when in the first box of the version field, it will automatically focus on the second box of the version field.