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
Copy file name to clipboardExpand all lines: _doc/tutorials/wurstbuild/dependencies.md
+16-12Lines changed: 16 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,17 @@
1
1
---
2
2
title: The wurst.build file
3
3
sections:
4
-
- Welcome
5
4
- File Structure
6
5
- Dependencies
6
+
- Build Map Data
7
7
---
8
8
9
-
## Welcome
10
-
11
-
This tutorial documents the usage of the wurst setup tool in combination with the wurst.build file to create versionable map and project configuration.
12
-
13
9
## File Structure
14
10
15
-
The `wurst.build` file is a yaml file that must reside at the root of your project. The `wurst` folder therefore should be right next to it.
11
+
The `wurst.build` file is a yaml file that must reside in the root of your project. The `wurst` folder should be right next to it.
16
12
This file controls your project's dependencies and how the map is configured upon a build task.
17
-
All values in this file are optional. Incomplete or invalid config will be completed by using the map's existing configuration and default values.
18
-
The following is a complete wurst.build file with all fields containing the default values. If you are not changing this default values, you can omit the fields.
13
+
Almost all values in this file are optional. Incomplete or invalid config will be completed by using the map's existing configuration and default values.
14
+
The schema is provided on project install for auto complete in vscode. You will also find a full example file below.
19
15
20
16
```yml
21
17
projectName: Escape Builder Reloaded
@@ -30,7 +26,8 @@ buildMapData:
30
26
description: WurstScript powered! # The map's description
31
27
suggestedPlayers: DefaultSuggestedPlayers # Hint text displayed in lobby
32
28
loadingScreen:
33
-
background: Generic
29
+
model: MyModel.mdx # Use 'model' to specify a custom model as loading screen
30
+
background: Generic # Use 'background' to use an existing loading screen
34
31
title: DefaultTitle
35
32
subTitle: DefaultSubtitle
36
33
text: DefaultText
@@ -61,11 +58,18 @@ buildMapData:
61
58
62
59
## Dependencies
63
60
64
-
The setup does no version locking for now, but this is planned for a future version. Transitive dependencies will not be resolved.
65
-
You can target specific branches using a suffix, e.g. `https://github.com/wurstscript/wurstStdlib2:pre1.29`.
66
-
61
+
The project's dependencies are listed at the top of the `wurst.build` file and downloaded when the project is installed using `grill install`.
67
62
A dependency is a simple url to a public git repo, which can be pulled by the setup.
68
63
Projects created by the setup include the standard library dependency by default: `https://github.com/wurstscript/wurstStdlib2`.
69
64
70
65
To add a dependency run `grill install` with a valid, accesible git repo url, e.g. `grill install https://github.com/frotty/frentity`.
66
+
This will checkout the dependency locally and also add an entry to the `wurst.build` file.
67
+
68
+
The setup does no version locking for now, but this is planned for a future version. Transitive dependencies will not be resolved.
69
+
You can target specific branches using a suffix, e.g. `https://github.com/wurstscript/wurstStdlib2:pre1.29`.
70
+
71
+
## Build Map Data
72
+
73
+
Following the dependencies is the build map data, which offers most of the settings you would normally find in the `Scenario Settings` in the World Editor.
74
+
Such as the description, players, forces and the loading screen. The configuration will then be applied to the input map of any run or build task of the project.
0 commit comments