Project structure

A project may consist of various parts, e.g., files, source code, a scene (2D, 3D, or other), resource objects like data sets, 3D materials or the like.

A project requires three files to be openable in GroIMP:

Project registry (GS)

The registry graph is used by GroIMP as registry for platform elements. Each project get its own registry that is a children of the Main registry. For the project, the registry stores how different resources are linked to the way GroIMP loads them — including which Java classes are used and with which parameters.

→ Read more...

When serialized, the registry is stored in a XML file. With the extension .gs.

→ Read more...

Project graph

The project graph contains all primary graphs of the project. Note that despite being called graph, they are more sub-graph of the project graph. It is possible to visualize each graph with the 2D graph display. Each project has one and only one project graph. The graphs presented bellow all belongs to the project graph and have different root. Thus, they are not connected together. As they still belongs to the same project graph, it is possible to create edges between them (but highly discouraged).

→ Read more...

Java resources file

The third required file to open a project. It follow the same definition as the java manifest file.

It cannot be renamed or moved. It needs to be META-INF/MANIFEST.MF.

This is a simple text file that lists the files used in the project including the project registry and graph file.

→ Read more...


Note that:

  1. the project registry and the graph can be renamed as long as their references are also renamed.
  2. The project can be compressed into a .gsz file. In that case, the three files (and all other resources) are contained in the .gsz file.