Skip to content
This repository has been archived by the owner on Jul 28, 2018. It is now read-only.

Startup

Christian Haas edited this page Jun 9, 2018 · 4 revisions

Startup

The shocked-client application is an OpenGL based application and requires an OpenGL 3.2 compatible system.

Parameters

The application is started with parameters. So, either run it from the command-line (a shell), or create a shortcut with the corresponding parameters.

Path to resources

The required parameter is --path, which requires one argument, and can be repeated several times. This parameter specifies where the .res files are located. For uses of the vanilla CD-ROM release, this parameter would be specified twice: Once for the CD-ROM data directory, and once for the HD (installation) directory. For modern releases, this parameter may be required only once, as modern releases have all the required files in one directory.

For example, if a modern release is installed under D:\games\System Shock, and the .res files are in the subfolder data, then the application should be started with

shocked-client --path "D:\games\System Shock\data"

Automatic saving

If during the runtime of the editor a resource files is changed, its changes are saved to disk after an idle timeout. This idle timeout is 5 seconds by default and can be changed by specifying the parameter --autosave. Its argument is the new timeout, in seconds, of a range from 1 to 1800 (half an hour).

You can also force saving of changes by pressing Ctrl+S at any time in the editor.

Saving is an asynchronous operation. Please wait a few seconds after a save operation was started, before closing the editor. You might lose data otherwise.

UI scaling

The UI defaults to a scale that is suitable for a "regular" display, such as ones with a vertical resolution of 1080 pixels. Since over time displays with a high pixel density (such as "4K" displays) will become regular, the UI would become too small to be readable.

To scale the UI accordingly, specify the parameter --scale with an argument such as 2.0. This parameter takes arguments in the range from 0.5 to 10.0.

Mouse scrolling

In early versions of the GUI editor, the mouse wheel scrolled slider and texture-selection controls "inverted". Since v.1.2.0, scrolling "up" lets the slider and the texture gallery go to the right. If you still want the old behaviour, specify the startup parameter --invertedSliderScroll.

Window & Output

The editor opens a window, which can be resized, within which all actions are performed. Should the application be started from the console, this is where any internal output might show up - including errors.

Should the application crash, these errors may be useful in tracking down any issues.