diff options
| -rw-r--r-- | .gitignore | 10 | ||||
| -rw-r--r-- | COPYING | 202 | ||||
| -rw-r--r-- | Makefile.am | 29 | ||||
| -rw-r--r-- | README.md | 53 | ||||
| -rw-r--r-- | assets/images/chickadee.png | bin | 0 -> 755 bytes | |||
| -rwxr-xr-x | bootstrap.sh | 3 | ||||
| -rw-r--r-- | bundle.scm | 4 | ||||
| -rw-r--r-- | configure.ac | 17 | ||||
| -rw-r--r-- | game/main.scm | 38 | ||||
| -rw-r--r-- | guix.scm | 29 | ||||
| -rw-r--r-- | pre-inst-env.in | 10 | ||||
| -rwxr-xr-x | scripts/run-game | 3 |
12 files changed, 398 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9148070 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +*.go +/Makefile +/Makefile.in +/aclocal.m4 +/autom4te.cache/ +/build-aux/ +/config.log +/config.status +/configure +/pre-inst-env @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..024fc0e --- /dev/null +++ b/Makefile.am @@ -0,0 +1,29 @@ +GOBJECTS = $(SOURCES:%.scm=%.go) +nobase_mod_DATA = $(SOURCES) +nobase_go_DATA = $(GOBJECTS) + +# Make sure source files are installed first, so that the mtime of +# installed compiled files is greater than that of installed source +# files. See +# <http://lists.gnu.org/archive/html/guile-devel/2010-07/msg00125.html> +# for details. +guile_install_go_files = install-nobase_goDATA +$(guile_install_go_files): install-nobase_modDATA + +CLEANFILES = $(GOBJECTS) +GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat +SUFFIXES = .scm .go +.scm.go: + $(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) compile $(GUILE_WARNINGS) -o "$@" "$<" + +moddir=$(prefix)/share/guile/site/$(GUILE_EFFECTIVE_VERSION) +godir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache + +SOURCES = \ + game/main.scm + +EXTRA_DIST = \ + $(SOURCES) \ + assets/images/chickadee.png \ + COPYING \ + README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f0e71c --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Chickadee Game Template + +This repository provides a template to use as a starting point for +making a new game using +[Chickadee](https://dthompson.us/projects/chickadee.html)! It +includes all the autotools boilerplate so you don't have to worry +about that nonsense too much. + +## Using Guix + +We *highly recommend* using [Guix](https://guix.gnu.org/) to manage +your development environment. Once Guix is installed, getting all of +the dependencies you need to develop is *easy*. Just run `guix shell` +from the root directory of this repository and you'll be good to go! + +## Building from source + +Assuming Guile and Chickadee are installed on your system, a fresh +project can be built like so: + +``` +./boostrap.sh +./configure +make -j$(nproc) +``` + +After the build system is initialized, only `make` needs to be run to +recompile the Scheme modules. + +## Running the game + +To run the game from the source checkout, use the `pre-inst-env` wrapper script: + +``` +./pre-inst-env run-game +``` + +## REPL-driven development + +After the game is launched, a Guile REPL server will be running on +port 37146. We recommend using the +[Geiser](https://geiser.nongnu.org/) Emacs extension for connecting to +it using `M-x connect-to-guile`. Once Geiser connects to the REPL, +the game can be modified while it runs! + +## Bundling + +If you are setup to produce redistributable bundles of Chickadee games +(see +https://dthompson.us/manuals/chickadee/Invoking-chickadee-bundle.html), +then you can use `chickadee bundle` to produce binary release bundles. +This is admittedly an area where things really do not "just work" as +they should, so do reach out for help if you need it. diff --git a/assets/images/chickadee.png b/assets/images/chickadee.png Binary files differnew file mode 100644 index 0000000..17a35e0 --- /dev/null +++ b/assets/images/chickadee.png diff --git a/bootstrap.sh b/bootstrap.sh new file mode 100755 index 0000000..9b9eaf0 --- /dev/null +++ b/bootstrap.sh @@ -0,0 +1,3 @@ +#!/bin/sh + +exec autoreconf -vif diff --git a/bundle.scm b/bundle.scm new file mode 100644 index 0000000..59d3b4a --- /dev/null +++ b/bundle.scm @@ -0,0 +1,4 @@ +'((asset-directories . ("assets/images")) + (bundle-name . "chickadee-game-template-0.1.0-x86_64") + (code . "game/main.scm") + (launcher-name . "chickadee-game-template")) diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..65d48cc --- /dev/null +++ b/configure.ac @@ -0,0 +1,17 @@ +dnl -*- Autoconf -*- + +AC_INIT(chickadee-game-template, 0.1.0) +AC_CONFIG_SRCDIR(game) +AC_CONFIG_AUX_DIR([build-aux]) +AM_INIT_AUTOMAKE([foreign -Woverride -Wno-portability]) +AM_SILENT_RULES([yes]) + +AC_CONFIG_FILES([Makefile]) +AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env]) + +GUILE_PKG([3.0]) +GUILE_PROGS + +GUILE_MODULE_REQUIRED([chickadee]) + +AC_OUTPUT diff --git a/game/main.scm b/game/main.scm new file mode 100644 index 0000000..d2ee993 --- /dev/null +++ b/game/main.scm @@ -0,0 +1,38 @@ +;;; Licensed under the Apache License, Version 2.0 (the "License"); +;;; you may not use this file except in compliance with the License. +;;; You may obtain a copy of the License at +;;; +;;; http://www.apache.org/licenses/LICENSE-2.0 +;;; +;;; Unless required by applicable law or agreed to in writing, software +;;; distributed under the License is distributed on an "AS IS" BASIS, +;;; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +;;; See the License for the specific language governing permissions and +;;; limitations under the License. + +(define-module (game main) + #:use-module (chickadee) + #:use-module (chickadee math vector) + #:use-module (chickadee graphics sprite) + #:use-module (chickadee graphics texture) + #:use-module (system repl coop-server) + #:export (launch-game)) + +(define sprite-position (vec2 256.0 176.0)) +(define sprite-texture #f) +(define repl #f) + +(define (load) + (set! sprite-texture (load-image "assets/images/chickadee.png")) + (set! repl (spawn-coop-repl-server))) + +(define (update _dt) + (poll-coop-repl-server repl)) + +(define (draw _alpha) + (draw-sprite sprite-texture sprite-position)) + +(define (launch-game args) + (run-game #:load load + #:update update + #:draw draw)) diff --git a/guix.scm b/guix.scm new file mode 100644 index 0000000..4399b8a --- /dev/null +++ b/guix.scm @@ -0,0 +1,29 @@ +(use-modules (guix packages) + ((guix licenses) #:prefix license:) + (guix download) + (guix git) + (guix build-system gnu) + (guix utils) + (gnu packages) + (gnu packages autotools) + (gnu packages guile) + (gnu packages game-development) + (gnu packages pkg-config)) + +(package + (name "chickadee-game-template") + (version "0.1.0-git") + (source (git-checkout (url (dirname (current-filename))))) + (build-system gnu-build-system) + (arguments + '(#:make-flags '("GUILE_AUTO_COMPILE=0"))) + (native-inputs + (list autoconf automake pkg-config)) + (inputs + (list guile-3.0)) + (propagated-inputs + (list guile-chickadee)) + (synopsis "Chickadee game template") + (description "This is an example package for a Chickadee game.") + (home-page "https://dthompson.us/projects/chickadee.html") + (license license:asl2.0)) diff --git a/pre-inst-env.in b/pre-inst-env.in new file mode 100644 index 0000000..881f142 --- /dev/null +++ b/pre-inst-env.in @@ -0,0 +1,10 @@ +#!/bin/sh + +abs_top_srcdir="`cd "@abs_top_srcdir@" > /dev/null; pwd`" +abs_top_builddir="`cd "@abs_top_builddir@" > /dev/null; pwd`" + +export GUILE_LOAD_COMPILED_PATH="$abs_top_builddir${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_LOAD_COMPILED_PATH" +export GUILE_LOAD_PATH="$abs_top_builddir:$abs_top_srcdir${GUILE_LOAD_PATH:+:}:$GUILE_LOAD_PATH" +export PATH="$abs_top_builddir/scripts:$PATH" + +exec "$@" diff --git a/scripts/run-game b/scripts/run-game new file mode 100755 index 0000000..3be3551 --- /dev/null +++ b/scripts/run-game @@ -0,0 +1,3 @@ +#!/bin/sh + +exec guile -c '(use-modules (game main)) (launch-game (command-line))' |
