IndieRunner::Cmdline(3p)

NAME
IndieRunner::Cmdline - parser for IndieRunner commandline arguments

SYNOPSIS
 use IndieRunner::Cmdline;

 # obtain hash for IndieRunner CLI configuration
 my %indierunner_config = IndieRunner::Cmdline::init_cli()

DESCRIPTION
IndieRunner::Cmdline provides subroutine init_cli() for use by a command-line client to configure IndieRunner.

SUBROUTINES

  init_cli()
Parse the commandline arguments and return a hash with the configuration. See "OPTIONS" for available flags.

OPTIONS

--help/-h
    Print a brief help message.

--directory=directory/-d directory
    Switch to directory.

--dllmap=file/-D file
    For use with Mono/FNA/XNA only: specify custom file with dllmap assignments.

--dryrun/-n
    Show actions that would be taken, without changing or executing anything.

--engine=engine/-e engine
    Bypass automatic engine detection. Use with caution.

--file=file/-f file
    Specify the main game file and bypass autodetection.

--game=game/-g game
    Bypass automatic game detection and run as game. Use with caution.

--man/-m
    Print the manual page and exit.

--norigg
    Disable rigg (only applicable if rigg is available on the system).

--permissive
    Use permissive unveil in rigg (only applicable if rigg is available on the system).

--script/-s
    Instead of launching the game, generate a shell script to take all the steps (experimental).

--strict
    Use strict unveil in rigg (only applicable if rigg is available on the system).

--usage
    Print short usage information.

--verbose/-v
    Enable verbose output.

--version/-V
    Print version.

-- game arguments
    Arguments after "--" are passed to the invocation of the game itself, via the key "game_args". Example: "-windowed -skipintro"

RETURN VALUE
init_cli returns a hash with the following keys:
  dir
  dllmap
  dryrun
  engine
  file
  game
  game_args
  use_rigg
  script
  verbosity

SEE ALSO
Getopt::Long IndieRunner Pod::Usage indierunner

AUTHOR
Thomas Frohwein <thfr@cpan.org>

COPYRIGHT
Copyright 2022-2024 by Thomas Frohwein <thfr@cpan.org>.

This program is free software; you can redistribute it and/or modify it under the ISC license.