Skip to content

Latest commit

 

History

History
140 lines (109 loc) · 5.46 KB

README.md

File metadata and controls

140 lines (109 loc) · 5.46 KB

Red Horizon

Build Status GitHub Release

This repository is an archive of work I started several years ago to attempt to recreate the orignal 2D Command & Conquer (C&C) games. The most useful outcome of this project has been a set of file conversion tools and working code examples of how to decode/encode various file formats from those games.

While I don't think I have the time any more to fulfil the original goal of running the original Red Alert campaign missions with this (there's that C&C Remaster project now!), I update this project every so often when I feel the urge to work on smaller things like graphics rendering, playing sounds, creating good CLI tools, and general software architecture for games as opposed to my day-to-day which is web development.

These smaller goals can be observed as milestones on GitHub, so you can follow along there.

Installation

Requires Java 11+ on macOS 10.12+ (Sierra+) or Windows 10 64-bit.

Download the distribution bundle from the project releases page, then unzip it to somewhere on your computer.

CLI Tools

convert

The main file conversion utility under which more specialized converters exist as subcommands.

Usage: convert [-hV] COMMAND
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.
Commands:
  pcx2cps  Convert a PCX file to a Command & Conquer CPS file
  png2shp  Convert a paletted PNG file to a Command & Conquer SHP file

convert pcx2cps

Usage: convert pcx2cps <sourceFile> <destFile>
Convert a PCX file to a Command & Conquer CPS file
      <sourceFile>   A 320x200 PCX image.  If creating a paletted CPS, then the
                       PCX file must have an internal palette.
      <destFile>     Path for the CPS file to be written to.

convert png2shp

Usage: convert png2shp -h=<height> -n=<numImages> -w=<width> <sourceFile>
                       <destFile>
Convert a paletted PNG file to a Command & Conquer SHP file
      <sourceFile>        The sounce PNG image.
      <destFile>          Path for the SHP file to be written to.
  -h, --height=<height>   Height of each SHP image
  -n, --numImages=<numImages>
                          The number of images for the SHP file
  -w, --width=<width>     Width of each SHP image

mix

A MIX file reader for extracting files from them.

Usage: mix [-hV] <mixFile> <entryName>
Extract an entry from a mix file, saving it to disk with the same name.
      <mixFile>     Path to the mix file to read
      <entryName>   Name of the entry in the mix file
  -h, --help        Show this help message and exit.
  -V, --version     Print version information and exit.

play

A media player for viewing or playing back various C&C media formats.

Usage: play [-hV] [--filter] [--fix-aspect-ratio] [--full-screen]
            [--scale-low-res] [--scanlines] [--palette=<paletteType>] <file>
            [<entryName>]
      <file>               Path to the input file to play/view
      [<entryName>]        If <file> is a mix file, this is the name of the
                             entry in the mix file to play
      --filter             Use nearest-neighbour filtering to smooth the
                             appearance of images
      --fix-aspect-ratio   Adjust the aspect ratio for modern displays
      --full-screen        Run in fullscreen mode
  -h, --help               Show this help message and exit.
      --palette=<paletteType>
                           Which game palette to apply to a paletted image.
                             One of "RA" or "TD".
      --scale-low-res      Double the output resolution of low-res animations
                             and videos (320x200 or lower).  Useful in
                             conjunction with filtering so that the result is
                             still filtered but less blurry.
      --scanlines          Add scanlines to the image, emulating the look of
                             images on CRT displays
  -V, --version            Print version information and exit.

Demo of WSA (animation format) playback on YouTube:

Red Horizon - Play WSA file demo

Demo of VQA (video format) playback on YouTube

view

Unit/structure viewer. Currently supports only a handful of units; those which I have built configuration files for.

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
  -h, --help          Show this help message and exit.
      --palette=<paletteType>
                      Which game palette to apply to a paletted image.  One of
                        "RA" or "TD".
  -V, --version       Print version information and exit.

Demo of the unit viewer on YouTube