OS X Packaging (Q2Pro.app) #106

jdolan · 2016-07-09T12:33:00Z

This PR fixes some Clang compilation warnings, and gets OpenAL workable on OS X.

Here's the .config I'm compiling with:

VER = Quetoo.org 03ddefa0d
REV = 03ddefa0d

CONFIG_DEFAULT_MODELIST = 640x480 800x600 1024x768 1440x900 1920x1080
CONFIG_DEFAULT_GEOMETRY = 1440x900

CONFIG_HTTP = 1

CONFIG_OPENAL = 1
CONFIG_FIXED_LIBAL = 1
AL_CFLAGS = -framework OpenAL
AL_LIBS = -framework OpenAL

CONFIG_PNG = 1
CONFIG_JPEG = 1

CONFIG_SDL2 = 1

CONFIG_PATH_HOME = ~/.quake2

A few things I've noticed:

LibPNG implementation struggles to load textures that other engines load just fine. It squawks errors in the console, and the loaded textures are garbled. Not sure if this is specific to OS X, or if you see this on other platforms. Screenshot attached.
OpenAL implementation seems .. odd. Sound attenuation is very different from default behavior. Is Q2Pro's OpenAL considered "ready," or is it still experimental?

This reverts commit 5ed545d.

This reverts commit 92823a1.

This reverts commit c376be7.

This reverts commit 497ebe2.

jdolan · 2016-07-09T12:34:47Z

src/baseq2/g_cmds.c

@@ -355,7 +355,7 @@ void Cmd_Noclip_f(edict_t *ent)
        msg = "noclip ON\n";
    }

-    gi.cprintf(ent, PRINT_HIGH, msg);
+    gi.cprintf(ent, PRINT_HIGH, "%s", msg);
 }



Fix compiler warnings about print format attribute.

Please don't fix spurious warnings like this one.

Sorry, boss.

Sarcasm? I'd recommend splitting the series into "fix clang warnings" and "implement OSX .app packaging".

jdolan · 2016-07-09T12:40:28Z

You know, the garbled textures on the mesh models might be due to it attempting to load the high-res texture for the Generations Arena model onto the stock .md2 mesh. I have pak-generations-models.pak in ~/.quake2/baseq2. It must explicitly find the .png skins due to r_override_textures, but load the low-poly .md2 from pak0.pak.

What's the preferred way to add 3rd party pak files to override stock content?

joe0x04 · 2016-07-09T12:50:48Z

The menus aren't showing up most likely because you're missing the q2pro.menu file baseq2. I've noticed you just don't get any menus when that's missing.

…so, set sane defaults for basedir and libdir.

jdolan · 2016-07-10T12:53:48Z

apple/Makefile

