Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 3.91 KB

README.md

File metadata and controls

68 lines (45 loc) · 3.91 KB
Raw

Factorio Data Wrapper

Takes data from Factorio's Lua files and outputs it in a desired format or makes it accessible to other Java programs.

Currently mainly developed for Factorio Wiki Scripts and used by Factorio Blueprint String Renderer (aka Blueprint Bot) as a dependency.

Mod support is Work in Progress, it's tracked in Issue #37.

Installation and execution of the FactorioWikiMain app with Eclipse

Install Eclipse for Java Developers.

Clone this Java Factorio Data Wrapper repository via git. Commandline example: git clone [email protected]:demodude4u/Java-Factorio-Data-Wrapper.git

In Eclipse, open the directory you cloned the repo into: File -> Open Projects from File System... -> Directory... -> Open the directory -> Choose the FactorioDataWrapper directory -> Finish.

You may need to click "Workbench" or "Hide" in the top right of the "Welcome to Eclipse" page so see the GUI elements mentioned next.

In the "Project Explorer" window, expand FactorioDataWrapper, copy config.template.json, rename it to config.json and if needed adjust "factorio" to point to your Factorio install. It must point to the root Factorio directory which contains the data directory.

In the "Project Explorer" window, expand FactorioDataWrapper, expand src, expand com.factorio.demod.apps -> Right-click on FactorioWikiMain.java -> Run As -> Java Application.

The "Console" shows possible errors. If there are no errors, the output can be found in "FactorioDataWrapper/output/", the directory is opened automatically when the data wrapper finishes executing succesfully.

Help, it's missing dependencies

The project is missing dependencies if it shows hundreds of errors and running it fails with this console message:

Error: Unable to initialize main class com.demod.factorio.apps.FactorioWikiMain
Caused by: java.lang.NoClassDefFoundError: JSONException

These should be set up by Maven, Eclipse for Java Developers should come with an integration for it by default. Check if the integration is installed: In Eclipse, open Help -> About Eclipse Platform/IDE -> Installation Details -> Installed Software. Check if "m2e Maven integration for Eclipse" is in the list.

If it is not in the list, install it:
In eclipse -> Help -> Install New Software... -> Work with: --All Available Sites-- -> Search for maven -> Check the checkbox next to "m2e Maven integration for Eclipse" under General Purpose Tools -> Next > -> Next > -> Accept the license -> Finish -> Restart the application when it prompts for it.

Config file

The value for "factorio" must point a Factorio install. It must point to the root Factorio directory which contains the data directory.

The value for "mod-exclude" can be empty. If it is filled with an array of mod names, mods by that name that are found in data or in the mods directory are ignored by the data wrapper and not loaded. By default, this exclude list is empty.

The value for "output" can be empty. If it is filled with a string, this is used as the directory name for the output directory of FactorioWikiMain. It is set to "output" by default.

Example

{
  "factorio": "C:\\Program Files (x86)\\Steam\\steamapps\\common\\Factorio",
  "mod-exclude": [
    "combat-tester",
    "test-maker",
    "trailer",
    "extreme-gui",
    "trailer-launch",
    "trailer-switch",
    "GIF_Tool"
  ]
}

Mods directory

The mods directory must be placed in the FactorioDataWrapper directory. Mods inside it are loaded by the data wrapper.