Port of Wolfenstein 3-D

[__builtin]

This port is old news by now, but I've decided to give it a new topic because I'd like to actually merge it this time around.

As you might know, I've been working sporadically on a port of Wolfenstein 3-D (http://gerrit.rockbox.org/r/#/c/1653/) to run on the Rockbox SDL runtime (old screenshots attached). I'm posting for a couple of reasons. First, I'd like to get the port tested on some more targets. As always, just ask and I should be able to provide a build.

More importantly, there are some licensing issues that I'd like cleared up before proceeding to merge the patch (this same question has been cross-posted to the -dev mailing list). The license of the original Wolfenstein 3-D source code itself is unclear. Id software officially released the code under a custom, restrictive license. However, over the years, various source ports claim that it is GPL compatible (see https://github.com/AlumiuN/Wolf4SDL, for example), and I think it's doubtful that id would waste their time chasing down infringing users of a 27-year old game.

That leads to the question of whether or not we should (whatever that might mean) include my port in master. Thoughts?

[Chronon]

The license here doesn't appear to be GPL compatible.

https://github.com/id-Software/wolf3d

OTOH, there's this browser version here which was uploaded to Github 2 years later, which is explicitly GPL:
https://github.com/id-Software/wolf3d-browser/blob/master/COPYING.txt

[__builtin]

I'm fairly certain the browser version shares no code with the original.

I did come across this page, which claims that the original is GPL-licensed: https://maniacsvault.net/ecwolf/wiki/Source_code

That page points out that Doom (which we currently distribute) was never "officially" announced as GPL, and it looks like Debian has marked Wolf4SDL (the same source port I used) as GPL, with backing from John Carmack himself: https://metadata.ftp-master.debian.org/changelogs//contrib/w/wolf4sdl/wolf4sdl_1.7+svn262+dfsg1-5_copyright

So it appears that we *should* be fine.

[Chronon]

I was just bringing up the browser engine as an example that suggests that they aren't fundamentally opposed to a GPL engine for Wolfenstein 3d. 

If this is substantially the same situation as Doom then I don't have any objections, and if Debian is treating it as GPL that seems like a pretty good precedent.

[csussman]

Can you make a build for iBasso DX50?

[rockbox_dev123]

When trying to compile this and give some feedback I'm getting:

Code: [Select]

make: *** No rule to make target '/rockbox/build/apps/plugins/wolf3d.o', needed by '/rockbox/build/apps/plugins/wolf3d.rock'.  Stop.
Pulled via:
git clone git://git.rockbox.org/rockbox
git fetch http://gerrit.rockbox.org/rockbox refs/changes/53/1653/15 && git checkout FETCH_HEAD

Am I failing to include the actual source for wolf3d somehow?

[__builtin]

That's actually my fault. I forgot to include the overlay loader stub (that's all wolf3d.c is, really). Should be fixed in the latest patch set.

And, csussman: I don't have the Android toolchain installed so I'm currently unable to build for DX50. The build farm should handle it once I merge it, though.

[rockbox_dev123]

That's actually my fault. I forgot to include the overlay loader stub (that's all wolf3d.c is, really). Should be fixed in the latest patch set.

And, csussman: I don't have the Android toolchain installed so I'm currently unable to build for DX50. The build farm should handle it once I merge it, though.

Compiled and running on an ipod6g - although I can't work out how to open the first door - the OK/SELECT button doesn't seem to do anything - despite working in the games menus.

Sound is working nicely.

Its pretty late so thats good enough for now.

[__builtin]

Compiled and running on an ipod6g - although I can't work out how to open the first door - the OK/SELECT button doesn't seem to do anything - despite working in the games menus.

That's odd. Are you approaching the door before pressing SELECT?

EDIT: Looks like the problem is with the default configuration. Go to "Controls" and set "Open=Up" and "Fire=Select".

[rockbox_dev123]

Compiled and running on an ipod6g - although I can't work out how to open the first door - the OK/SELECT button doesn't seem to do anything - despite working in the games menus.

EDIT: Looks like the problem is with the default configuration. Go to "Controls" and set "Open=Up" and "Fire=Select".

Played some wolf3d on my commute home, was able to nearly finish the first level after multiple attempts.

I'd say that it is very stable - and as for licensing my $0.02 is merge it.

Makes me wonder if a Quake1 sdl port would be possible with the hardware restrictions of the ipod6g - it would be extremely cumbersome to play - but a cool feat to port.

Only thing I would say - is if you are able to make some platform specific config decisions then it would go a long way to improving the ports usability - sound only works if you enable it yourself in the settings and the same goes for usable controls to be able to play.

[__builtin]

Before merging, I still need to rebase the MAME code in the port to after they transitioned to GPLv2+. That shouldn't be too hard, but it'll take some time.

As for Quake, I managed to get it running on SDL as well a while back (http://gerrit.rockbox.org/r/#/c/1673/). It doesn't quite work, though, and it's a huge pain to debug. Maybe I'll find some time for that as well.

[__builtin]

Alright, I merged the game into master yesterday. I haven't tested it on any hardware other than ipod6g, so I'd appreciate some feedback on whether it works on other devices.

[cela]

Alright, I merged the game into master yesterday. I haven't tested it on any hardware other than ipod6g, so I'd appreciate some feedback on whether it works on other devices.

Just tested, fully working on Sony nwz-E384, Creative Zen x-fi2 and Sansa Fuze+ including sound effects and music. Thanks!

[csussman]

I tried wolf3d on the iBasso DX50 and it seems to work. It could use better key mapping though, it only uses five buttons. The fire and open keys are the same, the back and change weapon are the same, and there's no menu button.

Quake and duke3d are also like this.

Thank you for these ports.

[__builtin]

Thanks for letting me know! It should be possible to change the key mapping from within each game, though not all buttons will send a virtual keypress event to the game.