Bugzilla Bug 152367

Chris,

I'm currently retiring from Gentoo, as you may already know, and I'm packing up
my stuff. I had this in my local overlay, so I cleaned it up a bit and here it
is. This should close bug #83291 and bug #143362, but there's more thant just
that.

Changelog, compared to nwn-data-1.29/nwn-1.68 :
* More descriptive in terms of what CD is needed and when, in all possible
cases (nwn-data).
* Cleaned-up dependencies (nwn-data)
* Movies are now supported through nwmovies and BinkPlayer (nwn-data, nwn).
Installation is either from the CDs with USE="nowin" or from a previous
installation.
* All user data is now kept in ~/.nwn using nwuser (nwn-data, nwn).

Please find nwn-data-1.29-r1.ebuild, nwn-1.68-r1.ebuild and the new (backward
compatible) fixinstall below. Do not hesitate to contact me in case you have
any question.

Denis.

Created an attachment (id=100210) [details]
nwn-data-1.29-r1.ebuild

Created an attachment (id=100211) [details]
nwn-1.68-r1.ebuild

Created an attachment (id=100212) [details]
fixinstall

Sorry, I forgot on line in the changelog :

* nls USE flag for forcing the installation in english eventhough you have
LINGUAS set to one of the supported languages (quite a few users have
complained about this in the past). In this case you'd want to set USE="-nls"
for nwn-data and nwn in your /etc/portage/package.use.

Denis.

Ehh... I'll check these out.  I've been updating the nwn-data and nwn ebuilds
already for other reasons, so I'll see about incorporating these changes.  Of
course, it might be a while since I'm going to have to manually pull out the
changes by hand.

...and accept it so Mr_Bones_ doesn't bug me to do it later... ;]

