Skip to content

Commit 862fd94

Browse files
committed
Updated readme.
1 parent 056c4f3 commit 862fd94

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

Nuget.props

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Project>
22
<PropertyGroup>
3-
<Version>2.1.2</Version>
3+
<Version>2.1.0</Version>
44
<Description>A Content Pipeline addon for Monogame which fully replaces Pipeline UI.</Description>
55
<Authors>Martenfur</Authors>
66
<Company>Chai Foxes</Company>

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ Nopipeline is not a Pipeline Tool replacement - it's an addon. Its only function
2626

2727
## Now we're talking. How do I integrate this thing in my project?
2828

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.
3030

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:
3132

3233
```json
3334
{
@@ -61,9 +62,9 @@ First of all, install the `Nopipeline.Task` via Nuget. After that, you will need
6162
}
6263
}
6364
```
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.
6768

6869

6970
Let's look at an each parameter:
@@ -74,14 +75,15 @@ Here are some examples:
7475
- `Graphics/Textures/*.png` will grab any `.png` file.
7576
- `Graphics/Textures/*` will grab any file in the `Textures` directory.
7677
- `$Graphics/Textures/*` will ignore `root` property.
78+
**NOTE**: Rule paths cannot contain `../`. Use `root` if you need those.
7779
- `recursive` tells Nopipeline to include resource files from subdirectories.
7880
For example, if set to `True`, and the `path` is `Graphics/Textures/*.png`,
7981
files from `Graphics/Textures/Subdir/` will be grabbed as well. If set to
8082
`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`
8284
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`.
8587
- `processorParam` is an optional list of processor parameters, if resource
8688
has any.
8789

0 commit comments

Comments
 (0)