shithub: duke3d

Download patch

ref: 5ee535f702ac96c09e427497caa3ccace329d89d
parent: 3ad3deeaf29162d8301dd170e391a947a39c1459
author: Andy Piper <andypiperuk@gmail.com>
date: Sun Mar 3 13:11:33 EST 2013 

Improve OS X build and docs

Improved the README with build requirements and links
Added initial credits for Info box on OS X
Improved Xcode build on OS X, should resolve SDL location better
Conditional compile for OS X to stop SDL setting app icon and
overriding the nicer high res image (may not be wanted on all
platforms)


--- a/.gitignore
+++ b/.gitignore
@@ -13,3 +13,4 @@
 bin
 */ReleaseVC7
 *vcxproj.user
+DUKE3D.GRP
--- a/Engine/src/display.c
+++ b/Engine/src/display.c
@@ -943,12 +943,14 @@
 	SDL_Surface     *image;
 	Uint32          colorkey;
 
+    // don't override higher-res app icon on OS X
+#ifndef PLATFORM_MACOSX
 	// Install icon
 	image = SDL_LoadBMP_RW(SDL_RWFromMem(iconBMP, sizeof(iconBMP)), 1);
 	colorkey = 0; // index in this image to be transparent
     SDL_SetColorKey(image, SDL_SRCCOLORKEY, colorkey);
 	SDL_WM_SetIcon(image,NULL);
-
+#endif
     
     if (daxdim > MAXXDIM || daydim > MAXYDIM)
     {
--- a/README.md
+++ b/README.md
@@ -1,23 +1,36 @@
 Chocolate Duke3D
 ================
 
-Chocolate Duke Nukem 3D is the equivalent of Chocolate Doom:
+Chocolate Duke Nukem 3D is the equivalent of [Chocolate Doom](http://www.chocolate-doom.org/wiki/index.php/Chocolate_Doom).
 
 A port that:
 
-1. Remains a fidele as possible to the original source code.
-2. Portable and compiling in one click on Windows, Mac OSX and Linux.
-3. Aimed at education: A lot of comments and documentation has been added in order to help programmers to understand and learn.
+1. Remains as faithful as possible to the original source code.
+2. Portable and compiling in one click on Windows, OS X and Linux.
+3. Aimed at education, with lots of comments and documentation added in order to help programmers to understand and learn.
 
-Cheers,
 
-Build :
-=======
+Requirements
+============
 
-Windows : Use Visual Studio 2005 or Visual Studio 2012  
-Mac OS X: Use Xcode 4.0  
-Linux   : Never tested :/ !  
+[SDL](http://libsdl.org) and SDL_mixer to compile and run the code.
 
-Fabien Sanglard
+An original copy of Duke Nukem 3D (specifically the DUKE3D.GRP file from the original CD).
+
+
+Build
+=====
+
+Windows: Use Visual Studio 2005 or Visual Studio 2012  
+OS X: Use Xcode 4.0  
+Linux: Not yet tested 
+
+
+Background
+==========
+
+**Project initiator:** Fabien Sanglard 
+
+**More information:** [Review of the Duke 3D source code](http://fabiensanglard.net/duke3d/)
 
 
--- a/xcode/Duke3D.xcodeproj/project.pbxproj
+++ b/xcode/Duke3D.xcodeproj/project.pbxproj
@@ -59,8 +59,6 @@
 		2D47FB4116C6BA8200DB3597 /* tiles.c in Sources */ = {isa = PBXBuildFile; fileRef = 2D058BCF1686520B00E283DC /* tiles.c */; };
 		2D47FB4216C6BA8200DB3597 /* network.c in Sources */ = {isa = PBXBuildFile; fileRef = 2D058BE3168689B200E283DC /* network.c */; };
 		2D47FB4316C6BA8200DB3597 /* SDLMain.m in Sources */ = {isa = PBXBuildFile; fileRef = 2D7B7AED16792D6700DB503A /* SDLMain.m */; };
-		2D47FB4616C6BB4000DB3597 /* SDL.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2D47FB4416C6BB4000DB3597 /* SDL.framework */; };
-		2D47FB4716C6BB4000DB3597 /* SDL_mixer.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2D47FB4516C6BB4000DB3597 /* SDL_mixer.framework */; };
 		2D47FB4916C6BC2200DB3597 /* SDL_mixer.framework in CopyFiles */ = {isa = PBXBuildFile; fileRef = 2D7B623216788AAB00E35E54 /* SDL_mixer.framework */; };
 		2D47FB4A16C6BC2200DB3597 /* SDL.framework in CopyFiles */ = {isa = PBXBuildFile; fileRef = 2D7B623016788A9B00E35E54 /* SDL.framework */; };
 		2D47FB4E16C6BF1C00DB3597 /* duke_3d_icon.icns in Resources */ = {isa = PBXBuildFile; fileRef = 2D47FB4D16C6BF1C00DB3597 /* duke_3d_icon.icns */; };
@@ -112,6 +110,8 @@
 		2D7C17DD167AD6A500E1BBA1 /* nodpmi.c in Sources */ = {isa = PBXBuildFile; fileRef = 2D7C17D4167AD6A500E1BBA1 /* nodpmi.c */; };
 		2D7C17DE167AD6A500E1BBA1 /* user.c in Sources */ = {isa = PBXBuildFile; fileRef = 2D7C17D6167AD6A500E1BBA1 /* user.c */; };
 		2D7C17E0167ADE2000E1BBA1 /* pitch.c in Sources */ = {isa = PBXBuildFile; fileRef = 2D7C17DF167ADE1F00E1BBA1 /* pitch.c */; };
+		51516E1816E3BBED00A480FC /* SDL_mixer.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2D7B623216788AAB00E35E54 /* SDL_mixer.framework */; };
+		51516E1916E3BBED00A480FC /* SDL.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2D7B623016788A9B00E35E54 /* SDL.framework */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXCopyFilesBuildPhase section */
@@ -156,8 +156,6 @@
 		2D47FB0516C6BA0D00DB3597 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/InfoPlist.strings; sourceTree = "<group>"; };
 		2D47FB0916C6BA0D00DB3597 /* Duke3DBundle-Prefix.pch */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Duke3DBundle-Prefix.pch"; sourceTree = "<group>"; };
 		2D47FB0B16C6BA0D00DB3597 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.rtf; name = en; path = en.lproj/Credits.rtf; sourceTree = "<group>"; };