+	rsync -rzhP $(DIST) $(HTTP_TARGET)
+
+clean:
+	rm -rf $(TARGET)/*


This is based on the packaging I've created for Quake II, Quetoo, GtkRadiant, etc.. It uses dylibbundler to find, copy and fix dynamically linked dependencies.

jdolan · 2016-07-10T12:55:22Z

apple/Q2Pro.app/Contents/MacOS/install-data.py

+    if prompt(messages.textures, 'y') == 'y':
+        rsync(config.textures)
+
+    print messages.end


This is the game data installation script I developed for my AprQ2 fork. Users can run this to optionally install the 3.20 point release, the game demo, CTF, high res textures, Generations Arena models, etc.. It's like Q2Starter for Apple and Linux.

jdolan · 2016-07-10T13:03:02Z

A compiled OS X application bundle from this branch can be found here:

http://quetoo.org/files/Q2Pro.dmg

To keep the file size down, I did not include any game data resources. So to test this, you'll need a "populated" ~/.quake2/baseq2 -- or you can copy pak0.pak and friends into Q2Pro.app/Contents/Resources/baseq2. But here's a shot of the game running on OS X:

Raptor007 · 2018-06-12T04:24:54Z

Thanks for the easy app setup. I was able to make mine Snow Leopard compatible with this .config for q2pro:

# Optional dependencies that worked for me in Snow Leopard, probably via MacPorts:
CONFIG_PNG=y
CONFIG_JPEG=y
CONFIG_HTTP=y

# Snow Leopard identifies as i386 when it's really x86_64:
CPU=x86_64

# My preference is keeping gamedirs like baseq2 adjacent to Q2Pro.app:
CONFIG_PATH_DATA=.
CONFIG_PATH_LIB=.
CONFIG_PATH_HOME=.

And of course, one little tweak to Info.plist:

<key>LSMinimumSystemVersion</key>
<string>10.6.8</string>

sthalik · 2018-06-12T06:06:05Z

Only with openal you can distinguish sound direction. The other sound mode doesn't support that. All headphones allow a pretty accurate 5.1 emulation. I recommend building with openal (a .dylib inside the app directory is fine) as it doesn't influence 2.0 sound.

Also I see that the pull request doesn't use install_name_tool, you need that for bundling libraries. See example usage: <https://github.com/opentrack/opentrack/blob/unstable/macosx/install-fail-tool>.

Raptor007 · 2018-06-12T07:10:31Z

@sthalik Good call, I thought there was some problem with OpenAL and Snow Leopard because I was having linking errors... it turns out I had somehow gotten an old 32-bit version in my /Library/Frameworks, but the one in /System/Library/Frameworks works okay (and MacPorts openal-soft works great). So I got rid of the bad framework and added this to my .config:

CONFIG_OPENAL=y
CONFIG_FIXED_LIBAL=y

The apple/Makefile uses dylibbundler to put together the app, which seems to work recursively to make sure the bundled libraries also have their dependencies. It calls install_name_tool many times to change the prefix to @executable_path/lib on the q2pro binaries and bundled dylibs.

I didn't realize this pull request was from 2016; you can probably drop everything except the apple subdirectory, which stands alone well enough to make an app from the latest q2pro.

sthalik · 2018-06-12T07:48:00Z

@Raptor007 openal is LGPL 2 so you may even link it statically without caring. But for dylibs I recommend using otool+install_name_tool in the form I linked. See dyld(1) for the details. It's a horrorshow compared to Unix or Windows in general...

Raptor007 · 2018-06-12T08:05:36Z

@sthalik It looks like dylibbundler is just a fancy wrapper for otool -L and install_name_tool but I can see why you'd rather stick to a simple shell script than a 3rd party tool. This wasn't my pull request, so I don't think I have permission to change it. I was just commenting on my experiences using it.

jdolan · 2018-06-12T22:33:44Z

Hah! I had forgotten that I ever opened this PR.

I still use a similar packaging strategy (Makefile + dylibbundler) for Quetoo and GtkRadiant on macOS, so I'm happy to support this in Q2Pro as well.

I do recommend using dylibbundler over attempting to mangle the header paths yourself, as the tool performs a recursive search of all dependencies, and ensures that they can each find each other. It's also pretty painless to install.

Of course, Apple just announced that they're killing OpenGL support, so.. this is all moot ;)

sthalik · 2018-06-13T05:54:46Z

@jdolan

Of course, Apple just announced that they're killing OpenGL support, so.. this is all moot ;)

Not really. Just wait for a GL -> Metal layer like people use for Vulkan already.

Strip quotes from ‘if’ command arguments.

jdolan added 16 commits March 31, 2013 12:25

Basic OS X support, compiles and runs on 10.7 (Lion)

497ebe2

Packaging for OS X.

c376be7

Update Makefile to use ~/.quake2 on Unix.

92823a1

Build packaging for Mac OS X and Linux.

5ed545d

Revert "Build packaging for Mac OS X and Linux."

63abbe9

This reverts commit 5ed545d.

Revert "Update Makefile to use ~/.quake2 on Unix."

dfd88f2

This reverts commit 92823a1.

Revert "Packaging for OS X."

403399f

This reverts commit c376be7.

Revert "Basic OS X support, compiles and runs on 10.7 (Lion)"

e7ebb3f

This reverts commit 497ebe2.

Merge branch 'master' of https://github.com/AndreyNazarov/q2pro

869fa22

Fix OpenGL on Mac.

e919147

Merge branch 'master' of https://github.com/AndreyNazarov/q2pro

50ff57c

Merge branch 'master' of https://github.com/AndreyNazarov/q2pro

cdf9173

Merge branch 'master' of https://github.com/AndreyNazarov/q2pro

1ab18f6

Fix a bunch of compiler warnings.

d374072

Fix OpenAL includes for OS X.

d8c32a4

Default s_enable to 2 so that it tries OpenAL. It's harmless to try.

7660510

jdolan reviewed Jul 9, 2016
View reviewed changes

jdolan added 4 commits July 10, 2016 08:27

On OS X, detect if running from within an Application bundle, and if …

0095c0b

…so, set sane defaults for basedir and libdir.

Add build directories to .gitignore.

0176366

Packaging scripts for OS X.

03ddefa

Add install-data script to .app scaffolding.

febaf39

jdolan changed the title ~~Minor fixes for OS X compilation~~ OS X Packaging (Q2Pro.app) Jul 10, 2016

jdolan reviewed Jul 10, 2016
View reviewed changes

jdolan added 2 commits July 16, 2020 10:10

Merging upstream

1d0e935

Update README with link to download.

9b3f5e5

Iceman12k pushed a commit to Iceman12k/q2pro that referenced this pull request Feb 8, 2024

Merge pull request skullernet#106 from skullernet/master

4742784

Strip quotes from ‘if’ command arguments.

carlossless mentioned this pull request Oct 28, 2024

Highres icons #364

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OS X Packaging (Q2Pro.app) #106

OS X Packaging (Q2Pro.app) #106

jdolan commented Jul 9, 2016 •

edited

Loading

jdolan Jul 9, 2016

sthalik Jun 13, 2018

jdolan Jun 13, 2018

sthalik Jun 13, 2018

jdolan commented Jul 9, 2016

joe0x04 commented Jul 9, 2016

jdolan Jul 10, 2016

jdolan Jul 10, 2016

jdolan commented Jul 10, 2016

Raptor007 commented Jun 12, 2018 •

edited

Loading

sthalik commented Jun 12, 2018

Raptor007 commented Jun 12, 2018 •

edited

Loading

sthalik commented Jun 12, 2018 •

edited

Loading

Raptor007 commented Jun 12, 2018

jdolan commented Jun 12, 2018

sthalik commented Jun 13, 2018 •

edited

Loading

OS X Packaging (Q2Pro.app) #106

Are you sure you want to change the base?

OS X Packaging (Q2Pro.app) #106

Conversation

jdolan commented Jul 9, 2016 • edited Loading

jdolan Jul 9, 2016

Choose a reason for hiding this comment

sthalik Jun 13, 2018

Choose a reason for hiding this comment

jdolan Jun 13, 2018

Choose a reason for hiding this comment

sthalik Jun 13, 2018

Choose a reason for hiding this comment

jdolan commented Jul 9, 2016

joe0x04 commented Jul 9, 2016

jdolan Jul 10, 2016

Choose a reason for hiding this comment

jdolan Jul 10, 2016

Choose a reason for hiding this comment

jdolan commented Jul 10, 2016

Raptor007 commented Jun 12, 2018 • edited Loading

sthalik commented Jun 12, 2018

Raptor007 commented Jun 12, 2018 • edited Loading

sthalik commented Jun 12, 2018 • edited Loading

Raptor007 commented Jun 12, 2018

jdolan commented Jun 12, 2018

sthalik commented Jun 13, 2018 • edited Loading

jdolan commented Jul 9, 2016 •

edited

Loading

Raptor007 commented Jun 12, 2018 •

edited

Loading

Raptor007 commented Jun 12, 2018 •

edited

Loading

sthalik commented Jun 12, 2018 •

edited

Loading

sthalik commented Jun 13, 2018 •

edited

Loading