Package: guix-patches;
Reported by: Vinicius Monego <monego <at> posteo.net>
Date: Fri, 11 Jun 2021 00:55:01 UTC
Severity: normal
Tags: patch
Message #8 received at 48952 <at> debbugs.gnu.org (full text, mbox):
From: Vinicius Monego <monego <at> posteo.net> To: 48952 <at> debbugs.gnu.org Cc: Vinicius Monego <monego <at> posteo.net> Subject: [PATCH 1/3] build-system: Add godot-build-system. Date: Fri, 11 Jun 2021 00:55:44 +0000
* guix/build/godot-build-system.scm: New file.
* guix/build-system/godot.scm: New file.
* Makefile.am (MODULES): Add them here.
* doc/guix.texi (Build Systems): Document godot-build-system.
---
Makefile.am | 3 +
doc/guix.texi | 19 ++++
guix/build-system/godot.scm | 142 ++++++++++++++++++++++++++++++
guix/build/godot-build-system.scm | 113 ++++++++++++++++++++++++
4 files changed, 277 insertions(+)
create mode 100644 guix/build-system/godot.scm
create mode 100644 guix/build/godot-build-system.scm
diff --git a/Makefile.am b/Makefile.am
index aa21b5383b..2fbf1d1a13 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -15,6 +15,7 @@
# Copyright © 2018 Alex Vong <alexvong1995 <at> gmail.com>
# Copyright © 2019 Efraim Flashner <efraim <at> flashner.co.il>
# Copyright © 2021 Chris Marusich <cmmarusich <at> gmail.com>
+# Copyright © 2021 Vinicius Monego <monego <at> posteo.net>
#
# This file is part of GNU Guix.
#
@@ -145,6 +146,7 @@ MODULES = \
guix/build-system/copy.scm \
guix/build-system/glib-or-gtk.scm \
guix/build-system/gnu.scm \
+ guix/build-system/godot.scm \
guix/build-system/guile.scm \
guix/build-system/haskell.scm \
guix/build-system/julia.scm \
@@ -201,6 +203,7 @@ MODULES = \
guix/build/gnu-bootstrap.scm \
guix/build/gnu-build-system.scm \
guix/build/gnu-dist.scm \
+ guix/build/godot-build-system.scm \
guix/build/guile-build-system.scm \
guix/build/maven-build-system.scm \
guix/build/node-build-system.scm \
diff --git a/doc/guix.texi b/doc/guix.texi
index 59b4ac11b4..430724be0a 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -90,6 +90,7 @@ Copyright @copyright{} 2020 Edgar Vincent@*
Copyright @copyright{} 2021 Maxime Devos@*
Copyright @copyright{} 2021 B. Wilson@*
Copyright @copyright{} 2021 Xinglu Chen@*
+Copyright @copyright{} 2021 Vinicius Monego@*
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -7751,6 +7752,24 @@ specified with the @code{#:glib} parameter.
Both phases are executed after the @code{install} phase.
@end defvr
+@defvr {Scheme Variable} godot-build-system
+This variable is exported by @code{(guix build-system godot)}. It implements
+the more or less standard build procedure used by Godot games.
+
+Projects may place @file{project.godot} in a subdirectory. This can be passed
+to @code{#:project-directory}. It defaults to the source root.
+
+Many projects do not ship with @file{exports_preset.cfg}. In that case, a
+custom template is created. If that file exists already, it is preferred.
+The name of the target preset is variable and can be specified with
+@code{#:export-name}. Defaults to ``Guix'' which is used in the custom
+template.
+
+It further creates a wrapper script in @code{bin/} which can be used to launch
+the game. The filename is configured by @code{#:game} and should be set to
+the name of the package. Desktop files must be created or copied manually.
+@end defvr
+
@defvr {Scheme Variable} guile-build-system
This build system is for Guile packages that consist exclusively of Scheme
code and that are so lean that they don't even have a makefile, let alone a
diff --git a/guix/build-system/godot.scm b/guix/build-system/godot.scm
new file mode 100644
index 0000000000..3362e71fbc
--- /dev/null
+++ b/guix/build-system/godot.scm
@@ -0,0 +1,142 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2021 Vinicius Monego <monego <at> posteo.net>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (guix build-system godot)
+ #:use-module (guix store)
+ #:use-module (guix utils)
+ #:use-module (guix memoization)
+ #:use-module (guix packages)
+ #:use-module (guix derivations)
+ #:use-module (guix search-paths)
+ #:use-module (guix build-system)
+ #:use-module (guix build-system gnu)
+ #:use-module (ice-9 match)
+ #:use-module (srfi srfi-1)
+ #:use-module (srfi srfi-26)
+ #:export (%godot-build-system-modules
+ default-godot
+ godot-build
+ godot-build-system))
+
+(define (default-godot)
+ "Return the default Godot package."
+ ;; Lazily resolve the binding to avoid a circular dependency.
+ (let ((module (resolve-interface '(gnu packages game-development))))
+ (module-ref module 'godot)))
+
+(define %godot-build-system-modules
+ ;; Build-side modules imported by default.
+ `((guix build godot-build-system)
+ ,@%gnu-build-system-modules))
+
+(define* (lower name
+ #:key source inputs native-inputs outputs system target
+ (godot (default-godot))
+ #:allow-other-keys
+ #:rest arguments)
+ "Return a bag for NAME."
+ (define private-keywords
+ '(#:source #:inputs #:native-inputs #:target))
+
+ (and (not target) ;XXX: no cross-compilation
+ (bag
+ (name name)
+ (system system)
+ (host-inputs `(,@(if source
+ `(("source" ,source))
+ '())
+ ("godot" ,godot)
+ ,@inputs
+
+ ;; Keep the standard inputs of 'gnu-build-system'.
+ ,@(standard-packages)))
+ (build-inputs `(("godot-headless" ,godot "headless")
+ ,@native-inputs))
+ (outputs outputs)
+ (build godot-build)
+ (arguments (strip-keyword-arguments private-keywords arguments)))))
+
+(define* (godot-build store name inputs
+ #:key
+ (phases '(@ (guix build godot-build-system)
+ %standard-phases))
+ (configure-flags ''())
+ (outputs '("out"))
+ (output "out")
+
+ ;; Name of the wrapper script and pck file.
+ ;; Usually the same name of the package.
+ (game "game")
+
+ ;; Directory where project.godot is located.
+ (project-directory ".")
+
+ ;; Name for the export target.
+ (export-name "Guix")
+
+ (search-paths '())
+ (system (%current-system))
+ (guile #f)
+ (imported-modules %godot-build-system-modules)
+ (modules '((guix build godot-build-system)
+ (guix build utils))))
+ "Build SOURCE using GODOT, and with INPUTS."
+ (define builder
+ `(begin
+ (use-modules ,@modules)
+ (godot-build #:name ,name
+ #:source ,(match (assoc-ref inputs "source")
+ (((? derivation? source))
+ (derivation->output-path source))
+ ((source)
+ source)
+ (source
+ source))
+ #:configure-flags ,configure-flags
+ #:system ,system
+ #:phases ,phases
+ #:game ,game
+ #:project-directory ,project-directory
+ #:export-name ,export-name
+ #:outputs %outputs
+ #:output ,output
+ #:search-paths ',(map search-path-specification->sexp
+ search-paths)
+ #:inputs %build-inputs)))
+
+ (define guile-for-build
+ (match guile
+ ((? package?)
+ (package-derivation store guile system #:graft? #f))
+ (#f ; the default
+ (let* ((distro (resolve-interface '(gnu packages commencement)))
+ (guile (module-ref distro 'guile-final)))
+ (package-derivation store guile system #:graft? #f)))))
+
+ (build-expression->derivation store name builder
+ #:inputs inputs
+ #:system system
+ #:modules imported-modules
+ #:outputs outputs
+ #:guile-for-build guile-for-build))
+
+(define godot-build-system
+ (build-system
+ (name 'godot)
+ (description "The Godot build system")
+ (lower lower)))
diff --git a/guix/build/godot-build-system.scm b/guix/build/godot-build-system.scm
new file mode 100644
index 0000000000..e72ae9db14
--- /dev/null
+++ b/guix/build/godot-build-system.scm
@@ -0,0 +1,113 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2021 Vinicius Monego <monego <at> posteo.net>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (guix build godot-build-system)
+ #:use-module ((guix build gnu-build-system) #:prefix gnu:)
+ #:use-module (guix build utils)
+ #:use-module (ice-9 match)
+ #:use-module (ice-9 format)
+ #:use-module (ice-9 ftw)
+ #:use-module (srfi srfi-1)
+ #:use-module (srfi srfi-26)
+ #:export (%standard-phases
+ godot-build))
+
+(define* (configure #:key project-directory #:allow-other-keys)
+
+ ;; Projects may have the 'project.godot' file in different directories. The
+ ;; project-directory key contains the path string to the directory where it
+ ;; is located.
+
+ (chdir project-directory)
+ (setenv "HOME" (getcwd))
+
+ ;; Not all projects ship with export_presets.cfg because it may contain
+ ;; confidential information such as CI keys. In that case, we check if
+ ;; this file exists, and if it doesn't we use this generic template below.
+ ;; There is ongoing effort to separate the keys from that file. See:
+ ;; https://github.com/godotengine/godot-demo-projects/issues/329 and
+ ;; https://github.com/godotengine/godot/pull/35930. Until that is fixed and
+ ;; developers start to provide the file, we have to use our own template.
+
+ (let ((export-presets "export_presets.cfg"))
+ (when (not (file-exists? export-presets))
+ (with-output-to-file export-presets
+ (lambda ()
+ (display
+ "[preset.0]
+
+name=\"Guix\"
+platform=\"Linux/X11\"
+runnable=true
+custom_features=\"\"
+export_filter=\"all_resources\"
+include_filter=\"\"
+exclude_filter=\"\"
+export_path=\"\"
+patch_list=PoolStringArray( )
+script_export_mode=1
+script_encryption_key=\"\"
+
+[preset.0.options]
+
+texture_format/bptc=false
+texture_format/s3tc=true
+texture_format/etc=false
+texture_format/etc2=false
+texture_format/no_bptc_fallbacks=true
+binary_format/64_bits=false
+binary_format/embed_pck=false
+custom_template/release=\"\"
+custom_template/debug=\"\""))))))
+
+(define* (build #:key inputs game export-name #:allow-other-keys)
+ (let ((godot (assoc-ref inputs "godot-headless")))
+ (invoke (string-append godot "/bin/godot_server")
+ "--export-pack" export-name (string-append game ".pck")
+ "project.godot")))
+
+(define* (install #:key inputs outputs game #:allow-other-keys)
+ (let* ((out (assoc-ref outputs "out"))
+ (bin (string-append out "/bin"))
+ (share (string-append out "/share"))
+ (data (string-append share "/" game))
+ (icons (string-append share "/icons/hicolor/256x256/apps")))
+ (install-file (string-append game ".pck") data)
+ (mkdir-p bin)
+ (call-with-output-file (string-append bin "/" game)
+ (lambda (port)
+ (format port
+ "#!/bin/sh~@
+ exec ~a/bin/godot --main-pack ~a/~a.pck~%"
+ (assoc-ref inputs "godot") data game)
+ (chmod port #o755)))
+ (mkdir-p icons)
+ (copy-file "icon.png" (string-append icons "/" game ".png"))))
+
+(define %standard-phases
+ (modify-phases gnu:%standard-phases
+ (delete 'bootstrap)
+ (replace 'configure configure)
+ (replace 'build build)
+ (delete 'check)
+ (replace 'install install)))
+
+(define* (godot-build #:key inputs (phases %standard-phases)
+ #:allow-other-keys #:rest args)
+ "Build the given Godot package, applying all of PHASES in order."
+ (apply gnu:gnu-build #:inputs inputs #:phases phases args))
--
2.32.0
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.