diff --git a/src/cli_args.rs b/src/cli_args.rs index ddc5234a332d068443d38bb0dbe1fe0c0d00377a..1177319a0a006dd9feca9256d195cb22e6d76c18 100644 --- a/src/cli_args.rs +++ b/src/cli_args.rs @@ -9,7 +9,7 @@ use crate::{load_image, Format}; /// Crunch is a set of utilities for quickly and easily processing a batch of files, either directly /// or by defining pipelines #[derive(Parser, Debug, Clone, Serialize, Deserialize)] -#[clap(name = "Crunch")] +#[clap(name = "crunch")] #[clap(author = "Louis Capitanchik <louis@microhacks.co.uk>")] #[clap(version = "0.5.0-beta.1")] #[clap(about, long_about = None)] diff --git a/src/commands/flip.rs b/src/commands/flip.rs index 787c1d72378fe5e93ccd39d22ef13e5c1c12087f..19ac07367c67a0eeb02fc2c146a52c7bb54ac9a9 100644 --- a/src/commands/flip.rs +++ b/src/commands/flip.rs @@ -13,14 +13,14 @@ pub enum FlipDirection { Both, } -/// Rotate an image clockwise by the given degree +/// Flip an image along one or more axis #[derive(Debug, Clone, Parser, Serialize, Deserialize)] #[clap(author, version = "0.3.0")] pub struct Flip { - /// The path to the spritesheet file + /// The path to the image file #[serde(default)] pub input: String, - /// The path to write the extruded spritesheet + /// The path to write the flipped image #[serde(default)] pub output: String, diff --git a/src/commands/palette.rs b/src/commands/palette.rs index 0c489a8eb710d2ba516032f5665beab7510d5025..60c90037adc92ce12f10934e693126c9e23dc04c 100644 --- a/src/commands/palette.rs +++ b/src/commands/palette.rs @@ -38,10 +38,10 @@ pub fn sort_by_hue(palette: &mut PixelPalette) { #[derive(Parser, Clone, Serialize, Deserialize, Debug)] #[clap(author, version = "0.3.0")] pub struct Palette { - /// The path to the spritesheet file + /// The path to the image file #[serde(default)] pub input: String, - /// The path to write the extruded spritesheet + /// The path to write the palette data #[serde(default)] pub output: String, diff --git a/src/commands/pipeline.rs b/src/commands/pipeline.rs index 724e336653ddfa1cbf0065978fee300dc7926729..a538fc50bb968cc1a8cc708b7c32d71955308933 100644 --- a/src/commands/pipeline.rs +++ b/src/commands/pipeline.rs @@ -49,7 +49,7 @@ pub struct PipelineFile { pub pipelines: Vec<PipelineType>, } -/// Rotate an image clockwise by the given degree +/// Execute a predefined pipeline #[derive(Debug, Clone, Parser, Serialize, Deserialize)] #[clap(author, version = "0.3.0")] pub struct Pipeline { diff --git a/src/commands/remap.rs b/src/commands/remap.rs index 8e34444dca8ab63bd79dd576593726c7e8adc6c7..342999a172a5984969b8efc141c1f97cc59173ef 100644 --- a/src/commands/remap.rs +++ b/src/commands/remap.rs @@ -6,14 +6,14 @@ use serde::{Deserialize, Serialize}; use crate::utils::{new_image, BasicRgba, OutputFormat, TypedOutputFormat}; -/// Rotate an image clockwise by the given degree +/// Convert the colour space of an image to that of a given palette file #[derive(Debug, Clone, Parser, Serialize, Deserialize)] #[clap(author, version = "0.3.0")] pub struct Remap { - /// The path to the spritesheet file + /// The path to the image file #[serde(default)] pub input: String, - /// The path to write the extruded spritesheet + /// The path to write the recoloured image #[serde(default)] pub output: String, diff --git a/src/commands/scale.rs b/src/commands/scale.rs index f9933fff342b7fc4b2f87d9ebaddd59f7a6f2262..5f3b2c8fd18c42b5a9f02da5c47268fe8b4807f5 100644 --- a/src/commands/scale.rs +++ b/src/commands/scale.rs @@ -9,14 +9,14 @@ fn one() -> f32 { 1.0 } -/// Rotate an image clockwise by the given degree +/// Resize an image by a scale factor #[derive(Debug, Clone, Parser, Serialize, Deserialize)] #[clap(author, version = "0.3.0")] pub struct Scale { - /// The path to the spritesheet file + /// The path to the image file #[serde(default)] pub input: String, - /// The path to write the extruded spritesheet + /// The path to write the scaled image #[serde(default)] pub output: String,