Difference between revisions of "Compiling ScummVM/iPhone"

Jump to navigation Jump to search

Compiling ScummVM/iPhone (view source)

Revision as of 23:20, 28 October 2019

4,829 bytes added ,  23:20, 28 October 2019
→‎Compile and Deploy: Add comment about the need to disable bitcode generation option
(Add some instructions to build with Xcode)
(→‎Compile and Deploy: Add comment about the need to disable bitcode generation option)
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page explains how to compile your own version of [[ScummVM]] using the [[iPhone]] or [[[iOS7]] backend.
This page explains how to compile your own version of [[ScummVM]] using the [[iPhone]] or [[iOS7]] backend.


= Using XCode =
= Using Xcode =


You can compile ScummVM with the official tools from Apple and get it to work on your non-jailbroken iPhone or iPad.
You can compile ScummVM with the official tools from Apple. This is the recommended way to compile ScummVM, and the only one which makes it possible to run ScummVM on a non-jailbroken iPhone or iPad devices!


== Requirements ==
== Requirements ==
Line 12: Line 12:
* iOS libraries used by ScummVM. There is a link to a convenient package below in the build instruction.
* iOS libraries used by ScummVM. There is a link to a convenient package below in the build instruction.


Note: with a free developer account iOS App that you build will only be valid for 7 days and you will thus need to recompile and reinstall them each week.
''Note:'' with a free developer account iOS App that you build will only be valid for 7 days and you will thus need to recompile and reinstall them each week.


== Creating the Xcode project ==
== Creating the Xcode project ==
Clone the ScummVM repository from GitHub to get the source code:
Clone the ScummVM repository from GitHub to get the source code:
<source lang="bash">
<syntaxhighlight lang="bash">
git clone https://github.com/scummvm/scummvm.git
git clone https://github.com/scummvm/scummvm.git
</source>
</syntaxhighlight>


Generate the create_project tool:
Generate the create_project tool:
<source lang="bash">
<syntaxhighlight lang="bash">
cd scummvm/devtools/create_project/xcode
cd scummvm/devtools/create_project/xcode
xcodebuild
xcodebuild
</source>
</syntaxhighlight>
''Note:'' you may need to run xcodebuild with sudo the first time ('sudo xcodebuild') if the Xcode command line tools are not yet installed. Command line tools can also be installed from Xcode or using 'sudo xcode-select --install'


Create a build directory, extract the [https://www.scummvm.org/frs/build/scummvm-ios7-libs.zip iOS libraries package] and generate the Xcode project
Create a build directory:
<source lang="bash">
<syntaxhighlight lang="bash">
cd ../../../..
cd ../../../..
mkdir build
mkdir build
cd build
cd build
</source>
</syntaxhighlight>


Download the [https://www.scummvm.org/frs/build/scummvm-ios7-libs.zip iOS libraries package] and extract them in the build directory:
Download the [https://www.scummvm.org/frs/build/scummvm-ios7-libs-v2.zip iOS libraries package] and extract them in the build directory:
<source lang="bash">
<syntaxhighlight lang="bash">
unzip ~/Downloads/ScummVM-iOS-libraries.zip
unzip ~/Downloads/scummvm-ios7-libs-v2.zip
</source>
</syntaxhighlight>


Generate Xcode project and open it:
Generate Xcode project and open it:
<source lang="bash">
<syntaxhighlight lang="bash">
../scummvm/devtools/create_project/xcode/build/Release/create_project ../scummvm --xcode --enable-fluidsynth --disable-bink --disable-mt32emu --disable-nasm --disable-opengl --disable-theora --disable-taskbar --disable-libcurl --disable-sdlnet
../scummvm/devtools/create_project/xcode/build/Release/create_project ../scummvm --xcode --enable-fluidsynth --disable-bink --disable-nasm --disable-opengl --disable-theora --disable-taskbar --disable-tts
</syntaxhighlight>
 
At this point your build directory should contain:
* a generated '''engines''' directory
* a generated '''scummvm.xcodeproj''' project
* an '''include''' directory
* a '''lib''' directory
 
You are now ready to compile ScummVM. First open the project in Xcode:
<syntaxhighlight lang="bash">
open scummvm.xcodeproj
open scummvm.xcodeproj
</source>
</syntaxhighlight>
''Note:'' you can also double-click on the ''scummvm.xcodeproj'' file in the Finder to open it with Xcode.


== Compile and Deploy ==
== Compile and Deploy ==
Line 50: Line 62:
* In the project ''General'' settings you need to specify a unique ''Bundle Identifier'' (for example ''org.yourname.scummvm'').
* In the project ''General'' settings you need to specify a unique ''Bundle Identifier'' (for example ''org.yourname.scummvm'').
* You need to configure the ``Signing`` settings. Add an account by using your Apple ID if needed and then select it.
* You need to configure the ``Signing`` settings. Add an account by using your Apple ID if needed and then select it.
* You may need to disable bitcode generation in the build settings. This should already be disabled by default when you make a build specifically for your device, but it is enabled by default when you build for a ''Generic iOS Device''.


Then click on the Play button in the top left of the window to start the build. The App will be automatically installed on your device at the end of the build.
Then click on the Play button in the top left of the window to start the build. The App will be automatically installed on your device at the end of the build.
Line 59: Line 73:
There are some outdated instructions on [http://blog.pmlabs-apps.com/scummvm-on-ios-without-jailbreak/ this blog] that may still be useful as it is illustrated and has more details.
There are some outdated instructions on [http://blog.pmlabs-apps.com/scummvm-on-ios-without-jailbreak/ this blog] that may still be useful as it is illustrated and has more details.


= Using the command line =
For jailbroken devices, it is also possible to compile the project from command line. You'll need a working toolchain, and some tools, like '''ldid''', to fake the code signature.
Here is a script to download, and compile all the required tools. This script has been wrote for Debian 8.2, and should be run as root.
<syntaxhighlight lang="bash">
#!/bin/bash
if [ $UID -ne 0 ]; then
echo "This script should be run by the root user"
exit 1
fi
# Install the Clang compiler
apt-get install -y clang-3.4 libclang-3.4-dev llvm-3.4 libtool bison flex automake subversion git pkg-config wget libssl-dev uuid-dev libxml2-dev || exit 1
# Add LLVM to the linker library path
echo /usr/lib/llvm-3.4/lib > /etc/ld.so.conf.d/libllvm-3.4.conf
ldconfig
# Add symlinks for the LLVM headers
ln -s /usr/lib/llvm-3.4/bin/llvm-config /usr/bin/llvm-config || exit 1
ln -s /usr/include/llvm-3.4/llvm /usr/include/llvm || exit 1
ln -s /usr/include/llvm-c-3.4/llvm-c /usr/include/llvm-c || exit 1
ln -s /usr/bin/clang-3.4 /usr/bin/clang || exit 1
ln -s /usr/bin/clang++-3.4 /usr/bin/clang++ || exit 1
# Build the linker
svn checkout http://ios-toolchain-based-on-clang-for-linux.googlecode.com/svn/trunk/cctools-porting || exit 1
cd cctools-porting
sed -i'' 's/proz -k=20  --no-curses/wget/g' cctools-ld64.sh
./cctools-ld64.sh || exit 1
cd cctools-855-ld64-236.3
./autogen.sh || exit 1
./configure --prefix=/usr/local --target=arm-apple-darwin11 || exit 1
make || exit 1
make install || exit 1
cd ../..
# Install ios-tools
wget https://ios-toolchain-based-on-clang-for-linux.googlecode.com/files/iphonesdk-utils-2.0.tar.gz || exit 1
tar xzf iphonesdk-utils-2.0.tar.gz
cd iphonesdk-utils-2.0
patch -p0 <<_EOF
*** genLocalization2/getLocalizedStringFromFile.cpp    2015-04-02 04:45:39.309837816 +0530
--- genLocalization2/getLocalizedStringFromFile.cpp    2015-04-02 04:45:11.525700021 +0530
***************
*** 113,115 ****
      clang::HeaderSearch headerSearch(headerSearchOptions,
-                                      fileManager,
                                      *pDiagnosticsEngine,
--- 113,115 ----
      clang::HeaderSearch headerSearch(headerSearchOptions,
+                                      sourceManager,
                                      *pDiagnosticsEngine,
***************
*** 129,134 ****
                  false);
-    clang::HeaderSearch headerSearch(fileManager,
                                      *pDiagnosticsEngine,
                                      languageOptions,
-                                      pTargetInfo);
      ApplyHeaderSearchOptions(headerSearch, headerSearchOptions, languageOptions, pTargetInfo->getTriple());
--- 129,134 ----
                  false);
+    clang::HeaderSearch headerSearch(fileManager);/*,
                                      *pDiagnosticsEngine,
                                      languageOptions,
+                                      pTargetInfo);*/
      ApplyHeaderSearchOptions(headerSearch, headerSearchOptions, languageOptio
_EOF
./autogen.sh || exit 1
CC=clang CXX=clang++ ./configure --prefix=/usr/local || exit 1
make || exit 1
make install || exit 1
# Install the iOS SDK 8.1
mkdir -p /usr/share/ios-sdk
cd /usr/share/ios-sdk
wget http://iphone.howett.net/sdks/dl/iPhoneOS8.1.sdk.tbz2 || exit 1
tar xjf iPhoneOS8.1.sdk.tbz2
rm iPhoneOS8.1.sdk.tbz2
</syntaxhighlight>
Now, in order to compile ScummVM, execute the following commands:
<syntaxhighlight lang="bash">
export SDKROOT=/usr/share/ios-sdk/iPhoneOS8.1.sdk
export CC=ios-clang
export CXX=ios-clang++
./configure --host=ios7 --disable-mt32emu --enable-release
make ios7bundle
</syntaxhighlight>
At the end of the compilation, you'll find a '''ScummVM.app''' application: copy it over SSH, and reboot your device.


= Cross-Compilation =
= Cross-Compilation =
Line 89: Line 199:


* For ''iphone'' use:
* For ''iphone'' use:
<source lang="bash">
<syntaxhighlight lang="bash">
export TARGET=arm-apple-darwin9
export TARGET=arm-apple-darwin9
</source>
</syntaxhighlight>


* For ''ios7'' use:
* For ''ios7'' use:
<source lang="bash">
<syntaxhighlight lang="bash">
export TARGET=arm-apple-darwin11
export TARGET=arm-apple-darwin11
</source>
</syntaxhighlight>


==== Setting up the Environment ====
==== Setting up the Environment ====


<source lang="bash">
<syntaxhighlight lang="bash">
export PATH="$IOS_TOOLCHAIN_BASE/bin:$IOS_TOOLCHAIN_BASE/$TARGET/bin:$IOS_TOOLCHAIN_BASE/$TARGET/usr/bin:$PATH"
export PATH="$IOS_TOOLCHAIN_BASE/bin:$IOS_TOOLCHAIN_BASE/$TARGET/bin:$IOS_TOOLCHAIN_BASE/$TARGET/usr/bin:$PATH"
export CPPFLAGS="-isystem $IOS_TOOLCHAIN_BASE/$TARGET/usr/include"
export CPPFLAGS="-isystem $IOS_TOOLCHAIN_BASE/$TARGET/usr/include"
export LDFLAGS="-L$IOS_TOOLCHAIN_BASE/$TARGET/usr/lib"
export LDFLAGS="-L$IOS_TOOLCHAIN_BASE/$TARGET/usr/lib"
</source>
</syntaxhighlight>
Where ''IOS_TOOLCHAIN_BASE'' contains the directory where you installed the toolchain. And ''TRAGET'' has been setup from the previous step.
Where ''IOS_TOOLCHAIN_BASE'' contains the directory where you installed the toolchain. And ''TRAGET'' has been setup from the previous step.


Line 115: Line 225:
First, navigate to a path where you want your build files to be located (this can be the ScummVM root directory but does not have to be).
First, navigate to a path where you want your build files to be located (this can be the ScummVM root directory but does not have to be).
Then run the following:
Then run the following:
<source lang="bash">
<syntaxhighlight lang="bash">
./path/to/scummvm/configure --host=ios7 --with-staticlib-prefix=$IOS_TOOLCHAIN_BASE/$TARGET/usr
./path/to/scummvm/configure --host=ios7 --with-staticlib-prefix=$IOS_TOOLCHAIN_BASE/$TARGET/usr
</source>
</syntaxhighlight>
Replace ''ios7'' with ''iphone'' if you want to build the older version of our iOS backend.
Replace ''ios7'' with ''iphone'' if you want to build the older version of our iOS backend.


Line 123: Line 233:


You can compile ScummVM with running make:
You can compile ScummVM with running make:
<source lang="bash">
<syntaxhighlight lang="bash">
make iphone
make iphone
</source>
</syntaxhighlight>
If you simply want to test whether changes you made compile but do not plan to use the binary for deployment you can also simply run ''make''.
If you simply want to test whether changes you made compile but do not plan to use the binary for deployment you can also simply run ''make''.


Please note that if you want to deploy ScummVM on your iOS device you will need to generate a bundle file. For this run either:
Please note that if you want to deploy ScummVM on your iOS device you will need to generate a bundle file. For this run either:
<source lang="bash">
<syntaxhighlight lang="bash">
make ios7bundle
make ios7bundle
</source>
</syntaxhighlight>
for the ''ios7'' backend. Or
for the ''ios7'' backend. Or
<source lang="bash">
<syntaxhighlight lang="bash">
make iphonebundle
make iphonebundle
</source>
</syntaxhighlight>
for the ''iphone'' backend.
for the ''iphone'' backend.


Then simply upload the whole ScummVM.app directory to your device under the /Applications folder, and you're done!
Then simply upload the whole ScummVM.app directory to your device under the /Applications folder, and you're done!
Criezy
TrustedUser
2,147

edits

Retrieved from "https://wiki.scummvm.org/index.php?title=Special:MobileDiff/24011...25821"

Navigation menu