-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathunitytutorial.html
More file actions
217 lines (195 loc) · 13 KB
/
Copy pathunitytutorial.html
File metadata and controls
217 lines (195 loc) · 13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" ><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" >
<title>Unity Tutorial — Simul documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" >
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" >
<link rel="shortcut icon" href="../_static/favicon.ico">
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" >
<link rel="search" title="Search" href="../search.html" >
<link rel="next" title="Scripting" href="unityscripting.html" >
<link rel="prev" title="trueSKY for Unity" href="../unity.html" >
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="" >
<span class="sidebartitle">
trueSKY 4.3
</span>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<label class="search-label" for="q">Search the documentation</label>
<input type="text" name="q" id="q" placeholder="Search..." aria-label="Search docs" >
<input type="hidden" name="check_keywords" value="yes" >
<input type="hidden" name="area" value="default" >
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation and Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorialsindex.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unreal.html">trueSKY for Unreal Engine</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../unity.html">trueSKY for Unity</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Unity Tutorial</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#initial-configuration">Initial Configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="#obtaining-the-truesky-unity-package">Obtaining the trueSKY Unity Package</a></li>
<li class="toctree-l3"><a class="reference internal" href="#installing-the-plugin">Installing the Plugin</a></li>
<li class="toctree-l3"><a class="reference internal" href="#adding-truesky-to-the-scene">Adding trueSKY to the scene</a></li>
<li class="toctree-l3"><a class="reference internal" href="#creating-new-sky-sequences">Creating New Sky Sequences</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="unityscripting.html">Scripting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../skysequencer.html">Sky Sequencer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../programming.html">Programming with the trueSKY SDK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../legalindex.html">trueSKY Licences</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../API/apiindex.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Reference/referenceindex.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelist.html">Changelist</a></li>
</ul>
</div>
</div>
</nav>
<div data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<h2 class="wy-nav-top">Navigation</h2><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Simul</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../unity.html">trueSKY for Unity</a></li>
<li class="breadcrumb-item active">Unity Tutorial</li>
<li class="wy-breadcrumbs-aside">
<div class="truesky-version-switch">
<button id="version-switch-button">Switch Version</button>
</div>
<script>
const switchButton = document.getElementById('version-switch-button');
// current URL
const currentURL = window.location.href;
const isVersion4_3 = currentURL.includes('/4.3');
const isVersion4_4 = currentURL.includes('/4.4');
if (isVersion4_3) {
switchButton.textContent = 'Switch to 4.4';
switchButton.addEventListener('click', () => {
window.location.href = '/4.4';
});
} else if (isVersion4_4) {
switchButton.textContent = 'Switch to 4.3';
switchButton.addEventListener('click', () => {
window.location.href = '/4.3';
});
} else {
switchButton.textContent = 'Switch to 4.3';
switchButton.addEventListener('click', () => {
window.location.href = '/4.3';
});
}
</script>
</li>
</ul>
<hr>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="unity-tutorial">
<h1>Unity Tutorial<a class="headerlink" href="#unity-tutorial" title="Permalink to this heading">¶</a></h1>
<section id="initial-configuration">
<h2>Initial Configuration<a class="headerlink" href="#initial-configuration" title="Permalink to this heading">¶</a></h2>
<p>This page shows you how to install the trueSKY plugin for Unity. Head back to <a class="reference internal" href="../installation.html"><span class="doc">Installation</span></a> if you do not need the Unity Package.</p>
<div class="video-wrapper">
<div class="video-container">
<iframe title="Unity Install" width="560" height="315" src="https://www.youtube.com/embed/VsKBvibi_W8" style="border:0;" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
</div>
</section>
<section id="obtaining-the-truesky-unity-package">
<h2>Obtaining the trueSKY Unity Package<a class="headerlink" href="#obtaining-the-truesky-unity-package" title="Permalink to this heading">¶</a></h2>
<p>1: Login to your account at <a class="reference external" href="https://simul.co/account">https://simul.co/account</a>. If you have not created an account yet, head over to <a class="reference internal" href="../installation.html"><span class="doc">Getting Started</span></a> to get setup.</p>
<p>2: Download trueSKY Unity Package from <a class="reference external" href="https://simul.co/downloads">https://simul.co/downloads</a>. Make sure to select the correct engine version you desire, and we always recommend the most up to date version of trueSKY. The top of the download page has the option to download the latest version of trueSKY with the latest version of Unity. Be aware Unity has issues importing packages from the downloads folder, so we recommend saving the file in a different directory related to Unity.</p>
<img alt="There are different versions of trueSKY available for each Unity version." src="../_images/downloadpage.png" />
</section>
<section id="installing-the-plugin">
<h2>Installing the Plugin<a class="headerlink" href="#installing-the-plugin" title="Permalink to this heading">¶</a></h2>
<p>1: Launch the Unity project that you want to add trueSKY to, or create a new project.</p>
<p>2: Click on ‘Assets -> Import Package -> Custom Package’.</p>
<img alt="Import package is in the asset drop-down menu" src="../_images/importpackage.png" />
<p>3: Locate and select the trueSKY package you just downloaded.</p>
<p>4: Unity will now decompress the package for your scene. This may take up to 5 minutes, depending on your machine.</p>
<img alt="Preparing package can take some time." src="../_images/preparingpackage.png" />
<p>5: Unity will ask you which files to import, make sure they are all selected.</p>
<img alt="The imported package should import everything available." src="../_images/importpackagefinished.png" />
</section>
<section id="adding-truesky-to-the-scene">
<h2>Adding trueSKY to the scene<a class="headerlink" href="#adding-truesky-to-the-scene" title="Permalink to this heading">¶</a></h2>
<p>1: Open up a project, this can either be a new project or use the provided sample project located at AssetsSimulSimulTest.</p>
<p>2: Click on ‘GameObject -> Initialize trueSKY in scene’ from the dropdown menus at the top of the window.</p>
<img alt="Initialize trueSKY is in the GameObject drop-down menu." src="../_images/initializetruesky.png" />
<p>3: Make sure you have the scene open that you want to initialize trueSKY into, then click next. Otherwise, load up a different scene before starting the initialization.</p>
<p>4: Select one of the preset sequences to be first imported into your scene. If you do not select one, a new sequence asset will be created and assigned. Click next when ready.</p>
<p>5: trueSKY can now either create a new camera, while assigning the trueSKY scripts, or you can select a camera currently in the scene to have the scripts applied to it. Alternatively, trueSKY can be assigned to all cameras in the scene, by selecting the correspoding tickbox. Click next when ready.</p>
<p>6: trueSKY will create a trueSKY game object for your scene, if there is not already one present.</p>
<p>7: trueSKY only needs one directional light, so we recommend you do not use more if possible. If there are no directional lights within the scene, then one will be created.</p>
<p>8: The final step will initialize trueSKY in the scene, while also removing any conflicting assets such as the default skybox and distance fog - trueSKY handles this for you. Click the finish button for trueSKY to appear in your scene with your selected sequence.</p>
</section>
<section id="creating-new-sky-sequences">
<h2>Creating New Sky Sequences<a class="headerlink" href="#creating-new-sky-sequences" title="Permalink to this heading">¶</a></h2>
<p>1: Right click within the Asset Window and click ‘Create -> New trueSky Sequence’, which will appear at the bottom of the options.</p>
<img alt="Create Sequence is within the Create menu of the asset window." src="../_images/addsequence.png" />
<p>2: The new sequence will be created within the asset window.</p>
<p>3: To make this new sequence the active sequence in the world, select the trueSky object from the hierarchy. Then in the inspector, find “Sequence Asset” in the trueSKY script.</p>
<img alt="Set the active trueSKY Sequence though the asset inspector." src="../_images/setsequence.png" />
<p>4: You can either manually select your sequence from within the Inspector, or you can drag and drop your preferred sequence from the asset browser to the active sequence box.</p>
<p>Now you are almost ready to start creating amazing environments with trueSKY, you just need to activate your license within the sequencer. <a class="reference internal" href="../Tutorials/Sequencer/sequenceroverview.html"><span class="doc">Head over here</span></a> to learn how to activate trueSKY, along with how to use the Sky Sequencer to create your own environments.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../unity.html" class="btn btn-neutral float-left" title="trueSKY for Unity" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="unityscripting.html" class="btn btn-neutral float-right" title="Scripting" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr>
<div role="contentinfo">
<p>© Copyright 2007-2023, Simul Software Ltd.</p>
</div>
</footer>
</div>
</div>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<div class="overlay" style="display: none;">
<img class="fullsize" alt="fullscreen image overlay" src="data:,">
</div>
</body>
</html>