1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2017-2023 David Thompson dthompson2@worcester.edu
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
A copy of the license is also available from the Free Software
Foundation Web site at http://www.gnu.org/licenses/fdl.html.
* Chickadee: (chickadee). Game programming toolkit for Guile.
The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
-->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Invoking chickadee bundle (The Chickadee Game Toolkit)</title>
<meta name="description" content="Invoking chickadee bundle (The Chickadee Game Toolkit)" />
<meta name="keywords" content="Invoking chickadee bundle (The Chickadee Game Toolkit)" />
<meta name="resource-type" content="document" />
<meta name="distribution" content="global" />
<meta name="Generator" content="makeinfo" />
<link href="index.html" rel="start" title="Top" />
<link href="Index.html" rel="index" title="Index" />
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents" />
<link href="Command-Line-Interface.html" rel="up" title="Command Line Interface" />
<link href="Live-Coding.html" rel="next" title="Live Coding" />
<link href="Invoking-chickadee-play.html" rel="prev" title="Invoking chickadee play" />
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
@media (min-width: 1140px) {
body {
margin-left: 14rem;
margin-right: 4rem;
max-width: 52rem;
}
}
@media (min-width: 800px) and (max-width: 1140px) {
body {
margin-left: 6rem;
margin-right: 4rem;
max-width: 52rem;
}
}
@media (max-width: 800px) {
body {
margin: 1rem;
}
}
-->
</style>
<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css" />
</head>
<body lang="en">
<span id="Invoking-chickadee-bundle"></span><div class="header">
<p>
Previous: <a href="Invoking-chickadee-play.html" accesskey="p" rel="prev">Invoking chickadee play</a>, Up: <a href="Command-Line-Interface.html" accesskey="u" rel="up">Command Line Interface</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr />
<span id="Invoking-chickadee-bundle-1"></span><h3 class="section">3.2 Invoking <code>chickadee bundle</code></h3>
<p>Distributing games is difficult. While Chickadee games are free
software, it would be far too burdensome on the player to ask them to
compile a game from source in order to try it out. Many potential
players will simply not even try. Players expect to be able to
download a compressed archive, extract it, and play. If there are any
more steps than that then the chances of the game being played drop
dramatically. If you can’t beat ’em, join ’em. The
<code>chickadee bundle</code> tool creates redistributable binary bundles
by combining the game code and assets with shared libraries and
executables from the host operating system.
</p>
<p>Bundling is currently only supported on Linux. In the future, it may
be possible to bundle on MacOS. Patches very much welcome for that.
</p>
<p>It should be noted that bundling is a problematic way to distribute
software. All of the libraries that the bundled application includes
are separated from the distribution that was so carefully making sure
that they stay up-to-date with regard to security patches. The
bundled libraries are frozen in time, vulnerabilities and all.
Unfortunately, the release model used by the most popular
distributions, while wonderful for stable, mature software, does not
fit the needs of game distribution at all. So, we compromise, knowing
that most games are only played for only a short amount of time before
being disposed. Perhaps, in time, the Linux world will shift to using
more robust package management solutions such as
<a href="https://guix.gnu.org">GNU Guix</a> which support long-term
maintenance of stable software as well as the “fire and forget”
nature of game releases. And maybe a game made with Chickadee will
become so popular that major distributions decide to package it, but
let’s get back to reality.
</p>
<p>To get started with bundling, simply add a <samp>bundle.scm</samp> file to
the root of the project directory. It could look something like this:
</p>
<div class="lisp">
<pre class="lisp"><span class="syntax-symbol">'</span><span class="syntax-open">(</span><span class="syntax-open">(</span><span class="syntax-symbol">asset-directories</span> <span class="syntax-symbol">.</span> <span class="syntax-open">(</span><span class="syntax-string">"images"</span> <span class="syntax-string">"models"</span><span class="syntax-close">)</span><span class="syntax-close">)</span>
<span class="syntax-open">(</span><span class="syntax-symbol">bundle-name</span> <span class="syntax-symbol">.</span> <span class="syntax-string">"the-legend-of-emacs-1.0"</span><span class="syntax-close">)</span>
<span class="syntax-open">(</span><span class="syntax-symbol">code</span> <span class="syntax-symbol">.</span> <span class="syntax-string">"the-legend-of-emacs.scm"</span><span class="syntax-close">)</span>
<span class="syntax-open">(</span><span class="syntax-symbol">launcher-name</span> <span class="syntax-symbol">.</span> <span class="syntax-string">"the-legend-of-emacs"</span><span class="syntax-close">)</span><span class="syntax-close">)</span>
</pre></div>
<p>To create the bundle, simply run <code>chickadee bundle</code>. Upon
success, the file <samp>the-legend-of-emacs-1.0.tar.gz</samp> would be
created in the current directory.
</p>
<p>To maximize the chances that the bundle will work on someone else’s
computer, it’s best to build on the oldest supported Linux
distribution available. As of this writing, Ubuntu 18.04 LTS is a
good choice.
</p>
<p>In addition to including system libraries and executables,
<code>chickadee bundle</code> also includes the compiled Guile bytecode
(the <samp>.go</samp> files) for all modules used by the game. The module
source files are <em>not</em> included, so it’s critical that all of the
modules used by the game have been compiled.
</p>
<p>Available options:
</p>
<ul>
<li> <code>asset-directories</code>
<p>A list of directories that hold static game assets such as images or
audio. Files in these directories will be copied into the bundle
archive.
</p>
</li><li> <code>binary-directories</code>
<p>A list of directories to search for system binaries, such as
<code>guile</code>. By default, <samp>/usr/bin</samp> is searched.
</p>
</li><li> <code>bundle-name</code>
<p>The name of the bundle archive. By default, the name is
<code>"chickadee-bundle"</code>.
</p>
</li><li> <code>launcher-name</code>
<p>The name of the launcher script. By default, the name is
<code>"launch-game"</code>.
</p>
</li><li> <code>libraries</code>
<p>A list of shared libraries to include in the bundle. By default, all
of the libraries necessary for running Guile, Guile-SDL2, and
Chickadee are included. This list is compatible with the names given
to the libraries on Ubuntu, which may be different than on other
distributions. In such cases, this list will need to be customized.
See below for more information on the <code>%default-config</code> variable
that can be of help.
</p>
</li><li> <code>library-directories</code>
<p>A list of directories to search for system shared libraries. By
default, the list contains common directories used by most
distributions.
</p>
</li><li> <code>method</code>
<p>The method by which the game is launched. Can be either <code>play</code>
or <code>manual</code>. The default is <code>play</code>, which means that
<code>chickadee play</code> will be used to launch the game. For games
that do not use <code>chickadee play</code>, opting to start the game
loop on their own, the <code>manual</code> method should be used.
</p>
</li><li> <code>play-args</code>
<p>A list of command line arguments to pass to <code>chickadee play</code>.
Only used when the <code>method</code> option is set to <code>play</code>.
</p>
</li></ul>
<p>Default configuration options, such as the list of C shared libaries,
can be found in the <code>%default-config</code> variable. This way they
can be programatically modified, if necessary.
</p>
<dl>
<dt id="index-_0025default_002dconfig">Variable: <strong>%default-config</strong></dt>
<dd><p>An association list of default configuration options.
</p></dd></dl>
<hr />
<div class="header">
<p>
Previous: <a href="Invoking-chickadee-play.html" accesskey="p" rel="prev">Invoking chickadee play</a>, Up: <a href="Command-Line-Interface.html" accesskey="u" rel="up">Command Line Interface</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
