|
3
|
1 *unreal.txt* Work with Unreal Engine in Vim
|
|
|
2
|
|
|
3
|
|
|
4 █ ██ ███▄ █ ██▀███ ▓█████ ▄▄▄ ██▓
|
|
|
5 ██ ▓██▒ ██ ▀█ █ ▓██ ▒ ██▒▓█ ▀▒████▄ ▓██▒
|
|
|
6 ▓██ ▒██░▓██ ▀█ ██▒▓██ ░▄█ ▒▒███ ▒██ ▀█▄ ▒██░
|
|
|
7 ▓▓█ ░██░▓██▒ ▐▌██▒▒██▀▀█▄ ▒▓█ ▄░██▄▄▄▄██ ▒██░
|
|
|
8 ▒▒█████▓ ▒██░ ▓██░░██▓ ▒██▒░▒████▒▓█ ▓██▒░██████▒
|
|
|
9 ░▒▓▒ ▒ ▒ ░ ▒░ ▒ ▒ ░ ▒▓ ░▒▓░░░ ▒░ ░▒▒ ▓▒█░░ ▒░▓ ░
|
|
|
10 ░░▒░ ░ ░ ░ ░░ ░ ▒░ ░▒ ░ ▒░ ░ ░ ░ ▒ ▒▒ ░░ ░ ▒ ░
|
|
|
11 ░░░ ░ ░ ░ ░ ░ ░░ ░ ░ ░ ▒ ░ ░
|
|
|
12 ░ ░ ░ ░ ░ ░ ░ ░ ░
|
|
|
13
|
|
|
14
|
|
|
15 VIM-UNREAL
|
|
|
16
|
|
|
17 *unreal*
|
|
|
18
|
|
|
19 ==============================================================================
|
|
|
20 *unreal-introduction*
|
|
|
21 Introduction
|
|
|
22
|
|
|
23 Vim-unreal is a plugin that lets you work with game codebases that use Unreal
|
|
|
24 Engine. In most cases, you should be able to launch, say, `gvim` from
|
|
|
25 somewhere inside your codebase, and it should "just work". You'll be able to
|
|
|
26 run commands such as |UnrealGenerateProjectFiles| and |UnrealBuild|. It is
|
|
|
27 recommended to install vim-dispatch for running these operations in the
|
|
|
28 background.
|
|
|
29
|
|
|
30 If you install the vim-crosoft plugin, vim-unreal will also automatically set
|
|
|
31 the root Visual Studio solution as the active solution. This will bring
|
|
|
32 better file-listing support for file-listers supported by vim-crosoft (FZF is
|
|
|
33 recommended), clangd language server support (YouCompleteMe is recommended),
|
|
|
34 and so on. For supporting other infrastructures, refer to the vim-crosoft
|
|
|
35 plugin or other appropriate plugin.
|
|
|
36
|
|
|
37 ==============================================================================
|
|
|
38 *unreal-configuration*
|
|
|
39 Configuration
|
|
|
40
|
|
|
41 *g:unreal_trace*
|
|
|
42 g:unreal_trace
|
|
|
43 Enables debugging information.
|
|
|
44 Default: `0`
|
|
|
45
|
|
|
46 *g:unreal_branch_dir_marker*
|
|
|
47 g:unreal_branch_dir_marker
|
|
|
48 How vim-unreal detects the root directory of an Unreal
|
|
|
49 codebase branch. This should be a glob pattern that matches
|
|
|
50 something when a given directory is an Unreal codebase.
|
|
|
51 Default: `*.uprojectdirs`
|
|
|
52
|
|
|
53 *g:unreal_branch_dir_finder*
|
|
|
54 g:unreal_branch_dir_finder
|
|
|
55 The name of a function that lets vim-unreal find the list
|
|
|
56 of projects in a branch.
|
|
|
57 Default: `''`
|
|
|
58
|
|
|
59 The default finder looks for a marker defined by the glob
|
|
|
60 pattern |g:unreal_branch_dir_marker|.
|
|
|
61
|
|
|
62 *g:unreal_auto_find_project*
|
|
|
63 g:unreal_auto_find_project
|
|
|
64 Whether vim-unreal should try to detect an Unreal branch
|
|
|
65 on startup and find an appropriate project to set.
|
|
|
66 Vim-unreal saves the last set project of each known branch
|
|
|
67 so that after restarting Vim it can restore the same project
|
|
|
68 as last time.
|
|
|
69 Default: `0`
|
|
|
70
|
|
|
71 *g:unreal_auto_build_modules*
|
|
|
72 g:unreal_auto_build_modules
|
|
|
73 Dictionary of Unreal modules to always automatically build
|
|
|
74 along with the current project's main module when running
|
|
|
75 the |UnrealBuild| command and associated commands.
|
|
|
76 The dictionary should map a module's name with a list of
|
|
|
77 build options (if any).
|
|
|
78 Default:
|
|
|
79 `{"ShaderCompileWorker": ["-Quiet"]}`
|
|
|
80
|
|
|
81 *g:unreal_auto_build_options*
|
|
|
82 g:unreal_auto_build_options
|
|
|
83 A list of default build options to pass to UnrealBuildTool
|
|
|
84 when running the |UnrealBuild| command and associated
|
|
|
85 commands.
|
|
|
86 Default:
|
|
|
87 `["-WaitMutex"]`
|
|
|
88
|
|
|
89 *g:unreal_auto_generate_compilation_database*
|
|
|
90 let g:unreal_auto_generate_compilation_database
|
|
|
91 Whether to automatically generate the clang compilation
|
|
|
92 database when running |UnrealGenerateProjectFiles|.
|
|
|
93 See |UnrealGenerateCompilationDatabase| for more
|
|
|
94 information.
|
|
|
95
|
|
|
96 *g:unreal_platforms*
|
|
|
97 g:unreal_platforms
|
|
|
98 Known list of platforms.
|
|
|
99 Mainly used for auto-completion.
|
|
|
100 Default:
|
|
|
101 `["Win32", "Win64", "HoloLens", "Mac", "XboxOne", "PS4",`
|
|
|
102 ` "IOS", "Android", "HTML5", "Linux", "AllDesktop",`
|
|
|
103 ` "TVOS", "Switch"]`
|
|
|
104
|
|
|
105 *g:unreal_config_states*
|
|
|
106 g:unreal_config_states
|
|
|
107 Known list of configuration states.
|
|
|
108 Mainly used for auto-completion.
|
|
|
109 Default:
|
|
|
110 `["Debug", "DebugGame", "Development", "Shipping",`
|
|
|
111 ` "Test"]`
|
|
|
112
|
|
|
113 *g:unreal_config_targets*
|
|
|
114 g:unreal_config_targets
|
|
|
115 Known list of configuration targets.
|
|
|
116 Mainly used for auto-completion.
|
|
|
117 Default:
|
|
|
118 `["", "Editor", "Client", "Server"]`
|
|
|
119
|
|
|
120 *g:unreal_build_options*
|
|
|
121 g:unreal_build_options
|
|
|
122 Known list of UnrealBuildTool options.
|
|
|
123 Mainly used for auto-completion.
|
|
|
124 Default:
|
|
|
125 `["-DisableUnity", "-ForceUnity"]`
|
|
|
126
|
|
|
127 ==============================================================================
|
|
|
128 *unreal-commands*
|
|
|
129 Commands
|
|
|
130
|
|
|
131 *:UnrealFindProject*
|
|
|
132 :UnrealFindProject
|
|
|
133 Uses the current working directory (see |getcwd()|) to
|
|
|
134 detect an Unreal codebase branch and a default project to
|
|
|
135 set (see |UnrealSetBranchDir| and |UnrealSetProject|).
|
|
|
136
|
|
|
137 *:UnrealSetBranchDir*
|
|
|
138 :UnrealSetBranchDir {dir}
|
|
|
139 Sets the current branch to the given directory.
|
|
|
140
|
|
|
141 *:UnrealSetProject*
|
|
|
142 :UnrealSetProject {projectname}
|
|
|
143 Sets the current project to the one matching the given name.
|
|
|
144
|
|
|
145 *:UnrealSetPlatform*
|
|
|
146 :UnrealSetPlatform {platform}
|
|
|
147 Sets the current platform.
|
|
|
148
|
|
|
149 *:UnrealSetConfig*
|
|
|
150 :UnrealSetConfig {config}
|
|
|
151 Sets the current configuration.
|
|
|
152 Vim-unreal will attempt to parse the state and target from
|
|
|
153 the given configuration name.
|
|
|
154
|
|
|
155 *:UnrealGenerateProjectFiles*
|
|
|
156 :UnrealGenerateProjectFiles
|
|
|
157 Regenerates the Visual Studio project files.
|
|
|
158
|
|
|
159 *:UnrealBuild*
|
|
|
160 :UnrealBuild {project} {platform} {config}
|
|
|
161 Builds the currently set project using the currently set
|
|
|
162 platform and configuration.
|
|
|
163 If the project, platform, and/or configuration are provided
|
|
|
164 in the command invocation, use those instead of the
|
|
|
165 currently set ones.
|
|
|
166 If the vim-dispatch plugin is installed, vim-unreal will
|
|
|
167 favour using |:Make| instead of |:make|, so that the build
|
|
|
168 job is run in the background.
|
|
|
169
|
|
|
170 *:UnrealRebuild*
|
|
|
171 :UnrealRebuild {project} {platform} {config}
|
|
|
172 Like |:UnrealBuild|, but does a full rebuild.
|
|
|
173
|
|
|
174 *:UnrealClean*
|
|
|
175 :UnrealClean {project} {platform} {config}
|
|
|
176 Like |:UnrealBuild|, but cleans the build artifacts instead.
|
|
|
177
|
|
|
178 *:UnrealGenerateCompilationDatabase*
|
|
|
179 :UnrealGenerateCompilationDatabase
|
|
|
180 Generates a clang compilation database for use with language
|
|
|
181 server plugins like YouCompleteMe.
|
|
|
182 If the vim-dispatch plugin is installed, vim-unreal will
|
|
|
183 favour using |:Make| instead of |:make|, so that the build
|
|
|
184 job is run in the background.
|
|
|
185
|
|
|
186 *:UnrealReloadBranchProjects*
|
|
|
187 :UnrealReloadBranchProjects
|
|
|
188 Reloads the branch's projects. This is only needed if the
|
|
|
189 codebase was updated without restarting Vim and vim-unreal's
|
|
|
190 knowledge of the projects was outdated.
|
|
|
191
|
|
|
192 ==============================================================================
|
|
|
193 *unreal-internals*
|
|
|
194 Internals
|
|
|
195
|
|
|
196 *g:unreal_branch_projects*
|
|
|
197 g:unreal_branch_projects
|
|
|
198 A dictionary mapping known projects in the current branch
|
|
|
199 with their properties loaded from their JSON `uproject` file.
|
|
|
200 If these files have changed, you can reload this with the
|
|
|
201 |UnrealReloadBranchProjects| command.
|
|
|
202
|
|
|
203 *g:unreal_branch_dir*
|
|
|
204 g:unreal_branch_dir
|
|
|
205 The currently set Unreal codebase root directory.
|
|
|
206 It can be set with the |UnrealSetBranchDir| command.
|
|
|
207
|
|
|
208 *g:unreal_project*
|
|
|
209 g:unreal_project
|
|
|
210 The currently set Unreal project's name.
|
|
|
211 It can be set with the |UnrealSetProject| command.
|
|
|
212
|
|
|
213 *g:unreal_platform*
|
|
|
214 g:unreal_platform
|
|
|
215 The currently set Unreal platform.
|
|
|
216 It can be set with the |UnrealSetPlatform| command.
|
|
|
217
|
|
|
218 *g:unreal_config_state*
|
|
|
219 g:unreal_config_state
|
|
|
220 The currently set Unreal configuration state.
|
|
|
221 It can be set with the |UnrealSetConfig| command.
|
|
|
222
|
|
|
223 *g:unreal_config_target*
|
|
|
224 g:unreal_config_target
|
|
|
225 The currently set Unreal configuration target.
|
|
|
226 It can be set with the |UnrealSetConfig| command.
|
|
|
227
|
|
|
228
|
|
|
229 " vim:tw=78:et:ft=help:norl:
|
