An open API service indexing awesome lists of open source software.

https://github.com/rbcavi/factorio-viewer

An item and recipe browser for Factorio (with more possibly to come)
https://github.com/rbcavi/factorio-viewer

factorio factorio-data factorio-tool info information static-site static-website

Last synced: 12 months ago
JSON representation

An item and recipe browser for Factorio (with more possibly to come)

Awesome Lists containing this project

README

          

# factorio-viewer

A static site with a item and recipe browser for Factorio modpacks.

I have some other features planned:

* Recipe Calculator (like FactorioLab)
* Upload modpack
* Blueprint viewer/editor
* Modpack maker (for this)
* Wiki editor (MediaWiki) (original purpose for updating the Space Exploration wiki)

## Hosting
It's hosted on Github Pages at https://rbcavi.github.io/factorio-viewer/viewer.html

You can host it on your computer with a static HTML server.

`mods.json` is the configuration file. It has the following structure:
```
{
"assetlocations":{
"__default":"",
"":""
...
},
"datalocations":{
"":{
"data":"",
"locale":"",
}
...
}
}
```

The `__default` key in `assetlocations` is the default place to find mod assets. `{}` is replaced by the name of the mod to get the asset folder for that mod.

`data.json` is a JSON dump of the `data` table inside Factorio.

`locale.json` is the locale entries as JSON:
```
{
"en":{
"item-name.iron_plate":"Iron Plate",
...
}
...
}
```

`data.json`, `locale.json`, and the asset folders are generated by https://github.com/RbCaVi/get-factorio-data

## How to contribute

Look at the issues and pick one or check `TODO.md`.
Pull request/fork, not push to `main`.