mcmodbuild 0.1.1

Format for describing how mods should be built and automatically building them from a file.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# mcmodbuild

McModBuild is a format for describing how mods should be built and automatically building them from a file.

## Format

```yaml
# yourmod.yml
id: "yourmod"
name: "Test mod"
git: "https://github.com/you/yourmod.git"
branch: "1.21.7"
build: Cmd # Can be Std
cmd: "./build.sh" # If build is set to Std, cmd isn't needed as it'll run `./gradlew build`
out: "dir:@/build/libs" # Directory to find the jar, can be file:... to specify a file, @ is the build root
exclude:
  # Files to exclude if `out` is a directory, if it's a file, set it to []
  - type: Ends
    value: "-sources.jar"
  - type: Starts
    value: "tmp-"
  - type: Contains
    value: "dev"
```

## Commands

### `mcmodbuild build <path-to-build-file>`

Converts a build file into an installation file named `<id>.mcmodbuild`.


- `-d`: Destination (Optional). E.g. `mcmodbuild build testmod.yml -d dist/mod.mcmodbuild`

### `mcmodbuild install <path-to-binary-file>`

Builds a mod from an installation file.

- `-d`: Destination (Optional). E.g. `mcmodbuild install testmod.mcmodbuild -d mods/`