Skip to content

Commit

Permalink
Update docs for 0.31.1
Browse files Browse the repository at this point in the history
  • Loading branch information
ultraq committed Jan 4, 2021
1 parent e440dae commit a9482e8
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 10 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
Changelog
=========

### 0.31.1
- Lean on Java's built-in blowfish cipher to replace the BlowfishJ library I'd
been using.
- Renamed the unit viewer to a general purpose object viewer, and gave it the
ability to view Red Alert mission maps. Currently only works with the
directory structure I have for local dev and doesn't work for interior maps.

### 0.31.0
- Converted the C/C++ code for reading encrypted MIX files to Groovy - no more
native platform compilers needed for supporting other platforms
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,19 +121,23 @@ Demo of WSA (animation format) playback on YouTube:

### view

Unit/structure viewer. Currently supports only a handful of units; those which
I have built configuration files for.
Unit/structure and map viewer. Currently supports only a handful of units -
those which I have built configuration files for - and non-interior theater
maps.

```
Usage: view [-hV] [--palette=<paletteType>] <file> [<entryName>]
<file> Path to the unit shp file to view, or a mix file that
contains the unit
[<entryName>] If <file> is a mix file, this is the name of the shp in
the mix file to view
Usage: view [-hV] [--full-screen] [--palette=<paletteType>] <file> [<entryName>]
<file> Path to the object file file to view, or a mix file that
contains the object
[<entryName>] If <file> is a mix file, this is the name of the object
in the mix file to view
--full-screen Run in fullscreen mode. Only applies to the mission
viewer.
-h, --help Show this help message and exit.
--palette=<paletteType>
Which game palette to apply to a paletted image. One of
"RA" or "TD".
"ra-snow", "ra-temperate", or "td-temperate". Defaults
to ra-temperate
-V, --version Print version information and exit.
```

Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ plugins {
// Global configuration
allprojects {
group = 'nz.net.ultraq.redhorizon'
version = '0.31.0'
version = '0.31.1'
}

// Root project configuration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ class ObjectViewer implements Callable<Integer> {
@Parameters(index = '1', arity = '0..1', description = 'If <file> is a mix file, this is the name of the object in the mix file to view')
String entryName

@Option(names = ['--full-screen'], description = 'Run in fullscreen mode')
@Option(names = ['--full-screen'], description = 'Run in fullscreen mode. Only applies to the mission viewer.')
boolean fullScreen

@Option(names = ['--palette'], defaultValue = 'ra-temperate', description = 'Which game palette to apply to a paletted image. One of "ra-snow", "ra-temperate", or "td-temperate". Defaults to ra-temperate')
Expand Down

0 comments on commit a9482e8

Please sign in to comment.