.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Module::Build::SDL 3pm"
.TH Module::Build::SDL 3pm "2020-11-09" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Module::Build::SDL \- Module::Build subclass for building SDL apps/games [not stable yet]
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
When creating a new \s-1SDL\s0 application/game you can create Build.PL like this:
.PP
.Vb 1
\& use Module::Build::SDL;
\&   
\& my $builder = Module::Build::SDL\->new(
\&     module_name   => \*(AqGames::Demo\*(Aq,
\&     dist_version  => \*(Aq1.00\*(Aq,
\&     dist_abstract => \*(AqDemo game based on Module::Build::SDL\*(Aq,
\&     dist_author   => \*(Aqcoder@cpan.org\*(Aq,
\&     license       => \*(Aqperl\*(Aq,
\&     requires      => {
\&         \*(AqSDL\*(Aq     => 0,
\&     },
\&     #+ others Module::Build options
\& )\->create_build_script();
.Ve
.PP
Once you have created a \s-1SDL\s0 application/game via Module::Build::SDL as described
above you can use some extra build targets/actions:
.IP "\(bu" 4
you can create a \s-1PAR\s0 distribution like:
.Sp
.Vb 3
\& $ perl ./Build.PL
\& $ ./Build
\& $ ./Build par
.Ve
.Sp
There are some extra parameters related to 'par' action you can pass to Module::Build::SDL\->\fBnew()\fR:
.Sp
.Vb 4
\& parinput  => \*(Aqbin/scriptname.pl\*(Aq
\& paroutput => \*(Aqfilename.par.exe\*(Aq,
\& parlibs   => [ qw/SDL SDL_main SDL_gfx/ ],  #external libraries (.so/.dll) to be included into PAR
\& parmods   => [ qw/Module::A Module::B/ ],   #extra modules to be included into PAR
.Ve
.IP "\(bu" 4
to run the game from distribution directory you can use:
.Sp
.Vb 3
\& $ perl ./Build.PL
\& $ ./Build
\& $ ./Build run
.Ve
.IP "\(bu" 4
\&\s-1TODO:\s0 maybe some additional actions: parexe, parmsi, deb, rpm
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Module::Build::SDL is a subclass of Module::Build created
to make easy some tasks specific to \s-1SDL\s0 applications \- e.g. packaging \s-1SDL\s0
application/game into \s-1PAR\s0 archive.
.SH "APPLICATION/GAME LAYOUT"
.IX Header "APPLICATION/GAME LAYOUT"
Module::Build::SDL expects the following layout in project directory:
.PP
.Vb 9
\& #example: game with the main *.pl script + data files + modules (*.pm)
\& Build.PL
\& lib/
\&     Games/
\&           Demo.pm
\& bin/
\&     game\-script.pl
\& data/
\&     whatever_data_files_you_need.jpg
.Ve
.PP
the most simple game should look like:
.PP
.Vb 4
\& #example: simple one\-script apllication/game
\& Build.PL
\& bin/
\&    game\-script.pl
.Ve
.PP
In short \- there are 3 expected subdirectories:
.IP "\(bu" 4
\&\fBbin\fR \- one or more perl scripts (*.pl) to start the actual
application/game
.IP "\(bu" 4
\&\fBlib\fR \- application/game specific modules (*.pm) organized
in dir structure in \*(L"usual perl manners\*(R"
.IP "\(bu" 4
\&\fBdata\fR \- directory for storing application data (pictures, 
sounds etc.). This subdirectory is handled as a \*(L"ShareDir\*(R"
(see File::ShareDir for more details)
.IP "\(bu" 4
As the project is (or could be) composed as a standard perl
distribution it also support standard subdirectory \fB't'\fR (with tests).
.SH "RULES TO FOLLOW"
.IX Header "RULES TO FOLLOW"
When creating a \s-1SDL\s0 application/game based on Module::Build::SDL it is
recommended to follow these rules:
.IP "\(bu" 4
Use the name for your game from \fIGames::*\fR namespace; it will make
the later release to \s-1CPAN\s0 much easier.
.IP "\(bu" 4
Put all data files into \fBdata\fR subdirectory and access the \fBdata\fR
subdir only via File::ShareDir 
(namely by calling \fBdistdir()\fR function)
.IP "\(bu" 4
\&\s-1TODO:\s0 maybe add more