70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
# File 'lib/u3d/commands_generator.rb', line 70
def run
program :version, U3d::VERSION
program :description, U3d::DESCRIPTION
program :help, 'Authors', 'Jerome Lacoste <[email protected]>, Paul Niezborala <[email protected]>'
program :help, 'A word on Unity versions', U3d::UNITY_VERSIONS_NOTE
global_option('--verbose', 'Run in verbose mode') { U3dCore::Globals.verbose = true }
command :run do |c|
run_args =
c.syntax = 'u3d run [-u | --unity_version <version>] [-r | --raw_logs] [ -- <run_args>]'
c.summary = 'Run Unity, and parse its output through u3d\'s log prettifier'
c.description = %(
#{c.summary}
The default prettifier rules file is packaged with u3d (#{U3d::LogAnalyzer::RULES_PATH}).
You may which to pass your own using the environment variable U3D_RULES_PATH.
E.g. U3D_RULES_PATH=my_rules.json u3d -- ...
Fore more information about how the rules work, see https://github.com/DragonBox/u3d/blob/master/LOG_RULES.md
)
c.option '-u', '--unity_version STRING', String, 'Version of Unity to run with. If not specified, it runs with the version of the project (either specified as -projectPath or current)'
c.option '-r', '--raw_logs', 'Raw Unity output, not filtered by u3d\'s log prettifier'
c.action do |args, options|
UI.user_error! "Run doesn't take arguments. Did you forget '--' or did you mistake your command? (#{args})" if args.count > 0
U3dCore::Globals.log_timestamps = true
Commands.run(options: convert_options(options), run_args: run_args)
end
end
command :list do |c|
c.syntax = 'u3d list [-p | --packages]'
c.option '-p', '--packages', 'Lists installed packages as well'
c.example 'List currently installed Unity versions, as well as installed packages', 'u3d list -p'
c.summary = 'List installed versions of Unity'
c.action do |_args, options|
Commands.list_installed(options: convert_options(options))
end
end
command :available do |c|
oses = U3dCore::Helper.operating_systems
c.syntax = 'u3d available [-r | --release_level <level>] [-o | --operating_system <OS>] [-u | --unity_version <version>] [-p | --packages] [-f | --force]'
levels = Commands.release_levels
c.option '--[no-]central', 'Use or not the central version cache'
c.option '-f', '--force', 'Force refresh list of available versions'
c.option '-r', '--release_level STRING', String, "Checks for availability on specific release level [#{levels.join(', ')}]"
c.option '-o', '--operating_system STRING', String, "Checks for availability on specific OS [#{oses.join(', ')}]"
c.option '-u', '--unity_version STRING', String, 'Checks if specified version is available. Can be a regular expression'
c.option '-p', '--packages', 'Lists available packages as well'
c.example 'List all versions available, forcing a refresh of the available packages from Unity servers', 'u3d available -f'
c.example 'List stable versions available', 'u3d available -r stable -p'
c.example 'List all versions available for Linux platform', 'u3d available -o linux'
c.example 'List packages available for Unity version 5.6.0f3', 'u3d available -u 5.6.0f3 -p'
c.example 'List packages available for Unity version containing the 5.6 string', 'u3d available -u \'5.6\' -p'
c.summary = 'List download-ready versions of Unity'
c.description = %(
#{c.summary}
This command interprets the information that are available on Unity's website and forums to fetch all the version that are available for download.
It relies on a centralized cache (https://dragonbox.github.io/unities/v1/versions.json) that performs the fetching automatically so that you don't have to do it locally. If you do not want to use this central cache and wish to perform the fetching yourself, you can use the --no-central option.
)
c.action do |_args, options|
options.default packages: false
options.default central: true
Commands.list_available(options: convert_options(options))
end
end
command :install do |c|
oses = U3dCore::Helper.operating_systems
c.syntax = 'u3d install [<version>] [ [-p | --packages <package1>,<package2> ...] | [-o | --operating_system <OS>] [-a | --all] ] [--[no-]download] [ [--[no-]install] [-i | --installation_path <path>] ]'
c.summary = 'Download (and/or) install Unity editor packages'
c.description = %(
#{c.summary}
This command allows you to either:
* download and install packages
* download packages but not install them
* install already downloaded packages
Already installed packages are skipped if asked to be installed again (except for the 'Example' package).
The default download path is $HOME/Downloads/Unity_Packages/, but you may change that by specifying the environment variable U3D_DOWNLOAD_PATH.
E.g. U3D_DOWNLOAD_PATH=/some/path/you/want u3d install ...
)
c.option '--[no-]download', 'Perform or not downloading before installation. Downloads by default'
c.option '--[no-]install', 'Perform or not installation after downloading. Installs by default'
c.option '-p', '--packages PACKAGES', Array, 'Specifies which packages to download/install. Overriden by --all'
c.option '-o', '--operating_system STRING', String, "Downloads packages for specific OS [#{oses.join(', ')}]. Requires the --no-install option."
c.option '-a', '--all', 'Download all available packages. Overrides -p'
c.option '-i', '--installation_path PATH', String, 'Specifies where package(s) will be downloaded/installed. Conflicts with --no-install'
c.option '-k', '--keychain', 'Gain privileges right through the keychain. [OSX only]'
c.example 'Download and install Unity, its Documentation and the Android build support and install them for version 5.1.2f1', 'u3d install 5.1.2f1 -p Unity,Documentation,Android'
c.example 'Download but do not install all Unity version 2018.1.0b2 packages for platform Windows (while e.g. on Mac)', 'u3d install 2018.1.0b2 -o win -a --no-install'
c.example "The 'version' argument can be a specific version number, such as 5.6.1f1, or an alias in [#{Commands.release_letter_mapping.keys.join(', ')}]. If not specified, u3d will download the unity version for the current project", 'u3d install latest'
c.example "The admin password can be passed through the U3D_PASSWORD environment variable.", 'U3D_PASSWORD=mysecret u3d install a_version'
c.example "On Mac, the admin password can be fetched from (and stored into) the keychain.", 'u3d install -k a_version'
c.action do |args, options|
options.default all: false
options.default install: true
options.default download: true
Commands.install(args: args, options: convert_options(options))
end
end
command :uninstall do |c|
c.syntax = 'u3d uninstall [<version>]'
c.summary = 'Uninstall the specified Unity version'
c.option '-k', '--keychain', 'Gain privileges right through the keychain. [OSX only]'
c.example 'Uninstall Unity version 5.2.1f1', 'u3d uninstall 5.1.2f1'
c.action do |args, options|
Commands.uninstall(args: args, options: convert_options(options))
end
end
command :dependencies do |c|
c.syntax = 'u3d dependencies'
c.summary = 'Install Unity dependencies [Linux only]'
c.description = %(
#{c.summary}
Regarding the package manager: if dpkg is installed, u3d uses apt-get else if rpm is installed yum is used. If none of them is insalled, fails.
Regarding the dependencies themselves: only dependencies for the editor are installed. WebGL, Android and Tizen require others that you will have to install manually.
More on that: https://forum.unity3d.com/threads/unity-on-linux-release-notes-and-known-issues.350256/
)
c.action do |_args, _options|
Commands.install_dependencies
end
end
command :credentials do |c|
c.syntax = "u3d credentials <#{Commands.credentials_actions.join(' | ')}>"
c.summary = 'Manage keychain credentials so u3d remembers them [OSX only]'
c.action do |args, _options|
Commands.credentials(args: args)
end
end
command :licenses do |c|
c.syntax = "u3d licenses"
c.description = 'Prints Unity license information.'
c.action do |_args, _options|
Commands.licenses
end
end
command :prettify do |c|
c.syntax = 'u3d prettify <logfile>'
c.summary = 'Prettify a saved Unity logfile'
c.description = %(
#{c.summary}
The default prettifier rules file is packaged with u3d (#{U3d::LogAnalyzer::RULES_PATH}).
You may which to pass your own using the environment variable U3D_RULES_PATH.
E.g. U3D_RULES_PATH=my_rules.json u3d prettify ...
Fore more information about how the rules work, see https://github.com/DragonBox/u3d/blob/master/LOG_RULES.md
)
c.action do |args, _options|
Commands.local_analyze(args: args)
end
end
command :console do |c|
c.syntax = 'u3d console'
c.summary = "Run an interactive console"
c.action do |_args, _options|
Commands.console
end
end
command :move do |c|
c.syntax = 'u3d move [--dry_run] --long <version>'
c.option '-l', '--long', "Rename the installation dir into its long name pattern, namely #{U3d::UNITY_DIR_LONG} on Windows/Mac and #{U3d::UNITY_DIR_LINUX_LONG} on Linux"
c.option '--dry_run', "show what would have happened"
c.summary = "Move an existing Unity install to an optionally specified new folder, marking it as non moveable later on"
c.description = %(
#{c.summary}
Sometimes you want to move Unity to a different folder/path and let u3d stop modifying trying to move it around.
The current command only supports 'long' installation dir names, containing not only the version but also the build number.
See https://github.com/DragonBox/u3d#unity-build-numbers for more information.
)
c.action do |args, options|
Commands.move(args: args, options: convert_options(options))
end
end
default_command :run
run!
end
|