https://github.com/adepierre/ficsit-companion
Node-based production planner for the game Satisfactory
https://github.com/adepierre/ficsit-companion
cpp imgui satisfactory
Last synced: about 2 months ago
JSON representation
Node-based production planner for the game Satisfactory
- Host: GitHub
- URL: https://github.com/adepierre/ficsit-companion
- Owner: adepierre
- License: mit
- Created: 2024-08-20T16:12:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-04T20:26:29.000Z (11 months ago)
- Last Synced: 2025-05-04T21:25:33.539Z (11 months ago)
- Topics: cpp, imgui, satisfactory
- Language: C++
- Homepage: https://adepierre.github.io/ficsit-companion
- Size: 2.63 MB
- Stars: 42
- Watchers: 3
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Ficsit Companion
A node-based Satisfactory production planner
Ficsit Companion is a node based production planner for Satisfactory. You can use the online version [here](https://adepierre.github.io/ficsit-companion/) or download a standalone desktop version from the [release page](https://github.com/adepierre/ficsit-companion/releases/latest).
## Plans and ideas
This is a partial list of what *could* eventually be integrated into Ficsit Companion in the future. Please keep in mind that it is mostly developed by one person on free time (and my factory also needs to grow), so there is no timeline and some features may end up never being implemented.
UI/UX improvements
Usually, I tend to favor functionnality before look (please don't judge my shoebox factories). As a consequence the UI and web version are currently not very pretty and lots of thing could be improved visually for a better experience.
Pin reordering
Inside a node, in/out pins order is irrelevant. However, being able to reorder them could be helpful to get cleaner layouts with less link crossing overall. Currently a partial solution is implemented: pins are automatically sorted based on the position of the linked node (if any).
Color modifiers
Adding the ability to change colors for links/nodes would definitely help having better organized graphs.
Automatic tests
This is more a developper thing, but adding automatic tests using the [ImGui Test Engine](https://github.com/ocornut/imgui_test_engine) would be very helpful to speed up development and debugging, avoid regressions etc...
In-game integration
I don't know much about Satisfactory mods, but as this is a C++ project using ImGui, I think it may be possible to have it integrated directly in game as a mod/part of a mod. At the moment this is just an idea though, and it would probably require a lot of tweaking to have it working.
Node placing/sorting
Having a button to automatically sort/place all the nodes on screen to minimize link crossing would be very useful. Not sure how to implement it properly yet though.
Automatic planning
I'm not a fan of fully automatic tools that can generate full optimized production chains, as I think they take away part of the fun of the planning phase. That being said, it could still be useful to add an option to expand a pin with a full production chain. Development-wise, it may be quite hard to implement from scratch, but using a tool like lpsolve could be fairly easy, assuming it's possible to translate Satisfactory constraints into the chosen solver language.
Other games support
The main concept of node editor production planner is not specific to Satisfactory and could be extended to other similar games (Factorio, Dyson Sphere Program...). The only requirement would be the possibility to generate a similar recipes json file (and potentially have images for the items).
Image exporter
Currently, if you want to visualize a previously generated production chain, you need to reopen it inside Ficsit Companion. It means each node takes a lot of space with all the pins. It would be helpful to have an option to export it to a more compact format, potentially an image, where you can easily see everything at a glance. This could either be integrated directly in the app or as a side script reading from a saved file.
## Building
```bash
git clone https://github.com/adepierre/ficsit-companion.git
cd ficsit-companion
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -S .. -B .
cmake --build . --config Release
```
To build the web version locally you'll need to first install emscripten. Web version will be located inside ``build/web``
```bash
git clone https://github.com/adepierre/ficsit-companion.git
cd ficsit-companion
mkdir build
cd build
/path/to/emscripten/emsdk activate latest
emcmake cmake -DCMAKE_BUILD_TYPE=Release -S .. -B .
cmake --build . --config Release
```
## Updating
The recipes are currently up to date with version 1.0 of the game. To update to a different version, one can use the [provided script](scripts/data_extractor.py). It requires having the Docs.json file provided in the game files as well as item icons extracted from the game. For more informations about the Docs.json file you can check the official [wiki page](https://satisfactory.wiki.gg/wiki/Community_resources) and for icons extraction you can refer to [this tutorial](https://docs.ficsit.app/satisfactory-modding/latest/Development/ExtractGameFiles.html).
Using FModel, you'll have to extract at least these folders for icons:
- FactoryGame/Content/FactoryGame/Resource/Parts
- FactoryGame/Content/FactoryGame/Resource/RawResources
- FactoryGame/Content/FactoryGame/Resource/Environment/Crystal
- FactoryGame/Content/FactoryGame/Resource/Environment/AnimalParts
- FactoryGame/Content/FactoryGame/Equipment
- FactoryGame/Content/FactoryGame/Prototype/WAT (for somersloop icon)
## Credits
Thanks to the amazing ocornut and thedmd for their libraries ([Dear ImGui](https://github.com/ocornut/imgui/) and [ImGui Node Editor](https://github.com/thedmd/imgui-node-editor) respectively).
## Disclaimer
Ficsit Companion is not an official Ficsit nor Coffee Stain Studios product. All images comes from Satisfactory and are Coffee Stain Studios intellectual property.