Open main menu
ScummVM :: Wiki

Difference between revisions of "Compiling ScummVM/iPhone"

Compiling ScummVM/iPhone (view source)

Revision as of 23:49, 19 October 2019

7,598 bytes added ,  23:49, 19 October 2019
→‎Creating the Xcode project: TTS is not yet available on iOS
(→‎Creating the Xcode project: TTS is not yet available on iOS)
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This page explains how to compile your own version of [[ScummVM]] using the [[iPhone]] backend.
This page explains how to compile your own version of [[ScummVM]] using the [[iPhone]] or [[iOS7]] backend.


= Official SDK =
= Using Xcode =
* Do an Git clone of: git://github.com/scummvm/scummvm.git
* Download http://worldsmainorganization.org/scummvm/?dir=&download=scummvm-iphone-libs.tar.gz and extract it to the dists/iphone folder.
* Open up dists/iphone/scummvm.xcodeproj
* Compile away!


= Unofficial SDK =
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!


== Setup ==
== Requirements ==
You will need:
* a macOS computer
* Xcode (you can get it for free from the Mac App Store)
* A developer account. You can create one for free using your Apple ID (the same one used for iCloud or the Mac App Store) on the [https://developer.apple.com/membercenter/ Apple Developer Member Center].
* 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.
 
== Creating the Xcode project ==
Clone the ScummVM repository from GitHub to get the source code:
<syntaxhighlight lang="bash">
git clone https://github.com/scummvm/scummvm.git
</syntaxhighlight>
 
Generate the create_project tool:
<syntaxhighlight lang="bash">
cd scummvm/devtools/create_project/xcode
xcodebuild
</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:
<syntaxhighlight lang="bash">
cd ../../../..
mkdir build
cd build
</syntaxhighlight>
 
Download the [https://www.scummvm.org/frs/build/scummvm-ios7-libs-v2.zip iOS libraries package] and extract them in the build directory:
<syntaxhighlight lang="bash">
unzip ~/Downloads/scummvm-ios7-libs-v2.zip
</syntaxhighlight>
 
Generate Xcode project and open it:
<syntaxhighlight lang="bash">
../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
</syntaxhighlight>
''Note:'' you can also double-click on the ''scummvm.xcodeproj'' file in the Finder to open it with Xcode.
 
== Compile and Deploy ==
In Xcode you need to configure the scummvm project:
* Connect your iPhone or iPad to your Mac.
* Select your iOS device (iPhone or iPad) at the top of the window (in the title bar).
* 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.
 
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.
 
 
'''TODO:''' Add a bit 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 =
 
Please note binaries generated with these instructions only work with jailbroken devices.
 
== Toolchain Setup ==


=== Toolchain ===
=== Toolchain ===
First, you'll need to set up the [http://www.saurik.com/id/4 toolchain]. Earlier versions than the one linked will NOT work.


=== Environment variables ===
First you need to set up a toolchain for cross-compilation. On our buildbot we use [https://github.com/lordhoto/ios-toolchain this toolchain]. It is based on LLVM/Clang and contains instructions on how to set it up.
You'll need to set some environment variables for both the external libraries, and ScummVM itself. This is so the right compiler and libraries will be used.


<pre>
=== External libs ===
export SDKROOT=<your toolkit directory>
export SYSROOT="$SDKROOT/sys"
export BUILDENV="$SDKROOT/pre"
export FDIR="$SYSROOT"
export CC="$BUILDENV/bin/arm-apple-darwin9-gcc -v"
export CXX="$BUILDENV/bin/arm-apple-darwin9-g++"
export LD=$CC
export SHAREDOPTS="-isysroot $SYSROOT -fobjc-abi-version=2 -I$SDKROOT/include"
export FRAMEWORKS="-F$FDIR/System/Library/PrivateFrameworks/ -F$FDIR/System/Library/Frameworks/"
export LDFLAGS="-L$BUILDENV/arm-apple-darwin9/lib/ $FRAMEWORKS $SHAREDOPTS -bind_at_load -lobjc"
export CXXFLAGS="-I$SYSROOT/usr/include $SHAREDOPTS"
export OBJCFLAGS="-I$SYSROOT/usr/include/ $SHAREDOPTS --std=c99"
export CFLAGS="$CXXFLAGS"
export AS=$SDKROOT/pre/bin/arm-apple-darwin9-as
</pre>


In the previously linked toolchain a script to compile all libraries used by the iOS version of ScummVM is contained. Please refer to the toolchain's README file on how to build them.


=== External libs ===
== Building ScummVM ==
Then, set up any of the external libs you might want. Meaning libMAD for MP3 playback, libFLAC for FLAC support and/or Tremor for Ogg support.
 
=== Configuration ===
 
Before we can compile ScummVM we need to configure the source tree for building. This is usually only required once or when you want to alter build options.
 
==== Choosing an iOS target ====
 
We feature two different iOS backends:
* ''iphone'': Our legacy iOS backend, which supports all iOS3+ devices.
* ''ios7'': Our modern iOS7+ backend, which only supports iOS7+ devices but features better integration for these.


Note that you only need to add these if you need support for those filetypes. ScummVM itself will run fine without them. You can also download the already compiled libraries from the link in the Official SDK section above.
Depending on which backend you use you will need to use a different value for the ''TARGET'' environment variable.


The below should usually do the trick for these:
* For ''iphone'' use:
<pre>
<syntaxhighlight lang="bash">
./configure --host=arm-darwin --prefix=$SDKROOT/sys/
export TARGET=arm-apple-darwin9
make && make install
</syntaxhighlight>
</pre>


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


Then, we need to configure ScummVM itself.
==== Setting up the Environment ====


<pre>
<syntaxhighlight lang="bash">
./configure --host=iphone \
export PATH="$IOS_TOOLCHAIN_BASE/bin:$IOS_TOOLCHAIN_BASE/$TARGET/bin:$IOS_TOOLCHAIN_BASE/$TARGET/usr/bin:$PATH"
--disable-mt32emu --disable-scalers  --enable-release \
export CPPFLAGS="-isystem $IOS_TOOLCHAIN_BASE/$TARGET/usr/include"
--with-flac-prefix=/$SYSROOT/usr/local \
export LDFLAGS="-L$IOS_TOOLCHAIN_BASE/$TARGET/usr/lib"
--with-mad-prefix=/$SYSROOT/usr/local \
</syntaxhighlight>
--with-tremor-prefix=/$SYSROOT/usr/local
Where ''IOS_TOOLCHAIN_BASE'' contains the directory where you installed the toolchain. And ''TRAGET'' has been setup from the previous step.
</pre>


Note that the --with-flac-prefix (and the rest) is only necessary if you want to include support for that specific library.
'''NOTE''': If you quit the shell you are using when configuring ScummVM and pick up compilation later, you will need to re-export only the ''PATH'' variable like described above.


If you've installed the external libs in any other place than $SYSROOT/usr/local, you need to use that location instead.
==== Configuring the Build ====


== Compiling ==
Then configure ScummVM for the iOS version you want to target.


Now, we can start the compile:
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:
<syntaxhighlight lang="bash">
./path/to/scummvm/configure --host=ios7 --with-staticlib-prefix=$IOS_TOOLCHAIN_BASE/$TARGET/usr
</syntaxhighlight>
Replace ''ios7'' with ''iphone'' if you want to build the older version of our iOS backend.


<pre>
=== Compilation ===
make iphone
</pre>


Lastly, we want to make a ScummVM.app bundle:
You can compile ScummVM with running make:
<syntaxhighlight lang="bash">
make iphone
</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''.


<pre>
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:
make iphonebundle
<syntaxhighlight lang="bash">
</pre>
make ios7bundle
</syntaxhighlight>
for the ''ios7'' backend. Or
<syntaxhighlight lang="bash">
make iphonebundle
</syntaxhighlight>
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/16558...25796"