[bug#30443] [PATCH] Add colobot

[bug#30443] [PATCH] Add colobot

[Nicolas Goaziou]

[-- Attachment #1: Type: text/plain, Size: 187 bytes --]

Hello,

The following patch adds the educational game: Colobot (Gold Edition).

Feedback welcome.

Regards,

-- 
Nicolas Goaziou                                                0x80A93738

[-- Attachment #2: Add Colobot --]
[-- Type: text/x-diff, Size: 4689 bytes --]

From c924704e440118a1aeede1f237b56744967cab66 Mon Sep 17 00:00:00 2001
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Date: Tue, 13 Feb 2018 01:26:27 +0100
Subject: [PATCH] gnu: Add colobot.

* gnu/packages/games.scm (colobot): New variable.
---
 gnu/packages/games.scm | 86 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 85 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/games.scm b/gnu/packages/games.scm
index 286d0feef..9c3b7cfa8 100644
--- a/gnu/packages/games.scm
+++ b/gnu/packages/games.scm
@@ -32,7 +32,7 @@
 ;;; Copyright © 2017 Marius Bakke <mbakke@fastmail.com>
 ;;; Copyright © 2017 Rutger Helling <rhelling@mykolab.com>
 ;;; Copyright © 2017 Roel Janssen <roel@gnu.org>
-;;; Copyright © 2017 Nicolas Goaziou <mail@nicolasgoaziou.fr>
+;;; Copyright © 2017, 2018 Nicolas Goaziou <mail@nicolasgoaziou.fr>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -5549,3 +5549,87 @@ hacking the gamification of contribution graphs on platforms such as
 Github or Gitlab.")
     (home-page "https://github.com/umayr/badass")
     (license license:expat))))
+
+(define-public colobot
+  (package
+    (name "colobot")
+    (version "0.1.11-alpha")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append "https://github.com/colobot/colobot/archive/"
+                           "colobot-gold-" version ".tar.gz"))
+       (sha256
+        (base32
+         "160rq9fp5vd0qaqr3jvzvzrcxk9cac532y8vx4cvq0a8hgylrbad"))))
+    (build-system cmake-build-system)
+    (arguments
+     `(#:tests? #f                      ;no test
+       #:phases
+       (modify-phases %standard-phases
+         (add-after 'unpack 'unpack-data
+           (lambda* (#:key inputs #:allow-other-keys)
+             (let ((data (assoc-ref inputs "colobot-data")))
+               (invoke "tar" "-xvf" data "-Cdata" "--strip-components=1")
+               #t)))
+         (add-after 'unpack-data 'install-music
+           (lambda* (#:key inputs #:allow-other-keys)
+             ;; Installation process tries to download music files using
+             ;; "wget" if not already present.  Since we are going to install
+             ;; them, skip "wget" command check.
+             (substitute* "data/music/CMakeLists.txt"
+               (("find_program\\(WGET wget\\)") ""))
+             ;; Effectively install music.
+             (let ((data (assoc-ref inputs "colobot-music")))
+               (invoke "tar" "-xvf" data "-Cdata/music")
+               #t)))
+         (add-after 'install 'fix-install-directory
+           ;; Move binary from "games/" to "bin/".
+           (lambda* (#:key outputs #:allow-other-keys)
+             (let ((out (assoc-ref outputs "out")))
+               (rename-file (string-append out "/games")
+                            (string-append out "/bin"))
+               #t))))))
+    (native-inputs
+     `(("colobot-data"
+        ,(origin
+           (method url-fetch)
+           (uri (string-append
+                 "https://github.com/colobot/colobot-data/archive/"
+                 "colobot-gold-" version ".tar.gz"))
+           (sha256
+            (base32
+             "1pdpsyr41g7xmk03k2g76l214f53ahk04qnkzmsv1fdbbaq7p109"))))
+       ("colobot-music"
+        ,(origin
+           (method url-fetch)
+           ;; Music also exists in FLAC, with a cost of 230Mo.  It can later
+           ;; be converted using "oggenc" for a better sound quality.
+           (uri (string-append "https://colobot.info/files/music/"
+                               "colobot-music_ogg_" version ".tar.gz"))
+           (sha256
+            (base32
+             "1s86cd36rwkff329mb1ay1wi5qqyi35564ppgr3f4qqz9wj9vs2m"))))
+       ("gettext" ,gettext-minimal)
+       ("librsvg" ,librsvg)
+       ("po4a" ,po4a)
+       ("python" ,python-wrapper)))
+    (inputs
+     `(("boost" ,boost)
+       ("glew" ,glew)
+       ("libogg" ,libogg)
+       ("libpng" ,libpng)
+       ("libsndfile" ,libsndfile)
+       ("libvorbis" ,libvorbis)
+       ("openal" ,openal)
+       ("physfs" ,physfs)
+       ("sdl2" ,sdl2)
+       ("sdl2-image", sdl2-image)
+       ("sdl2-ttf" ,sdl2-ttf)))
+    (synopsis "Educational programming strategy game")
+    (description "Colobot: Gold Edition is a real-time strategy game, where
+you can program your units (bots) in a language called CBOT, which is similar
+to C++ and Java.  Your mission is to find a new planet to live and survive.
+You can save the humanity and get programming skills!")
+    (home-page "https://colobot.info")
+    (license license:gpl3+)))
-- 
2.16.1

[bug#30443] [PATCH] Add colobot

[Nicolas Goaziou]

> +       ("sdl2" ,sdl2)
> +       ("sdl2-image", sdl2-image)
                      ^^^^^
                 I will fix this typo.

[bug#30443] [PATCH] Add colobot

[Leo Famulari]

[-- Attachment #1: Type: text/plain, Size: 465 bytes --]

On Tue, Feb 13, 2018 at 02:08:54AM +0100, Nicolas Goaziou wrote:
> +           ;; Music also exists in FLAC, with a cost of 230Mo.  It can later
> +           ;; be converted using "oggenc" for a better sound quality.
> +           (uri (string-append "https://colobot.info/files/music/"
> +                               "colobot-music_ogg_" version ".tar.gz"))

I think this comment is mistaken. Audio quality cannot be improved by
transcoding to another format.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[bug#30443] [PATCH] Add colobot

[Leo Famulari]

[-- Attachment #1: Type: text/plain, Size: 463 bytes --]

On Tue, Feb 13, 2018 at 02:08:54AM +0100, Nicolas Goaziou wrote:
> Subject: [PATCH] gnu: Add colobot.
> 
> * gnu/packages/games.scm (colobot): New variable.

Thanks!

> +       ("sdl2" ,sdl2)
> +       ("sdl2-image", sdl2-image)
> +       ("sdl2-ttf" ,sdl2-ttf)))

I didn't try building or playing the game, but I know that SDL
dependencies often need to be provided in a union using the sdl-union
procedure. So, please make sure this is working :)

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[bug#30443] [PATCH] Add colobot

[Nicolas Goaziou]

Hello,

Leo Famulari <leo@famulari.name> writes:

> On Tue, Feb 13, 2018 at 02:08:54AM +0100, Nicolas Goaziou wrote:
>> +           ;; Music also exists in FLAC, with a cost of 230Mo.  It can later
>> +           ;; be converted using "oggenc" for a better sound quality.
>> +           (uri (string-append "https://colobot.info/files/music/"
>> +                               "colobot-music_ogg_" version ".tar.gz"))
>
> I think this comment is mistaken. Audio quality cannot be improved by
> transcoding to another format.

This is not what I meant. 

The game expects ogg files for its music. The package provides default
ogg files, of medium quality. If you want better audio quality, you can
download (lossless?) FLAC files instead and convert them to ogg files
with a better quality (and a lesser compression).

If this comment is confusing, I can remove it. I guess one doesn't play
this game for sound quality (even though some scores are nice).

WDYT?

Regards,

-- 
Nicolas Goaziou                                                0x80A93738

[bug#30443] [PATCH] Add colobot

[Nicolas Goaziou]

Hello,

Leo Famulari <leo@famulari.name> writes:

> On Tue, Feb 13, 2018 at 02:08:54AM +0100, Nicolas Goaziou wrote:
>> Subject: [PATCH] gnu: Add colobot.
>> 
>> * gnu/packages/games.scm (colobot): New variable.
>
> Thanks!
>
>> +       ("sdl2" ,sdl2)
>> +       ("sdl2-image", sdl2-image)
>> +       ("sdl2-ttf" ,sdl2-ttf)))
>
> I didn't try building or playing the game, but I know that SDL
> dependencies often need to be provided in a union using the sdl-union
> procedure. So, please make sure this is working :)

The game builds and is playable with the current patch. I tested it with

  guix environment --pure --ad-hoc colobot -- colobot

It also builds and is playable with sdl-union.

Regards,

-- 
Nicolas Goaziou                                                0x80A93738

[bug#30443] [PATCH] Add colobot

[Leo Famulari]

[-- Attachment #1: Type: text/plain, Size: 1091 bytes --]

On Tue, Feb 13, 2018 at 10:28:56PM +0100, Nicolas Goaziou wrote:
> >> +           ;; Music also exists in FLAC, with a cost of 230Mo.  It can later
> >> +           ;; be converted using "oggenc" for a better sound quality.
> >> +           (uri (string-append "https://colobot.info/files/music/"
> >> +                               "colobot-music_ogg_" version ".tar.gz"))
> >
> > I think this comment is mistaken. Audio quality cannot be improved by
> > transcoding to another format.
> 
> This is not what I meant. 
> 
> The game expects ogg files for its music. The package provides default
> ogg files, of medium quality. If you want better audio quality, you can
> download (lossless?) FLAC files instead and convert them to ogg files
> with a better quality (and a lesser compression).
> 
> If this comment is confusing, I can remove it. I guess one doesn't play
> this game for sound quality (even though some scores are nice).

The comment is confusing, but your reply to my question is not :)

So, I recommend either rewriting the comment or leaving it out.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

bug#30443: [PATCH] Add colobot

[Nicolas Goaziou]

Hello,

Leo Famulari <leo@famulari.name> writes:

> The comment is confusing, but your reply to my question is not :)
>
> So, I recommend either rewriting the comment or leaving it out.

I eventually left it out. I also used `sdl-union', just to be on the
safe side.

Thank you for the review.

Regards,

-- 
Nicolas Goaziou                                                0x80A93738