Skip to content

Commit 030e174

Browse files
committed
update wurst.build doc
1 parent 1f5547d commit 030e174

File tree

3 files changed

+17
-24
lines changed

3 files changed

+17
-24
lines changed

_doc/tutorials/wurstbuild.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: wurst.build file
33
excerpt: Introduction to wurst project and dependency management
4-
date: 2019-10-23
4+
date: 2021-12-06
55
icon:
66
type: fa
77
name: fa-map
@@ -10,5 +10,4 @@ author: Frotty
1010
layout: tutorialdoc
1111
sections:
1212
- /tutorials/wurstbuild/dependencies
13-
- /tutorials/wurstbuild/management
1413
---

_doc/tutorials/wurstbuild/dependencies.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
---
22
title: The wurst.build file
33
sections:
4-
- Welcome
54
- File Structure
65
- Dependencies
6+
- Build Map Data
77
---
88

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-
139
## File Structure
1410

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.
1612
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.
1915

2016
```yml
2117
projectName: Escape Builder Reloaded
@@ -30,7 +26,8 @@ buildMapData:
3026
description: WurstScript powered! # The map's description
3127
suggestedPlayers: DefaultSuggestedPlayers # Hint text displayed in lobby
3228
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
3431
title: DefaultTitle
3532
subTitle: DefaultSubtitle
3633
text: DefaultText
@@ -61,11 +58,18 @@ buildMapData:
6158
6259
## Dependencies
6360
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`.
6762
A dependency is a simple url to a public git repo, which can be pulled by the setup.
6863
Projects created by the setup include the standard library dependency by default: `https://github.com/wurstscript/wurstStdlib2`.
6964

7065
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.
7175

_doc/tutorials/wurstbuild/management.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)