diff --git a/CHANGELOG.md b/CHANGELOG.md index 0443a6d..7851ad1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # nasher changelog +## 0.19.0: Auguest 19, 2022 + +### Added ability to set module description for module targets +([#102](https://github.com/squattingmonk/nasher/pull/102)) + +The `modDescription` field is available in the `[target]` section of +`nasher.cfg` and can be overridden using the `--modDescription` command-line +parameter. + +Thanks, @tinygiant98! + +--- + +Details: https://github.com/squattingmonk/nasher/compare/0.18.2...0.19.0 + + ## 0.18.2: June 22, 2022 Fix: relative paths passed to `--nssCompiler` are now relative to the package diff --git a/Dockerfile b/Dockerfile index afd4943..b99a995 100644 --- a/Dockerfile +++ b/Dockerfile @@ -16,7 +16,7 @@ RUN dpkg --add-architecture i386 \ && apt upgrade -y \ && apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386 -y \ && rm -fr /var/lib/apt/lists/* /root/.cache/* /usr/share/doc/* /var/cache/man/* -ARG NASHER_VERSION="0.18.2" +ARG NASHER_VERSION="0.19.0" ARG NASHER_USER_ID=1000 RUN adduser nasher --disabled-password --gecos "" --uid ${NASHER_USER_ID} RUN echo "nasher ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers && usermod -aG sudo nasher diff --git a/README.md b/README.md index ce68402..075af2e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ version control and team collaboration. * nasher uses json or [NWNT](https://github.com/WilliamDraco/NWNT) for its text file format. -This guide is current as of nasher release 0.17.x. +This guide is current as of nasher release 0.19.x. * [Installation Options](#installation-options) * [Binary Releases](#binary-releases) @@ -353,6 +353,7 @@ Some fields, while optional, are inherited from the package by | `branch` | no | the git branch to use for source files | | `modName` | no | the name to give a module target file | | `modMinGameVersion` | no | the minimum game version to run a module target file | +| `modDescription` | no | the description for a module target file | #### `[target]` @@ -370,6 +371,7 @@ the [`[package]`](#package) section if they are not set for this target. | `branch` | no | yes | the git branch to use for source files | | `modName` | no | yes | the name to give a module target file | | `modMinGameVersion` | no | yes | the minimum game version to run a module target file | +| `modDescription` | no | yes | the description for a module target file | #### `[*.sources]` @@ -693,6 +695,10 @@ by passing the key/value pair as an option to the command. generated by the target. Only relevant when `convert` will be called. - default: "" - note: if blank, the version in the `module.ifo` file will be unchanged. +- `modDescription`: the description for a module file generated by a target. + Only relevant when `convert` will be called. + - default: "" + - note: If blank, the description in the `module.ifo` file will be unchanged. - `onMultipleSources`: an action to perform when multiple source files of the same name are found for a target. - default: `choose` @@ -856,11 +862,12 @@ separately unless you want to convert files without compiling and packing. #### Options -| Argument | Description | -| --- | --- | -| `--clean` | clears the cache before packing | -| `--modName` | sets the `Mod_Name` value in `module.ifo` | -| `--modMinGameVersion` | sets the `Mod_MinGameVersion` value in `module.ifo` | +| Argument | Description | +| --- | --- | +| `--clean` | clears the cache before packing | +| `--modName:` | sets the `Mod_Name` value in `module.ifo` to `` | +| `--modMinGameVersion:` | sets the `Mod_MinGameVersion` value in `module.ifo` to `` | +| `--modDescription:` | sets the `Mod_Description` value in `module.ifo` to `` | #### Examples @@ -956,6 +963,7 @@ run it separately unless you want to pack files without installing. | `--noCompile` | do not recompile updated scripts | | `--modName:` | sets the `Mod_Name` value in `module.ifo` to `` | | `--modMinGameVersion:` | sets the `Mod_MinGameVersion` value in `module.ifo` to `` | +| `--modDescription:` | sets the `Mod_Description` value in `module.ifo` to `` | | `--abortOnCompileError` | abort packing if errors encountered during compilation | #### Examples @@ -1002,6 +1010,7 @@ the module (`.mod`) file. | `--installDir:` | the location of the NWN user directory | | `--modName:` | sets the `Mod_Name` value in `module.ifo` to `` | | `--modMinGameVersion:` | sets the `Mod_MinGameVersion` value in `module.ifo` to `` | +| `--modDescription:` | sets the `Mod_Description` value in `module.ifo` to `` | | `--abortOnCompileError` | abort installation if errors encountered during compilation | #### Examples @@ -1040,6 +1049,7 @@ command is only valid for module targets. | `--installDir:` | the location of the NWN user directory | | `--modName:` | sets the `Mod_Name` value in `module.ifo` to `` | | `--modMinGameVersion:` | sets the `Mod_MinGameVersion` value in `module.ifo` to `` | +| `--modDescription:` | sets the `Mod_Description` value in `module.ifo` to `` | | `--abortOnCompileError` | abort launching if errors encountered during compilation | | `--gameBin:` | path to the `nwmain` binary file | | `--serverBin:` | path to the `nwserver` binary file | diff --git a/nasher.nimble b/nasher.nimble index 5c39f2d..e276866 100644 --- a/nasher.nimble +++ b/nasher.nimble @@ -1,6 +1,6 @@ # Package -version = "0.18.2" +version = "0.19.0" author = "Michael A. Sinclair" description = "A build tool for Neverwinter Nights projects" license = "MIT"