UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
Content Creation
Materials
Unigine Material Library
Tutorials

FileClient Plugin

The FileClient plugin allows for extremely easy development on a remote machine or a mobile device. It accesses resources on the remote server (run via with FileServer tool) as if they were stored on a local disk, under data directory.

With this plugin, there is no need to reupload data to the server or a mobile device each time changes are made, and iterative development and testing is fast and convenient.

How to Use FileClient

FileClient is used together with FileServer tool. To access data directory with all application resources on the remote host, perform the following:

  1. Run FileServer console tool from a folder with the data directory to be used.
    Type the following in the command-line console to run the server on the default port 8889 (or see other available options):
    Shell commands
    fileserver_x86
    
  2. Copy application files without the data folder (binary executables, libraries, launchers) onto a remote machine or a mobile device.
    Notice
    If there are unpacked data files present in the application folder with run binaries, they will be used instead of remote resources as they have higher priority.
  3. To access to directories outside the data folder via FileClient plugin, specify the following additional command line option when running the application.
    Shell commands
    -extern_plugin FileClient
    
    • The path to the FileClient plugin is specified relative to the run binary executable or as an absolute path.
    • The same default port will be used as in case of FileServer (8889).
    • Connection will be established to the remote server with localhost name.

Options

  • -file_host HOSTNAME — the name of the remote host to connect to. The default is localhost.
  • -p PORT — port number to connect to. The default is 8889.

For example, if the FileClient library and the binary are stored in different folders, use the following start-up options to run the application:

Shell commands
-extern_plugin ../lib/FileClient -file_host hostname -file_port 4567
Last update: 2017-07-03