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: README.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,8 +26,9 @@ Nopipeline is not a Pipeline Tool replacement - it's an addon. Its only function
26
26
27
27
## Now we're talking. How do I integrate this thing in my project?
28
28
29
-
First of all, install the `Nopipeline.Task` via Nuget. After that, you will need a NPL config. NPL config is what Nopipeline uses to generate MGCB config. It looks like this:
29
+
First of all, install the `Nopipeline.Task` via Nuget. After that, you will need a NPL config. NPL config is what Nopipeline uses to generate MGCB config. Nopipeline will generate an empty NPL config automaticaly on first build. After that, you can just delete MGCB config. Yep, that's right, you don't need it anymore - Nopipeline will generate a new MGCB automatically. I also recommend adding your `.mgcb` files to the gitignore.
30
30
31
+
Now you need to understand how NPL config works and fill it up with rules so that Nopipeline would know what content goes where. NPL config looks like this:
31
32
32
33
```json
33
34
{
@@ -61,9 +62,9 @@ First of all, install the `Nopipeline.Task` via Nuget. After that, you will need
61
62
}
62
63
}
63
64
```
64
-
NPL config is essentially a JSON. Config above has two file groups: `textures`
65
-
and `specificFile`. Each file group describes one specific resource type.
66
-
File groups can contain whole directories or single files.
65
+
It is essentially a JSON. Config above has two content rules: `textures`
66
+
and `specificFile`. Each rule describes one specific resource type.
67
+
Rules can affect entire directories or specific files.
67
68
68
69
69
70
Let's look at an each parameter:
@@ -74,14 +75,15 @@ Here are some examples:
74
75
- `Graphics/Textures/*.png` will grab any `.png` file.
75
76
- `Graphics/Textures/*` will grab any file in the `Textures` directory.
76
77
- `$Graphics/Textures/*` will ignore `root` property.
78
+
**NOTE**: Rule paths cannot contain `../`. Use `root` if you need those.
77
79
-`recursive` tells Nopipeline to include resource files from subdirectories.
78
80
For example, if set to `True`, and the `path` is `Graphics/Textures/*.png`,
79
81
files from `Graphics/Textures/Subdir/` will be grabbed as well. If set to
80
82
`False`, they will be ignored.
81
-
-`action` tells what action has to be done for this file group. Can be `build`
83
+
-`action` tells what action has to be done for this rule. Can be `build`
82
84
or `copy`.
83
-
-`importer` tells what importer should be used for building.
84
-
-`processor` tells what processor should be used for building.
85
+
-`importer` tells what importer should be used for building. Ignored if `action` is set to `copy`.
86
+
-`processor` tells what processor should be used for building. Ignored if `action` is set to `copy`.
85
87
-`processorParam` is an optional list of processor parameters, if resource
0 commit comments