Skip to content

Open-Industry-Project/Open-Industry-Project

Repository files navigation

OpenIndustryProject

Free and Open-source warehouse/manufacturing simulator made with Godot, JoltPhysics, OPC UA .NET, and libplctag.

The goal is to provide an open platform for developers to contribute to the creation of virtual industrial equipment/devices and for people to be able to test their ideas or simply educate themselves while using standard industrial platforms.

Scroll down to the Getting Started section for information on how to work with this project.

Join our discord group: Open Industry Project

Supported Communication Protocols:

  • OPC UA
  • Ethernet/IP via libplctag
  • Modbus TCP via libplctag

Demo

This demo is located at: Demos

demo.mp4

Out of the Box Features

Dynamic Devices

2024-03-24.08-41-58.mp4

Customizable Equipment

2024-03-24.08-45-52.mp4

Getting Started

Requirements: https://dotnet.microsoft.com/en-us/download

.NET SDK is required for this project for the compilation of C# code

It is highly recommended to download the latest package here: https://github.com/Open-Industry-Project/Open-Industry-Project/releases

It comes with a fork that contains functions and features that are not avaliable in regular Godot.

The contents of this repo are parts of a regular Godot project. You will import (importing will break the project at the moment due to issues with current versions of Godot) open this project via the Godot project manager, just like any other Godot project.

If you are familiar with Godot and you open this project, you will notice that some things look different. This is intentional. This project is meant to be entirely contained with in the editor.

At the moment there is no reason to "run" this project as if it were a game like you normally would for development done in Godot. The editor viewport(s) are where all simulations will take place.

Use the Project Manager to create a new project.

image

All objects used in a simulation scene will be in the Parts tab.

image

All scenes where simulations will take place require a Main node. A scene that inherients one is automatically created for new projects, but the easiest way to setup a new one is by creating adding a new scene, and selecting "New Simulation".

image

image

The Main node can be selected in Scene tab.

image

This will expose it's properties in the Inspector tab. This is where communications will be setup. (This step can be skipped if no external platform will be used)

image

Parts can be dragged into the viewport to instantiate it. Once they're in the scene they can be modified.

2024-04-06.11-00-38.mp4

Most parts have properties that can be setup to communicate to a PLC or OPC Server. In this example Ignition was used as an OPC server to write to the conveyor tag.

2024-04-06.11-44-14.mp4

Importing Models

Although this project has a few models, you maybe interested in adding more.

This is a good resource for free industrial parts CAD models: 3dfindit

It is recommened to export the files in their native format (usually STEP), modify them if needed for usage in Godot in any CAD software and then export as FBX for additional work in Blender, or to be imported straight into Godot.

Alternatively most manufacturers provide the CAD files directly on their own website.

Help Wanted

  • More equipment and devices
  • Better exception handling
  • Review code
  • Documentation
  • Training videos?