Omsipfad - Create folder structure for the upload

The Omsipfad tool is a mini programme that was relaunched by Lµkas as part of the Advent Calendar 2020. This programme is able to copy files while maintaining the OMSI folder structure. Therefore it is suitable for packing a download for the filebase and creating backups.

The basic function of the tool is to add files from the OMSI main directory after entering a destination folder and another (optional) project name, which are then copied in such a way that the folder structure is preserved.

1. Preparation

This tutorial requires both the download of the Omsipfad tool and the installation of a suitable packing programme. The author of this tutorial recommends the free programme 7-zip.

The tool can be installed in any folder, but write access is required to save the settings. The C:\Program Files folder is therefore not suitable.

1.1. Introduction to the user interface

Let us first familiarise ourselves with the interface of the tool. After starting the tool, you will see the following:

1. The target directory to which the files will later be copied.
2. With this button, the target directory can be selected.
3. An optional additional project name, we will see later what usefulness this function offers.
4. Here a list with all selected files is shown. At the start of the programme this is still empty.
5. A click on this button starts the copying process.
6. Empties the list (4).
7. Removes the elements selected by checkbox from (4).
8. Displays the progress during the copying process.

2. Selecting the destination directory

First, a folder must be selected via the button (2). Ideally, this is an empty folder (the first time). Here we have chosen an empty folder that was created in the documents folder.

3. Copying files

Folders and files are now added by dragging and dropping them from the Explorer into the window.

Here in the example we add some folders and files. Folders are marked with an \*, for files the file extension is added.

After clicking on "OK", all files are copied. The folder structure in the target directory is now as follows:

Omsipath Output 
└── OMSI 2
    ├── Fonts
    │   ├── EVAG Haltestelle by Rumpelhans
    │   │   ├── Displayfont_alpha.bmp
    │   │   ├── Haltestellenfont_alpha.bmp
    │   │   ├── Haltestellenfont_schwarz.bmp
    │   │   └── Haltestellenfont_weiss.bmp
    │   ├── EVAG Haltestelle by Rumpelhans DFI.oft
    │   ├── EVAG Haltestelle by Rumpelhans schwarz.oft
    │   └── EVAG Haltestelle by Rumpelhans weiss.oft
    ├── Sceneryobjects
    │   └── Rumpelhans
    │       ├── DFI ...
    │       ├── EVAG_Haltestelle ...
    │       ├── Projekt BENS ...
    │       └── Verkehrszeichen ...
    ├── Splines
    │   └── Rumpelhans
    │       └── Projekt BENS ...
    └── Texture
        └── BENS ...

4. Packing the archive

Using the Windows ZIP function or the 7-zip context menu (if installed), an archive can be created directly from the context menu in Windows Explorer:

This archive corresponds to the conditions of the upload structure in the WebDisk.

For better compression, 7zip's own .7z format can also be used. The compression algorithm and the compression level can also be selected via the "Add to archive" dialogue.

5. Advanced functions

5.1. Project name

When entering an optional project name, an additional subfolder is created. Here is an example of two different projects:

Omsipath Output 
├── My Project 1
│   └── OMSI 2 ...
└── My Project 2
    └── OMSI 2 ...

Again, when packing the project folder (not the parent target directory!), an archive is created that complies with the folder structure conditions:

The tool remembers existing project folders so that they can be easily selected for an update or similar:

5.2. Replace files (not)

If there are already OMSI files in the selected folder, the tool asks for the replacement procedure:

1. Standard - Before copying, the folder is deleted so that it is started "fresh". All files are copied, so to speak, overwritten and existing files that have not been changed because they are not included in the copied files are removed.
2. All files are copied and overwritten, but in contrast to (1), no files are deleted that were there before. It could therefore be that the target directory after the copying process contains so-called "dirty" files that do not belong to the last copying process.
   Example: Adding certain files while keeping old files. Helpful if only individual files are to be updated / added without touching existing files.
3. Only files that were already present before are replaced. New files are not added.
   Example: Only existing files are to be patched.
4. Only new files are added to the folder.
   Example: Helpful to save time during the copying process if content has been forgotten and only a specific folder is to be inserted.