-		2D47FB4416C6BB4000DB3597 /* SDL.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SDL.framework; path = Library/Frameworks/SDL.framework; sourceTree = SDKROOT; };
-		2D47FB4516C6BB4000DB3597 /* SDL_mixer.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SDL_mixer.framework; path = Library/Frameworks/SDL_mixer.framework; sourceTree = SDKROOT; };
 		2D47FB4D16C6BF1C00DB3597 /* duke_3d_icon.icns */ = {isa = PBXFileReference; lastKnownFileType = image.icns; path = duke_3d_icon.icns; sourceTree = "<group>"; };
 		2D4FB6FE167D430F00915887 /* sdl_midi.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; path = sdl_midi.c; sourceTree = "<group>"; };
 		2D7B61DE167886FB00E35E54 /* Duke3D */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = Duke3D; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -265,8 +263,8 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				2D47FB4616C6BB4000DB3597 /* SDL.framework in Frameworks */,
-				2D47FB4716C6BB4000DB3597 /* SDL_mixer.framework in Frameworks */,
+				51516E1816E3BBED00A480FC /* SDL_mixer.framework in Frameworks */,
+				51516E1916E3BBED00A480FC /* SDL.framework in Frameworks */,
 				2D47FAFF16C6BA0D00DB3597 /* Cocoa.framework in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -440,8 +438,6 @@
 		2D7B61D3167886FB00E35E54 = {
 			isa = PBXGroup;
 			children = (
-				2D47FB4416C6BB4000DB3597 /* SDL.framework */,
-				2D47FB4516C6BB4000DB3597 /* SDL_mixer.framework */,
 				2D7B61E1167886FB00E35E54 /* Duke3D */,
 				2D47FB0116C6BA0D00DB3597 /* Duke3DBundle */,
 				2D47FADD16C6B94600DB3597 /* Frameworks */,
