Factory Automation Game

Factory Automation is an open-source logic game about building factory production lines and creating an automation system for them.

The game is inspired by titles such as Shapez.io, Automachef and Infinifactory. However, it puts more emphasis on creating a system to manage our production line. Factory Automation offers, made available as part of the gameplay progression, dedicated control blocks to create advanced control systems using:

• electronic components
• programmable computers:
  • using of existing control programs from GNU/Linux operating system command line
  • creating of programs in C and Pythons
  • networking multiple computer blocks with TCP/IP

The game offers full simulation of electronic circuits (based on ngspice) and computer systems (based on QEMU and GNU/Linux). In-game manual (about basics of electronics and programming) is available. Saving the game state, customizing keys and other settings is supported.

Project Status: Alpha-3

• All core gameplay features (like circuit simulation, computer simulation, 3d factory) are in place and works.
• There are only 3 sample tasks (levels) and a demo level available, but they do not reflect the target task layout.
• In-game manual (especially English version) requires verification.
• It's works, but may be bugged or have missing minor features.

Build Instruction (on Linux platform)

1. use git submodule update --init to download addons dependencies

2. build GodotXterm addon

   a. use addons/godot_xterm/native/build.sh b. (for Windows export option) use scons build_library=no platform=windows arch=x86_64 in addons/godot_xterm/native/

3. build GdSpice

   a. run scons in ElectronicsSimulator/GdSpice/ b. (for Windows export option) use scons platform=windows arch=x86_64 in ElectronicsSimulator/GdSpice/

4. build or download binary release of GDCEF

   a. binary files should be placed in addons/3rdparty/gdcef/build/Linux and (for Windows export option) in addons/3rdparty/gdcef/build/Windows b. GDCEF should be build with cef_artifacts as binary / artifact directory

5. build game manual by running scons in Manual/

6. open project.godot in Godot 4.3 (or higher), ignore errors and close editor after import is complete

7. open project.godot in Godot editor again (there should be no errors)

8. run project

You can also export project for Linux and Windows platform using ./export.sh script (do not directly use export option in editor). Use ./export.sh to export amd64 Linux version or ./export.sh Windows to export amd64 Windows version. Results will be written to tmp/export/.

License

• Project use per file REUSE/SPDX type copyright info.
  • For SVG files, gdscript files, C++ sources, sh and Python scripts copyright and licence info is inside file, in comments at begin of file.
  • For Godot resources, scenes and binary files copyright and licence info is in .licence file.
• Main licence for this project is MIT
• Some files (code borrowed from other projects, media and resources files - like images and fonts, etc) are distributed under other licence term – check REUSE header or .licence file for licence and copyright holder info. Full text of all used licenses is included in LICENSES directory.
• All used elements (including full supply chain) are available under DFSG-compatible licenses.

Binary redistribution license information

• In addition to the above, the full binary version contains or depends on numerous other builtin or linked libraries and other resources
• Main dependencies:
  • Godot – MIT licence AND some other licenses (see https://github.com/godotengine/godot/blob/master/COPYRIGHT.txt)
  • GodotXterm – MIT licence AND some other licenses (see https://github.com/lihop/godot-xterm/blob/main/addons/godot_xterm/THIRDPARTY_NOTICES.txt)
  • easy charts – MIT licence
  • GDCEF – MIT licence
    • CEF – BSD-3-Clause AND some other licenses from Chromium Project (see about:credits and https://metadata.ftp-master.debian.org/changelogs/main/c/chromium/stable_copyright)
  • ngspice – BSD-3-Clause AND some other licenses (https://metadata.ftp-master.debian.org/changelogs/main/n/ngspice/stable_copyright)
  • qemu – GPL-2.0 AND some other licenses compatible licences (see https://gitlab.com/qemu-project/qemu/-/blob/master/LICENSE and https://metadata.ftp-master.debian.org/changelogs/main/q/qemu/stable_copyright)
    • Linux kernel – GPL-2.0 WITH Linux-syscall-note
    • system disk image – multiple DFSG-compatible (see copyright info inside image → /usr/share/doc/*/copyright)

Technical background

Game is created in Godot Engine.

To simulate electronic circuit, the game uses:

• ngspice
• easy charts for showing oscilloscope graphs

To simulate computer systems, the game uses:

• QEMU
• Debian for creating operating system images, this includes but is not limited to:
  • bash
  • Python
  • Tiny C Compiler
  • tmux
  • BusyBox
  • zsh
  • Linux Kernel
  • GNU Coreutils
  • Clang compilers
  • GCC compilers
• godot-xterm for terminal support in Godot

Main Scripts Dependencies And Functions

Similar open source projects

There are several FOSS projects with similar topics (games about factory build, digital logic simulation, etc), but each of them focuses on (and expands on) a certain subset of the topic covered by Factory Automation Game (FAG). However, they can be an inspiration for FAG developers as well as a source of further entertainment for players, which is why we are posting links to them here:

• Digital-Logic-Sim (CC-BY-NC-SA-4.0, before "Version 1.0" (118f52e0) MIT licence) (Unity) and Digital Logic Sim 2 (GPL3) (Unity)
• Logic Circuit Simulator (GPL3) (Godot)
• OpenIndustryProject (GPL3) (Godot)
• shapez (Community Edition) (GPL3) (custom engine)