summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-11-14 21:39:14 +0000
committerrubidium <rubidium@openttd.org>2011-11-14 21:39:14 +0000
commit387e410f3e7898cadec041f2849bc949810544bb (patch)
treeaba21e7a083360b9a792608ffdbb09cb0685f519
parent79b82b56a8bf3faf7733afe02470c20ce3cbfa47 (diff)
downloadopenttd-387e410f3e7898cadec041f2849bc949810544bb.tar.xz
(svn r23221) -Codechange: update the documentation and installers regarding the new directories
-rw-r--r--os/os2/installer/download_nosound.cmd6
-rw-r--r--os/os2/installer/download_opengfx.cmd6
-rw-r--r--os/os2/installer/download_opensfx.cmd6
-rw-r--r--os/os2/installer/remove_nosound.cmd4
-rw-r--r--os/os2/installer/remove_opengfx.cmd4
-rw-r--r--os/os2/installer/remove_opensfx.cmd4
-rw-r--r--os/rpm/openttd.spec8
-rw-r--r--os/windows/installer/install.nsi136
-rw-r--r--readme.txt27
9 files changed, 110 insertions, 91 deletions
diff --git a/os/os2/installer/download_nosound.cmd b/os/os2/installer/download_nosound.cmd
index 296becf3c..39e9843a9 100644
--- a/os/os2/installer/download_nosound.cmd
+++ b/os/os2/installer/download_nosound.cmd
@@ -4,12 +4,12 @@ if "%2" == "" goto err
echo Downloading NoSound...
-%1\wget http://binaries.openttd.org/installer/nosound-NOSOUND_VERSION.7z -O %2/data/nosound.7z
+%1\wget http://binaries.openttd.org/installer/nosound-NOSOUND_VERSION.7z -O %2/baseset/nosound.7z
echo Extracting NoSound...
-%1\7za x -y -O%2/data %2/data/nosound.7z
-del %1\data\nosound.7z /n
+%1\7za x -y -O%2/baseset %2/baseset/nosound.7z
+del %1\baseset\nosound.7z /n
echo NoSound has been installed.
goto end
diff --git a/os/os2/installer/download_opengfx.cmd b/os/os2/installer/download_opengfx.cmd
index 5fb0a32bc..c2686b456 100644
--- a/os/os2/installer/download_opengfx.cmd
+++ b/os/os2/installer/download_opengfx.cmd
@@ -4,12 +4,12 @@ if "%2" == "" goto err
echo Downloading OpenGFX...
-%1\wget http://binaries.openttd.org/installer/opengfx-OPENGFX_VERSION.7z -O %2/data/opengfx.7z
+%1\wget http://binaries.openttd.org/installer/opengfx-OPENGFX_VERSION.7z -O %2/baseset/opengfx.7z
echo Extracting OpenGFX...
-%1\7za x -y -O%2/data %2/data/opengfx.7z
-del %1\data\opengfx.7z /n
+%1\7za x -y -O%2/baseset %2/baseset/opengfx.7z
+del %1\baseset\opengfx.7z /n
echo OpenGFX has been installed.
goto end
diff --git a/os/os2/installer/download_opensfx.cmd b/os/os2/installer/download_opensfx.cmd
index 0a918b95f..0a46dea42 100644
--- a/os/os2/installer/download_opensfx.cmd
+++ b/os/os2/installer/download_opensfx.cmd
@@ -4,12 +4,12 @@ if "%2" == "" goto err
echo Downloading OpenSFX...
-%1\wget http://binaries.openttd.org/installer/opensfx-OPENSFX_VERSION.7z -O %2/data/opensfx.7z
+%1\wget http://binaries.openttd.org/installer/opensfx-OPENSFX_VERSION.7z -O %2/baseset/opensfx.7z
echo Extracting OpenSFX...
-%1\7za x -y -O%2/data %2/data/opensfx.7z
-del %1\data\opensfx.7z /n
+%1\7za x -y -O%2/baseset %2/baseset/opensfx.7z
+del %1\baseset\opensfx.7z /n
echo OpenSFX has been installed.
goto end
diff --git a/os/os2/installer/remove_nosound.cmd b/os/os2/installer/remove_nosound.cmd
index 6959fbf29..21c11e80d 100644
--- a/os/os2/installer/remove_nosound.cmd
+++ b/os/os2/installer/remove_nosound.cmd
@@ -3,8 +3,8 @@ if "%1" == "" goto err
echo Removing NoSound...
-del %1\data\nosound\*.* /n
-rmdir %1\data\nosound
+del %1\baseset\nosound\*.* /n
+rmdir %1\baseset\nosound
echo NoSound has been removed.
goto end
diff --git a/os/os2/installer/remove_opengfx.cmd b/os/os2/installer/remove_opengfx.cmd
index 3efe7a7d5..71465d167 100644
--- a/os/os2/installer/remove_opengfx.cmd
+++ b/os/os2/installer/remove_opengfx.cmd
@@ -3,8 +3,8 @@ if "%1" == "" goto err
echo Removing OpenGFX...
-del %1\data\opengfx\*.* /n
-rmdir %1\data\opengfx
+del %1\baseset\opengfx\*.* /n
+rmdir %1\baseset\opengfx
echo OpenGFX has been removed.
goto end
diff --git a/os/os2/installer/remove_opensfx.cmd b/os/os2/installer/remove_opensfx.cmd
index fdd88b9de..361a870e3 100644
--- a/os/os2/installer/remove_opensfx.cmd
+++ b/os/os2/installer/remove_opensfx.cmd
@@ -3,8 +3,8 @@ if "%1" == "" goto err
echo Removing OpenSFX...
-del %1\data\opensfx\*.* /n
-rmdir %1\data\opensfx
+del %1\baseset\opensfx\*.* /n
+rmdir %1\baseset\opensfx
echo OpenSFX has been removed.
goto end
diff --git a/os/rpm/openttd.spec b/os/rpm/openttd.spec
index 00de72dc0..85f0498d3 100644
--- a/os/rpm/openttd.spec
+++ b/os/rpm/openttd.spec
@@ -117,7 +117,7 @@ way it is possible to install a openttd version without SDL requirement.
%setup -qn openttd%{?branch:-%{branch}}-%{srcver}
# we build the grfs from sources but validate the result with the existing data
-md5sum bin/data/* > validate.data
+md5sum bin/baseset/* > validate.data
%build
./configure \
@@ -183,16 +183,14 @@ md5sum -c validate.data
%dir %{_datadir}/doc/%{binname}
%dir %{_datadir}/%{binname}
%dir %{_datadir}/%{binname}/lang
-%dir %{_datadir}/%{binname}/data
-%dir %{_datadir}/%{binname}/gm
+%dir %{_datadir}/%{binname}/baseset
%dir %{_datadir}/%{binname}/scripts
%dir %{_datadir}/%{binname}/ai
%{_datadir}/doc/%{binname}/*
%{_datadir}/%{binname}/lang/*
-%{_datadir}/%{binname}/data/*
+%{_datadir}/%{binname}/baseset/*
%{_datadir}/%{binname}/scripts/*
%{_datadir}/%{binname}/ai/*
-%{_datadir}/%{binname}/gm/*
%doc %{_mandir}/man6/%{binname}.6.*
%endif
diff --git a/os/windows/installer/install.nsi b/os/windows/installer/install.nsi
index db0f1c170..536e28c36 100644
--- a/os/windows/installer/install.nsi
+++ b/os/windows/installer/install.nsi
@@ -125,15 +125,12 @@ Section "!OpenTTD" Section1
File ${PATH_ROOT}bin\ai\compat_*.nut
; Copy data files
- SetOutPath "$INSTDIR\data\"
- File ${PATH_ROOT}bin\data\*.grf
- File ${PATH_ROOT}bin\data\*.obg
- File ${PATH_ROOT}bin\data\*.obs
- File ${PATH_ROOT}bin\data\opntitle.dat
-
- ; Copy the music base metadata files
- SetOutPath "$INSTDIR\gm\"
- File ${PATH_ROOT}bin\gm\*.obm
+ SetOutPath "$INSTDIR\baseset\"
+ File ${PATH_ROOT}bin\baseset\*.grf
+ File ${PATH_ROOT}bin\baseset\*.obg
+ File ${PATH_ROOT}bin\baseset\*.obm
+ File ${PATH_ROOT}bin\baseset\*.obs
+ File ${PATH_ROOT}bin\baseset\opntitle.dat
; Copy the scripts
SetOutPath "$INSTDIR\scripts\"
@@ -171,12 +168,30 @@ Section "!OpenTTD" Section1
File /oname=openttd.exe ${BINARY_DIR}\openttd.exe
- ; Delete old files from the main dir. they are now placed in data/ and lang/
+ ; Delete old files from the main dir. they are now placed in baseset/ and lang/
Delete "$INSTDIR\*.lng"
Delete "$INSTDIR\*.grf"
Delete "$INSTDIR\sample.cat"
Delete "$INSTDIR\ttd.exe"
-
+ Delete "$INSTDIR\data\opntitle.dat"
+ Delete "$INSTDIR\data\2ccmap.grf"
+ Delete "$INSTDIR\data\airports.grf"
+ Delete "$INSTDIR\data\autorail.grf"
+ Delete "$INSTDIR\data\canalsw.grf"
+ Delete "$INSTDIR\data\dosdummy.grf"
+ Delete "$INSTDIR\data\elrailsw.grf"
+ Delete "$INSTDIR\data\nsignalsw.grf"
+ Delete "$INSTDIR\data\openttd.grf"
+ Delete "$INSTDIR\data\roadstops.grf"
+ Delete "$INSTDIR\data\trkfoundw.grf"
+ Delete "$INSTDIR\data\openttdd.grf"
+ Delete "$INSTDIR\data\openttdw.grf"
+ Delete "$INSTDIR\data\orig_win.obg"
+ Delete "$INSTDIR\data\orig_dos.obg"
+ Delete "$INSTDIR\data\orig_dos_de.obg"
+ Delete "$INSTDIR\data\orig_win.obs"
+ Delete "$INSTDIR\data\orig_dos.obs"
+ Delete "$INSTDIR\data\no_sound.obs"
; Create the Registry Entries
WriteRegStr HKEY_LOCAL_MACHINE "SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\OpenTTD" "Comments" "Visit ${APPURLLINK}"
@@ -224,17 +239,17 @@ SectionEnd
Section "Download OpenGFX (free graphics set)" Section3
SetOverwrite try
- NSISdl::download "http://binaries.openttd.org/installer/opengfx-${OPENGFX_BASE_VERSION}.7z" "$INSTDIR\data\opengfx.7z"
+ NSISdl::download "http://binaries.openttd.org/installer/opengfx-${OPENGFX_BASE_VERSION}.7z" "$INSTDIR\baseset\opengfx.7z"
Pop $R0 ;Get the return value
StrCmp $R0 "success" +3
MessageBox MB_OK "Downloading of OpenGFX failed"
Goto Done
; Let's extract the files
- SetOutPath "$INSTDIR\data\"
- NSIS7z::Extract "$INSTDIR\data\opengfx.7z"
+ SetOutPath "$INSTDIR\baseset\"
+ NSIS7z::Extract "$INSTDIR\baseset\opengfx.7z"
- Delete "$INSTDIR\data\opengfx.7z"
+ Delete "$INSTDIR\baseset\opengfx.7z"
SetOutPath "$INSTDIR\"
Done:
@@ -245,17 +260,17 @@ SectionEnd
Section "Download OpenSFX (free sound set)" Section4
SetOverwrite try
- NSISdl::download "http://binaries.openttd.org/installer/opensfx-${OPENSFX_BASE_VERSION}.7z" "$INSTDIR\data\opensfx.7z"
+ NSISdl::download "http://binaries.openttd.org/installer/opensfx-${OPENSFX_BASE_VERSION}.7z" "$INSTDIR\baseset\opensfx.7z"
Pop $R0 ;Get the return value
StrCmp $R0 "success" +3
MessageBox MB_OK "Downloading of OpenSFX failed"
Goto Done
; Let's extract the files
- SetOutPath "$INSTDIR\data\"
- NSIS7z::Extract "$INSTDIR\data\opensfx.7z"
+ SetOutPath "$INSTDIR\baseset\"
+ NSIS7z::Extract "$INSTDIR\baseset\opensfx.7z"
- Delete "$INSTDIR\data\opensfx.7z"
+ Delete "$INSTDIR\baseset\opensfx.7z"
SetOutPath "$INSTDIR\"
Done:
@@ -287,22 +302,21 @@ SectionEnd
Section /o "Copy data from Transport Tycoon Deluxe CD-ROM" Section2
SetOverwrite try
; Let's copy the files with size approximation
- SetOutPath "$INSTDIR\gm"
- CopyFiles "$CDDRIVE\gm\*.gm" "$INSTDIR\gm\" 1028
- SetOutPath "$INSTDIR\data\"
- CopyFiles "$CDDRIVE\sample.cat" "$INSTDIR\data\sample.cat" 1566
+ SetOutPath "$INSTDIR\baseset"
+ CopyFiles "$CDDRIVE\gm\*.gm" "$INSTDIR\baseset\" 1028
+ CopyFiles "$CDDRIVE\sample.cat" "$INSTDIR\baseset\sample.cat" 1566
; Copy Windows files
- CopyFiles "$CDDRIVE\trg1r.grf" "$INSTDIR\data\trg1r.grf" 2365
- CopyFiles "$CDDRIVE\trgcr.grf" "$INSTDIR\data\trgcr.grf" 260
- CopyFiles "$CDDRIVE\trghr.grf" "$INSTDIR\data\trghr.grf" 400
- CopyFiles "$CDDRIVE\trgir.grf" "$INSTDIR\data\trgir.grf" 334
- CopyFiles "$CDDRIVE\trgtr.grf" "$INSTDIR\data\trgtr.grf" 546
+ CopyFiles "$CDDRIVE\trg1r.grf" "$INSTDIR\baseset\trg1r.grf" 2365
+ CopyFiles "$CDDRIVE\trgcr.grf" "$INSTDIR\baseset\trgcr.grf" 260
+ CopyFiles "$CDDRIVE\trghr.grf" "$INSTDIR\baseset\trghr.grf" 400
+ CopyFiles "$CDDRIVE\trgir.grf" "$INSTDIR\baseset\trgir.grf" 334
+ CopyFiles "$CDDRIVE\trgtr.grf" "$INSTDIR\baseset\trgtr.grf" 546
; Copy DOS files
- CopyFiles "$CDDRIVE\trg1.grf" "$INSTDIR\data\trg1.grf" 2365
- CopyFiles "$CDDRIVE\trgc.grf" "$INSTDIR\data\trgc.grf" 260
- CopyFiles "$CDDRIVE\trgh.grf" "$INSTDIR\data\trgh.grf" 400
- CopyFiles "$CDDRIVE\trgi.grf" "$INSTDIR\data\trgi.grf" 334
- CopyFiles "$CDDRIVE\trgt.grf" "$INSTDIR\data\trgt.grf" 546
+ CopyFiles "$CDDRIVE\trg1.grf" "$INSTDIR\baseset\trg1.grf" 2365
+ CopyFiles "$CDDRIVE\trgc.grf" "$INSTDIR\baseset\trgc.grf" 260
+ CopyFiles "$CDDRIVE\trgh.grf" "$INSTDIR\baseset\trgh.grf" 400
+ CopyFiles "$CDDRIVE\trgi.grf" "$INSTDIR\baseset\trgi.grf" 334
+ CopyFiles "$CDDRIVE\trgt.grf" "$INSTDIR\baseset\trgt.grf" 546
SetOutPath "$INSTDIR\"
SectionEnd
@@ -388,46 +402,49 @@ Section "Uninstall"
; AI files
Delete "$INSTDIR\ai\compat_*.nut"
- ; Data files
- Delete "$INSTDIR\data\opntitle.dat"
-
- Delete "$INSTDIR\data\2ccmap.grf"
- Delete "$INSTDIR\data\airports.grf"
- Delete "$INSTDIR\data\autorail.grf"
- Delete "$INSTDIR\data\canalsw.grf"
- Delete "$INSTDIR\data\dosdummy.grf"
- Delete "$INSTDIR\data\elrailsw.grf"
- Delete "$INSTDIR\data\nsignalsw.grf"
- Delete "$INSTDIR\data\openttd.grf"
- Delete "$INSTDIR\data\roadstops.grf"
- Delete "$INSTDIR\data\trkfoundw.grf"
- Delete "$INSTDIR\data\openttdd.grf"
- Delete "$INSTDIR\data\openttdw.grf"
- Delete "$INSTDIR\data\orig_win.obg"
- Delete "$INSTDIR\data\orig_dos.obg"
- Delete "$INSTDIR\data\orig_dos_de.obg"
- Delete "$INSTDIR\data\orig_win.obs"
- Delete "$INSTDIR\data\orig_dos.obs"
- Delete "$INSTDIR\data\no_sound.obs"
+ ; Baseset files
+ Delete "$INSTDIR\baseset\opntitle.dat"
+ Delete "$INSTDIR\baseset\openttd.grf"
+ Delete "$INSTDIR\baseset\orig_win.obg"
+ Delete "$INSTDIR\baseset\orig_dos.obg"
+ Delete "$INSTDIR\baseset\orig_dos_de.obg"
+ Delete "$INSTDIR\baseset\orig_win.obs"
+ Delete "$INSTDIR\baseset\orig_dos.obs"
+ Delete "$INSTDIR\baseset\no_sound.obs"
+ Delete "$INSTDIR\baseset\sample.cat"
+ Delete "$INSTDIR\baseset\trg1r.grf"
+ Delete "$INSTDIR\baseset\trghr.grf"
+ Delete "$INSTDIR\baseset\trgtr.grf"
+ Delete "$INSTDIR\baseset\trgcr.grf"
+ Delete "$INSTDIR\baseset\trgir.grf"
+ Delete "$INSTDIR\baseset\trg1.grf"
+ Delete "$INSTDIR\baseset\trgh.grf"
+ Delete "$INSTDIR\baseset\trgt.grf"
+ Delete "$INSTDIR\baseset\trgc.grf"
+ Delete "$INSTDIR\baseset\trgi.grf"
+ Delete "$INSTDIR\baseset\*.gm"
Delete "$INSTDIR\data\sample.cat"
- ; Windows Data files
Delete "$INSTDIR\data\trg1r.grf"
Delete "$INSTDIR\data\trghr.grf"
Delete "$INSTDIR\data\trgtr.grf"
Delete "$INSTDIR\data\trgcr.grf"
Delete "$INSTDIR\data\trgir.grf"
- ; Dos Data files
Delete "$INSTDIR\data\trg1.grf"
Delete "$INSTDIR\data\trgh.grf"
Delete "$INSTDIR\data\trgt.grf"
Delete "$INSTDIR\data\trgc.grf"
Delete "$INSTDIR\data\trgi.grf"
-
- ; Music
Delete "$INSTDIR\gm\*.gm"
; Downloaded OpenGFX/OpenSFX/OpenMSX
+ Delete "$INSTDIR\baseset\opengfx\*"
+ RMDir "$INSTDIR\baseset\opengfx"
+ Delete "$INSTDIR\baseset\opensfx\*"
+ RMDir "$INSTDIR\baseset\opensfx"
+ Delete "$INSTDIR\baseset\openmsx\*"
+ RMDir "$INSTDIR\baseset\openmsx"
+
Delete "$INSTDIR\data\opengfx\*"
RMDir "$INSTDIR\data\opengfx"
Delete "$INSTDIR\data\opensfx\*"
@@ -447,6 +464,8 @@ Section "Uninstall"
; Base sets for music
Delete "$INSTDIR\gm\orig_win.obm"
Delete "$INSTDIR\gm\no_music.obm"
+ Delete "$INSTDIR\baseset\orig_win.obm"
+ Delete "$INSTDIR\baseset\no_music.obm"
; Remove remaining directories
RMDir "$SMPROGRAMS\$SHORTCUTS\Extras\"
@@ -455,6 +474,7 @@ Section "Uninstall"
RMDir "$SMPROGRAMS\$SHORTCUTS"
RMDir "$INSTDIR\ai"
RMDir "$INSTDIR\data"
+ RMDir "$INSTDIR\baseset"
RMDir "$INSTDIR\gm"
RMDir "$INSTDIR\lang"
RMDir "$INSTDIR\scripts"
diff --git a/readme.txt b/readme.txt
index 2f6bc565f..11163a809 100644
--- a/readme.txt
+++ b/readme.txt
@@ -189,7 +189,7 @@ an AI a message will be shown that the 'dummy' AI has been started.
4.1) (Required) 3rd party files
---- --------------------------
-Before you run OpenTTD, you need to put the game's data files into a data/
+Before you run OpenTTD, you need to put the game's data files into a baseset/
directory which can be located in various places addressed in the following
section.
@@ -227,10 +227,11 @@ You need to copy the following files:
4.1.3) Original Transport Tycoon Deluxe music
------ --------------------------------------
-If you want the Transport Tycoon Deluxe music, copy the gm/ folder from the
-Windows version of Transport Tycoon Deluxe to your OpenTTD folder (not your
-data folder - also explained in the following sections). The music from the
-DOS version as well as the original Transport Tycoon does not work.
+If you want the Transport Tycoon Deluxe music, copy the files from the gm/
+folder from the Windows version of Transport Tycoon Deluxe to the baseset
+folder in your OpenTTD folder (also explained in the following sections).
+The music from the DOS version as well as the original Transport Tycoon does
+not work.
4.1.4) AIs
------ ---
@@ -283,11 +284,11 @@ Different types of data or extensions go into different subdirectories of the ch
OpenTTD directory:
Config File: (no subdirectory)
Screenshots: (no subdirectory)
- Base Graphics: data (or a subdirectory thereof)
- Sound Sets: data (or a subdirectory thereof)
- NewGRFs: data (or a subdirectory thereof)
- 32bpp Sets: data (or a subdirectory thereof)
- Music Sets: gm (or a subdirectory thereof)
+ Base Graphics: baseset (or a subdirectory thereof)
+ Sound Sets: baseset (or a subdirectory thereof)
+ NewGRFs: newgrf (or a subdirectory thereof)
+ 32bpp Sets: newgrf (or a subdirectory thereof)
+ Music Sets: baseset (or a subdirectory thereof)
AIs: ai (or a subdirectory thereof)
AI Libraries: ai/libraries (or a subdirectory thereof)
Savegames: save
@@ -315,12 +316,12 @@ personal directory (where the game will then also place savegames and screenshot
You can install OpenTTD on external media so you can take it with you, i.e.
using a USB key, or a USB HDD, etc.
Create a directory where you shall store the game in (i.e. OpenTTD/).
-Copy the binary (OpenTTD.exe, OpenTTD.app, openttd, etc), data/ and your
+Copy the binary (OpenTTD.exe, OpenTTD.app, openttd, etc), baseset/ and your
openttd.cfg to this directory.
You can copy binaries for any operating system into this directory, which will
allow you to play the game on nearly any computer you can attach the external
media to.
-As always - additional grf files are stored in the data/ dir (for details,
+As always - additional grf files are stored in the newgrf/ dir (for details,
again, see section 4.1).
@@ -583,7 +584,7 @@ can be viewed in the NewGRF window accessible from the file load dialogue window
You can try to obtain the missing files from that NewGRF dialogue or - if they
are not available online - you can search manually through our forum's graphics
development section (http://www.tt-forums.net/viewforum.php?f=66) or GrfCrawler
-(http://grfcrawler.tt-forums.net/). Put the NewGRF files in OpenTTD's data folder
+(http://grfcrawler.tt-forums.net/). Put the NewGRF files in OpenTTD's newgrf folder
(see section 4.2 "OpenTTD directories") and rescan the list of available NewGRFs.
Once you have all missing files, you are set to go.