(svn r22919) -Doc: Some doxygen sprinkles
[openttd/fttd.git] / Makefile.grf.in
bloba70b3072b0b51d2d7af13b93aa28a16c95b45179
1 # $Id$
3 # This file is part of OpenTTD.
4 # OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
5 # OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
6 # See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 # Building requires GRFCodec and NFORenum. Older versions of GRFCodec are
9 #  known to miscompile the graphics.
11 # Recent nightlies (including sources) of both can be found at:
12 #  http://www.openttd.org/download-grfcodec
13 #  http://www.openttd.org/download-nforenum
15 # The mercurial repository of both can be found at:
16 #  http://hg.openttdcoop.org/grfcodec
17 #  http://hg.openttdcoop.org/nforenum
21 ROOT_DIR = !!ROOT_DIR!!
22 GRF_DIR  = $(ROOT_DIR)/media/extra_grf
23 BIN_DIR  = !!BIN_DIR!!/data
24 OBJS_DIR = !!GRF_OBJS_DIR!!
25 OS       = !!OS!!
26 STAGE    = !!STAGE!!
28 # Check if we want to show what we are doing
29 ifdef VERBOSE
30         Q =
31         E = @true
32 else
33         Q = @
34         E = @echo
35 endif
37 # Some configurational settings for your environment.
38 # If GRFCodec doesn't know a command, it'll exit with a non-zero exit code.
39 GRFCODEC := $(shell grfcodec -s -v >/dev/null 2>/dev/null && echo "grfcodec -s" || echo "grfcodec")
40 # Old NFORenums don't give an error code when a parameter isn't known, so we have to work around that.
41 NFORENUM := $(shell [ `nforenum -s -v 2>/dev/null | wc -l ` -eq 1 ] && echo "nforenum -s" || echo "nforenum")
42 MD5SUM   := $(shell [ "$(OS)" = "OSX" ] && echo "md5 -r" || echo "md5sum")
44 # Some "should not be changed" settings.
45 NFO_FILES    := $(GRF_DIR)/*.nfo $(GRF_DIR)/rivers/*.nfo
46 PNG_FILES    := $(GRF_DIR)/*.png $(GRF_DIR)/rivers/*.png
48 # Build the GRF.
49 all: $(BIN_DIR)/openttd.grf
51 # Make sure the sprites directory exists.
52 $(OBJS_DIR)/sprites:
53         $(Q)-mkdir "$@"
55 # Generic
56 $(BIN_DIR)/openttd.grf: $(PNG_FILES) $(NFO_FILES) $(OBJS_DIR)/sprites
57         @# Only try; if nforenum isn't available, just retouch the file as they likely didn't need it anyway.
58         $(Q) ($(NFORENUM) --help > /dev/null 2>&1 && $(MAKE) $(OBJS_DIR)/openttd.grf && cp $(OBJS_DIR)/openttd.grf $(BIN_DIR)/openttd.grf) || ([ -e $(BIN_DIR)/openttd.grf ] && touch $(BIN_DIR)/openttd.grf && echo "no NFORenum and GRFCodec found, skipping rebuild of openttd.grf...") || (echo "no NFORenum and GRFCodec found, but no openttd.grf either. Install NFORenum and GRFCodec." && exit 1)
60 # Yeah, we'd like to use -i in the sed, but Mac OS X's sed and GNU sed just can't agree on the usage of -i. In any case either one of them fails.
61 $(OBJS_DIR)/openttd.grf: $(PNG_FILES) $(NFO_FILES) $(OBJS_DIR)/sprites
62         $(E) '$(STAGE) Assembling openttd.nfo'
63         $(Q)-cp $(PNG_FILES) $(OBJS_DIR)/sprites 2> /dev/null
64         $(Q) gcc -I$(GRF_DIR) -C -E - < "$(GRF_DIR)/openttd.nfo" | sed -e '/^#/d' -e '/^$$/d' > $(OBJS_DIR)/sprites/openttd.nfo
65         $(Q) $(NFORENUM) $(OBJS_DIR)/sprites/openttd.nfo
66         $(E) '$(STAGE) Compiling openttd.grf'
67         $(Q) $(GRFCODEC) -e -p1 $(OBJS_DIR)/openttd.grf
68         $(Q) cp $(OBJS_DIR)/openttd.grf $(BIN_DIR)/openttd.grf
69         $(E) '$(STAGE) Updating base graphics sets'
70         $(Q) for grf in $(BIN_DIR)/orig*.obg; do sed 's/^OPENTTD.GRF  = [0-9a-f]*$$/OPENTTD.GRF  = '`$(MD5SUM) $(BIN_DIR)/openttd.grf | sed 's@ .*@@'`'/' $$grf > $$grf.tmp && mv $$grf.tmp $$grf; done
72 # Clean up temporary files.
73 clean:
74         $(Q)rm -f *.bak *.grf
76 # Clean up temporary files
77 mrproper: clean
78         $(Q)rm -fr sprites
80 .PHONY: all mrproper depend clean