You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 11, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@
7
7
* License: This repository is subject to [license](LICENSE.md)
8
8
9
9
Use the SpatialOS Unity SDK to create games with persistent online worlds.
10
-
Together with the SpatialOS [spatial CLI](https://docs.improbable.io/reference/13.0/shared/spatial-cli/introduction), the SpatialOS Unity SDK
10
+
Together with the SpatialOS [spatial CLI](https://docs.improbable.io/reference/13.0/shared/spatial-cli-introduction), the SpatialOS Unity SDK
11
11
allows you to use [Unity](https://www.unity3d.com) to create games for the [SpatialOS](https://improbable.io/games) platform.
12
-
To help you get started, there are [tutorials](tutorials) to follow and [example games](docs/repositories.md) to
12
+
To help you get started, there are [tutorials](docs/tutorials/learning-resources.md) to follow and [example games](docs/repositories.md) to
13
13
experiment with. In addition to the [SpatialOS Unity SDK documentation](docs/start-here-table-of-contents.md) in this repository, you can find out more about
14
14
SpatialOS at [docs.improbable.io](https://docs.improbable.io).
**Note:** All our starter projects the VCS ignore files are not set as above, so if your project is based on any of these starter projects, you need to edit the VCS ignore files as described in step 10.
44
+
31
45
32
46
## Detailed guide
33
47
@@ -38,23 +52,24 @@ Note: It’s very important you start by running `spatial clean`. If you don’t
38
52
may cause issues with the new version.
39
53
40
54
### 2. Clone or download the SpatialOS Unity SDK (1.0.0)
41
-
3.Get the SpatialOS Unity SDK by cloning the [SpatialOS Unity SDK GitHub repository](https://github.com/spatialos/UnitySDK).
55
+
Get the SpatialOS Unity SDK by cloning the [SpatialOS Unity SDK GitHub repository](https://github.com/spatialos/UnitySDK).
42
56
43
57
Either follow the **Clone or download** instructions on the web page or clone using the command line.
44
58
(See the [git-scm](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository) website for
45
59
guidance on setting up and using command-line git.)
46
60
61
+
47
62
For command-line git, in a terminal window run:
48
63
`git clone github.com/spatialos/UnitySDK`
49
64
50
65
### 3. Upgrade your Unity project
51
-
4. From the cloned repository, copy the contents of the `Assets` and `Improbable` directories into the directory
66
+
1. From the cloned repository, copy the contents of the `Assets` and `Improbable` directories into the directory
52
67
which contains your Unity project’s workers. (It is the directory which contains the `spatialos_worker_packages.json` file.)
53
68
54
69
For example:
55
70
`~/mySpatialOSgame/workers/unity`
56
71
57
-
5. In the same directory, edit the `spatialos.UnityClient.worker.json` file to remove `"generated_build_scripts_type":"unity"` completely
72
+
2. In the same directory, edit the `spatialos.UnityClient.worker.json` file to remove `"generated_build_scripts_type":"unity"` completely
58
73
and to replace `"spatialos.unity.client.build.json"` with `"Improbable/build_script/spatialos.unity.client.build.json".`
59
74
This part of the file should now look like this:
60
75
```
@@ -63,7 +78,7 @@ This part of the file should now look like this:
63
78
},
64
79
```
65
80
66
-
6. In the same directory, edit the `spatialos.UnityWorker.worker.json` file to remove `"generated_build_scripts_type":"unity"` completely
81
+
3. In the same directory, edit the `spatialos.UnityWorker.worker.json` file to remove `"generated_build_scripts_type":"unity"` completely
67
82
and to replace `"spatialos.unity.worker.build.json"` with `"Improbable/build_script/spatialos.unity.worker.build.json".`
68
83
This part of the file should now look like this:
69
84
```
@@ -73,9 +88,9 @@ This part of the file should now look like this:
73
88
},
74
89
```
75
90
76
-
7. Delete `spatialos_worker_packages.json` as `spatial` no longer uses this file.
91
+
4. Delete `spatialos_worker_packages.json` as `spatial` no longer uses this file.
77
92
78
-
8. Navigate two directories up to find the `spatialos.json` file.
93
+
5. Navigate two directories up to find the `spatialos.json` file.
79
94
Edit the `spatialos.json` file so that the `"version"` is `“13.0.0”` and save the file. Note that there are two
80
95
places to edit the version.
81
96
The file should now look similar to this:
@@ -90,10 +105,34 @@ The file should now look similar to this:
90
105
}
91
106
```
92
107
93
-
9. In the root directory of your project, run `spatial clean` (again).
108
+
6. In the root directory of your project, run `spatial clean` (again).
109
+
110
+
### 5. Update the version control ignore files
111
+
112
+
Make sure your version control system (VCS) is set to; **stop ignoring** the Unity SDK directories you have copied, specifically the directories under `Assets/Plugins/Improbable`, and **ignore** some auto-generated files.
113
+
1. Locate the VCS ignore files in your project’s root directory and `workers\unity` directory.
114
+
* For example, the VCS ignore files to check on the Pirates project on GitHub are:
115
+
* in the `workers/unity` directory - [github.com/spatialos/PiratesTutorial/blob/master/workers/unity/.gitignore](https://github.com/spatialos/PiratesTutorial/blob/master/workers/unity/.gitignore)
116
+
* in the root directory - [github.com/spatialos/PiratesTutorial/blob/master/.gitignore](https://github.com/spatialos/PiratesTutorial/blob/master/.gitignore)
117
+
118
+
2. Delete the following lines from the ignore files:
You need to do this for every project you migrate.
131
+
132
+
**Note:** In all our starter projects (including Wizards and Pirates) the version control ignore files are not set as above, so if your project is based on any of these projects, you need to edit the VCS ignore files.
94
133
95
-
### 4. Check it worked
96
-
10.In the root directory of your project, check that the upgrade and migration worked by running:
134
+
### 6. Check it worked
135
+
In the root directory of your project, check that the upgrade and migration worked by running:
97
136
`spatial worker build`.
98
137
99
138
It’s worked when you see `'spatial build UnityWorker UnityClient' succeeded` (or `'spatial.exe build UnityWorker UnityClient' succeeded`).
0 commit comments