@@ -761,6 +757,7 @@
 		2D47FB1416C6BA0D00DB3597 /* Debug */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				ALWAYS_SEARCH_USER_PATHS = NO;
 				ARCHS = "$(ARCHS_STANDARD_32_BIT)";
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = "Duke3DBundle/Duke3DBundle-Prefix.pch";
@@ -774,11 +771,13 @@
 		2D47FB1516C6BA0D00DB3597 /* Release */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				ALWAYS_SEARCH_USER_PATHS = NO;
 				ARCHS = "$(ARCHS_STANDARD_32_BIT)";
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = "Duke3DBundle/Duke3DBundle-Prefix.pch";
 				GCC_VERSION = com.apple.compilers.llvm.clang.1_0;
 				INFOPLIST_FILE = "Duke3DBundle/Duke3DBundle-Info.plist";
+				ONLY_ACTIVE_ARCH = YES;
 				PRODUCT_NAME = "Chocolate Duke3D";
 				WRAPPER_EXTENSION = app;
 			};
@@ -813,7 +812,9 @@
 					"/Library/Frameworks/SDL.framework/Headers/**",
 					"/Library/Frameworks/SDL_Mixer.framework/Headers/**",
 				);
-				MACOSX_DEPLOYMENT_TARGET = 10.7;
+				INSTALL_PATH = "@rpath";
+				LD_RUNPATH_SEARCH_PATHS = "@loader_path/../Frameworks";
+				MACOSX_DEPLOYMENT_TARGET = 10.8;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = macosx;
 			};
@@ -842,7 +843,9 @@
 					"/Library/Frameworks/SDL.framework/Headers/**",
 					"/Library/Frameworks/SDL_Mixer.framework/Headers/**",
 				);
-				MACOSX_DEPLOYMENT_TARGET = 10.7;
+				INSTALL_PATH = "@rpath";
+				LD_RUNPATH_SEARCH_PATHS = "@loader_path/../Frameworks";
+				MACOSX_DEPLOYMENT_TARGET = 10.8;
 				SDKROOT = macosx;
 			};
 			name = Release;
--- a/xcode/Duke3DBundle/en.lproj/Credits.rtf
+++ b/xcode/Duke3DBundle/en.lproj/Credits.rtf
@@ -1,29 +1,15 @@
-{\rtf0\ansi{\fonttbl\f0\fswiss Helvetica;}
+{\rtf1\ansi\ansicpg1252\cocoartf1187\cocoasubrtf340
+{\fonttbl\f0\fswiss\fcharset0 Helvetica;}
 {\colortbl;\red255\green255\blue255;}
-\paperw9840\paperh8400
-\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\ql\qnatural
+\paperw11900\paperh16840\vieww9600\viewh8400\viewkind0
+\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720
 
 \f0\b\fs24 \cf0 Engineering:
 \b0 \
-	Some people\
+	Fabien Sanglard\
 \
 
-\b Human Interface Design:
-\b0 \
-	Some other people\
-\
-
-\b Testing:
-\b0 \
-	Hopefully not nobody\
-\
-
-\b Documentation:
-\b0 \
-	Whoever\
-\
-
-\b With special thanks to:
-\b0 \
-	Mom\
-}
+\b Homepage:\
+\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural
+\cf0 	{\field{\*\fldinst{HYPERLINK "https://github.com/fabiensanglard/chocolate_duke3D"}}{\fldrslt 
+\b0 https://github.com/fabiensanglard/chocolate_duke3D}}}
\ No newline at end of file