(In reply to comment #5)
> Ehh... I'll check these out.  I've been updating the nwn-data and nwn ebuilds
> already for other reasons, so I'll see about incorporating these changes.  Of
> course, it might be a while since I'm going to have to manually pull out the
> changes by hand.

If you prefer a patch or would like me to incorporate these changes into your
ebuilds (in which case you'd have to send them to me), just say so. The sooner
the better, while it's still fresh in my lazy brain.

Denis.

Well, I added my ebuilds (masked) to the tree today.  If you have the time and
energy to make patches, I'd be all for it.  Otherwise, I'll get this
implemented before I unmask it, but it'll likely take a bit longer.

>>> Unpacking source...
sed: can't read /var/tmp/portage/games-rpg/nwn-data-1.29-r1/work/nwn/nwn: No
such file or directory

!!! ERROR: games-rpg/nwn-data-1.29-r1 failed.
Call stack:
  ebuild.sh, line 1568:   Called dyn_unpack
  ebuild.sh, line 708:   Called src_unpack
  nwn-data-1.29-r1.ebuild, line 415:   Called die

!!! sed nwn

(In reply to comment #8)
> Well, I added my ebuilds (masked) to the tree today.  If you have the time and
> energy to make patches, I'd be all for it.  Otherwise, I'll get this
> implemented before I unmask it, but it'll likely take a bit longer.

Great ! I'll have a look at them.

Denis.

Created an attachment (id=102331) [details]
Patch to change 2 'linugas' occurences into 'linguas'

Chris,

I have found what seems to be 2 typos in the nwn-data ebuild. Two 'linugas'
occurences that I suppose are actually 'linguas'. The patch above fixes those.

Also, I have started adding my stuff into your ebuilds, and I can't seem to
download some of the language files to remake the digests. They're neither on
Bioware's servers (or they're having issues since yesterday), or on our
mirrors. Has the URL changed (I doubt, my guess is Bioware kicked them for
being too old), and if not, could you please upload them on our mirrors ?

Denis.

(In reply to comment #11)
> Also, I have started adding my stuff into your ebuilds, and I can't seem to
> download some of the language files to remake the digests. They're neither on
> Bioware's servers (or they're having issues since yesterday), or on our
> mirrors. Has the URL changed (I doubt, my guess is Bioware kicked them for
> being too old), and if not, could you please upload them on our mirrors ?

I cannot put them on our mirrors.  We were specifically asked not to put any of
the NWN content on our mirrors.  Anyway, the download location is correct. 
Bioware's downloads constantly suck, so I would just say to try again.  Also,
I'd prefer it if any changes were sent as patches, rather then touching the
ebuilds directly, since I am still making lots of modifications locally.

Created an attachment (id=102570) [details]
Patch for nwn-data-1.29-r1.ebuild to fix URLs of language files.

(In reply to comment #12)
> I cannot put them on our mirrors.  We were specifically asked not to put any of
> the NWN content on our mirrors.  Anyway, the download location is correct. 
> Bioware's downloads constantly suck, so I would just say to try again.

Chris,

I tried and tried again, but couldn't download the files. So I looked around,
and I found out that the language files have actually moved. Here's a second
patch for nwn-data which fixes their URLs. While I was doing this, I have
checked all other URLs, and they look OK.

I'll probably start the real work on these ebuilds over the week-end. BTW,
there is a potential issue with nwmovies and/or nwuser on amd64. I had found
tricks on  both Gentoo and Bioware forums to get them to compile. I can look
for them again, but my point is that I don't have access to an amd64 to test
them. Would you be able to do this (once I'm done modifying the ebuilds, I
mean) ?

Denis.

OK.  The URLs should be fixed (once this commit goes through)...

i wonder if we couldn't implement the fullscreen toggling stuff by installing
our own patched version libSDL-1.2.so.0.0.5 in /opt/nwn/lib.  

we'd have to use libsdl-1.2.9 since it was the last version before they
overhauled fullscreen handling.  another reason for wanting our own build is
that there are already a few pkgs that DEPEND on >=libsdl-1.2.10.

http://home.woh.rr.com/nwmovies/
https://bugs.gentoo.org/show_bug.cgi?id=129294

Created an attachment (id=103255) [details]
01-read-n.patch

Here's the first in the series of patches I have promised. This first batch is
for the nwn-data ebuild. They're numbered to indicate in what order they should
be used to apply cleanly.

This one is a simple one-liner. As of version 3.2 (I think), bash requires an
argument after 'read -n'. Without it, the ebuild goes in an endless loop.

Created an attachment (id=103256) [details]
02-postinst.patch

This fixes what I think is an error in triggering the long postinst message
that explains that files should be manually copied from a previous
installation. I believe you want to show this message only when both cdinstall
AND nowin aren't used. If either cdinstall or nowin is used, there is no need
to manually copy anything.

Created an attachment (id=103257) [details]
03-typos.patch

Fixes two minor and harmless typos, but, hey, while I was at it... ;o)

Created an attachment (id=103259) [details]
04-disk-handling.patch

This one makes use of the CDROM_NAME variables of the cdrom functions in
eutils.eclass. The output is clearer for the user, and the ebuild is slightly
simpler.

Created an attachment (id=103261) [details]
05-nwmovies.patch

Adds support for nwmovies.

Created an attachment (id=103262) [details]
06-nwuser.patch

Adds support for nwuser.

Created an attachment (id=103265) [details]
07-nowin-fix.patch

Fixes handling of the nowin USE flag.

When installing from the original CD set and with USE="cdinstall -nowin", the
ebuild wants to unpack the huge nwresources tarball. But with -nowin, this
tarball isn't listed in SRC_URI, so it can't find it.

With cdinstall in the USE flags, the only things that are missing are
chitin.key, some useless text file, and a few demo modules. So I have fixed the
ebuild so that it fetches the only one that's really needed (chitin.key) from
CD1. Which makes that the 1.2 GB nwresource tarball isn't needed anymore. Yay!

Created an attachment (id=103269) [details]
08-fix-perms.patch

Fixes permissions of files directly copied from CD3 of the original CD set.

Created an attachment (id=103466) [details]
09-retain-ini.patch

Renames nwn.ini to nwn.ini.default, and copies the link to nwn.ini.default to
nwn.ini in the user's directory only the first time nwn is started.

This allows users to retain their option settings and not have them overwritten
every time they play.

Created an attachment (id=103467) [details]
10-external-sdl.patch

Switches to the external SDL library by default. nwn-data already depends on
>=libSDL-1.2.5, so this is OK, and we can only assume that, being specifically
compiled for the machine that's running it, it will be more optimized. Although
it probably doesn't matter much.

Plus, it solves some issues that users may have with alsa!=oss.

Note that nwmovies needs to know what SDL library to use, so this needs to be
in sync with what happens in src_compile() in the nwn ebuild (see below). And
since most users will switch to the external SDL anyway, doing it ahead of them
saves us having them ranting about nwmovies not working after they switched.

Created an attachment (id=103468) [details]
11-nowin-warnings.patch

Warns the user about what can, can't, may or will be installed depending on
various combinations of nowin and other USE flags.

It also allows installing with both cdinstall and nowin. It seems silly at
first, but cdinstall doesn't install the (mostly useless) demo modules, and
nowin doesn't install SoU, HoU, and the movies. Thus, those who want the whole
thing can have it, at the price of playing with a lot of CDs and downloading a
1.1+ GB tarball.

Created an attachment (id=103470) [details]
01-subdir-fix.patch

From now on, the patches are for the nwn ebuild, not nwn-data.

This one fixes the creation of multiple language subdirectories, as described
in [1].

And since it uses Chris's trick of symlinking stuff from a user's subdirectory,
it makes the nwuser patch above (see comment #21) useless.

[1] https://bugs.gentoo.org/show_bug.cgi?id=155831#c13

Created an attachment (id=103471) [details]
02-IUSE.patch

IUSE fixes.

Created an attachment (id=103476) [details]
03-nwmovies.patch

Adds nwmovies support.

Note that I have no idea if this will work for amd64, as I don't have access to
one. If it doesn't work, maybe using a precompiled binary like it is done for
nwmouse is a solution. Maybe there are other solutions, I don't know.

Note also that there are TEXTREL and exec stacks warnings, but there's no point
looking into that until it's confirmed to work on amd64 or a solution is found.

Created an attachment (id=103477) [details]
04-fixinstall.patch

Due to the multilanguage installation in subdirectories, some files or
directories could not be found anymore by fixinstall. Luckily, since they are
installed by the ebuild (and not manually copied from a previous install as it
can be the case for some data files), they don't need to be fixed. So I removed
their names from fixinstall.

This was the last patch.

Created an attachment (id=103480) [details]
nwn-data-1.29-r1.ebuild

Final ebuild for nwn-data.

Created an attachment (id=103481) [details]
nwn-1.68-r1.ebuild

Final ebuild for nwn.

(In reply to comment #31)
> Created an attachment (id=103480) [edit] [details]
> nwn-data-1.29-r1.ebuild
> 
> Final ebuild for nwn-data.
> 

why can't you add unpacking of KingMakerSetup.exe for diamond pack?

(In reply to comment #33)
> why can't you add unpacking of KingMakerSetup.exe for diamond pack?

Because I don't own a copy of the diamond pack and I had never heard of this
KingMakerSetup.exe before today.

Why don't you write a patch for it and post it here ?

Denis.

(In reply to comment #25)
> Created an attachment (id=103467) [edit] [details]
> 10-external-sdl.patch
> 
> Switches to the external SDL library by default.

Maybe not such a good idea after all. After nwmovies failed today to locate the
patterns to start patching the executable, I had a quick look at the code for
nwmovies. My conclusion is that in the context of Gentoo, and assuming you'd
use the external SDL, the whole thing has a better probability to fail than to
work (and Jakub will love us for the amount of bugs that'll generate). Plus,
using the included SDL library (maybe along with a precompiled libelf like for
nwmouse) would probably solve the amd64 compatibility issue.

So here's what we could do :
* forget about (nwn-data's) 10-external-sdl.patch
* fix (nwn's) 03-nwmovies.patch accordingly (easy)
* get a precompiled libelf if we need it, why not the one from nwmouse (BTW,
why not go all the way? Couldn't we package nwouse in nwn's ebuild so that
everybody gets it automatically? In other words, are there cases when it's not
a good idea to use nwmouse?)
* let users know that if they use the external SDL at all they're on their own
* maybe drop the SDL completely from RDEPEND

We could also provide a precompiled nwmovies.so.

Chris (and others), what do you think ?

Denis.

Actually, I *really* prefer that individual updates are done as individual
bugs.  If you have code for Kingmaker, file a separate bug.

Denis, I'll be looking into these as time permits.  I have an AMD64, so I'll be
able to test that everything works there.  Also, I am likely to *not* take the
SDL patch.  With other binary games, we force the user to use any libraries
shipped with the game over system libraries.  This makes the support easier for
upstream, as they don't have to worry about what we have changed.  In the case
of some upstreams, they refused to support Gentoo for the longest time until I
informed them of this games policy.  We consider the shipped libraries as part
of the game package, and only replace them if they're actually broken.

Now, what changes do I need to make if I'm not using the 10-external-sdl patch?

(In reply to comment #36)
> Actually, I *really* prefer that individual updates are done as individual
> bugs.  If you have code for Kingmaker, file a separate bug.
bug #157595

I would prefer that nwmovies is a separate ebuild, like nwmouse is.  The reason
for it is simple.  Not everybody wants it, and it can potentially cause issues
with the game, so being able to disable/remove the package when doing debugging
is paramount, especially on a huge binary game such as this.

(In reply to comment #38)
> I would prefer that nwmovies is a separate ebuild, like nwmouse is.

That's how I started working on nwmovies, but I can't remember why I merged it
into the main ebuild at some point. Anyway, your reasons for making it separate
are more than valid, so let's do it this way.

Sorry for not being more reactive to your requests above, but I'm rather busy
at the moment. I'll try and post an ebuild for nwmovies and fix the patches
that are impacted before the week-end.

Do we need a 'movies' or similar USE flag in nwn-data to avoid installing the
movie files in case the user doesn't want to install nwmovies? Or do we install
them from the nwmovies ebuild (forcing the user to more disk juggling)? Any
other ideas ? Don't care ?

Denis.

Don't worry about being responsive, you've been awesome.  You really are
helping me get lots of things I've wanted to put into these ebuilds done on a
much quicker time scale than I would have alone.  As for the movies, I would
say using the "videos" USE flag works, since that's what we've been using on
other ebuilds.

Created an attachment (id=104034) [details]
09-retain-ini.patch

New version of the retain-ini patch for nwn-data.

Created an attachment (id=104035) [details]
11-nowin-warnings.patch

New version of the nowin-warnings patch that gives feedback to the user about
nowin handling and allows emerging with nowin and cdinstall at the same time.

Created an attachment (id=104036) [details]
12-elog-typo.patch

Fixes typo in pkg_postinst (elgo!=elog).

(From update of attachment 104034 [details])
>--- nwn-data-1.29-r1.ebuild.orig	2006-12-14 13:30:01.000000000 +0100
>+++ nwn-data-1.29-r1.ebuild	2006-12-14 13:32:58.000000000 +0100
>@@ -364,6 +364,10 @@
> 	fi
> 	# These files aren't needed and come from the patches (games-rpg/nwn)
> 	rm -f data/patch.bif patch.key
>+
>+	# Rename nwn.ini to avoid overwriting it every time
>+	mv nwn.ini nwn.ini.default
>+
> 	sed -i -e 's,/bin/sh,/bin/bash,g' -e '\:^./nwmain .*:i \
> '"dir='${dir}';LINGUAS='${LINGUAS}'"' \
> die() { \
>@@ -406,6 +410,9 @@
> 	done \
> fi \
> cd "${p}" || die "cd ${p}" \
>+if [[ ! -a nwn.ini ]]; then \
>+	cp nwn.ini.default nwn.ini \
>+fi \
> if [[ -r ./nwmouse.so ]]; then \
> 	export XCURSOR_PATH="$(pwd)" \
> 	export XCURSOR_THEME=nwmouse \

(In reply to comment #44)
> (From update of attachment 104034 [details] [edit])

What was that ? I don't remember being drunk on thursday night ? Was I *that*
drunk then ? ;o)

Anyway, we're almost there. nwn-data just needs another patch to support movies
(see next post below). The nwn ebuild is OK, except we don't need
03-nwmovies.patch since we want nwmovies to come from another ebuild. And we
need that nwmovies ebuild, which I will post where it belongs, that is bug
#143362. It's done, it only needs some more testing and polishing, so I'll post
it later today.

Denis.

Created an attachment (id=104146) [details]
13-movies.patch

OK, this was the last one.

Here's a list of what patches are needed (because this all looks like a big
mess, now).

nwn-data :
01-read-n.patch
02-postinst.patch
03-typos.patch
04-disk-handling.patch
07-nowin-fix.patch
08-fix-perms.patch
09-retain-ini.patch
11-nowin-warnings.patch
12-elog-typo.patch
13-movies.patch

nwn:
01-subdir-fix.patch
02-IUSE.patch
04-fixinstall.patch

Denis.

I've now updated all of this in the tree with the patch list from comment #46
so we should be golden.

(In reply to comment #47)
> I've now updated all of this in the tree with the patch list from comment #46
> so we should be golden.

Cool !

Shouldn't bugs #83291 and #157988 be closed, then ?

Denis.

I haven't added the nwmovies package yet, so 143362 needs to stay open.  I'll
close 83291 once I unmask this beast.  I still want to try to fix any remaining
issues before I unmask it.  Do you have the Diamond pack?  If so, does it work?

My set (Original + SoU + HoU = Deluxe) worked just fine, but I cannot test any
of the other sets.  If it does work, please comment on the Diamond not working
bug.

Thanks

(In reply to comment #49)

Sorry, I missed that comment as I was out of town for Christmas, and then
failed to see it.

> Do you have the Diamond pack? If so, does it work?

I only have the original CD set and both expansion packs, so I can't help here.
Maybe we could directly ping our users that have the Diamond pack and ask them
to test the new stuff ? Do you want me to do it ?

Denis.

No, Diamond isn't working.  I have a patch on bug #155831.

I also can't get NWN to work with xcb, but that's another bug.