Skip to content

command_line_export.md

Latest commit

 

History

History
42 lines (29 loc) · 1.84 KB

command_line_export.md

File metadata and controls

42 lines (29 loc) · 1.84 KB

Command-line Export of Plugin

This document outlines how to export the plugin from source using a command line interface. This may be helpful if you have a CI/CD pipeline for your game, and want it to always incorporate whatever version of the plugin you have locally.

BuildPackage

The following command generates a new com.playeveryware.eos-[VERSION].tgz file at the indicated output directory, the same exact way it would if you created a package via Unity Editor EOS Plugin -> Advanced -> Create Package (and subsequently pressed "Create UPM Package"):

Unity.exe -batchMode \
    -nographics \
    -quit \
    -projectPath [Path to eos_plugin_for_unity root directory] \
    -executeMethod BuildPackage.ExportPlugin \
    -EOSPluginOutput [Absolute Path to Output]

Important

In order for this to work correctly, it is imperitive that your repository be properly checked out, this includes making sure that the lfs files are properly downloaded via git lfs install / git lfs pull.

The following command-line argument is the only one introduced by this project:

-EOSPluginOutput The directory in which the newly created tarball should be placed.

The following command-line arguments are used and defined by Unity, and Unity provides fairly detailed documentation on command-line options:

-batchMode Indicates whether Unity should launch a window or run 'headless'.

-nographics Allows the build to be done on hardware that does not have a GPU.

-quit On success or failure, quit.

-projectPath The path to the root of this repository.

-executeMethod Indicates which static class and which static function on that class should be executed. (In this case, the value passed to this argument should be BuildPackaghe.ExportPlugin).