Difference between revisions of "Compiling ScummVM/iPhone"

Jump to navigation Jump to search

Compiling ScummVM/iPhone (view source)

Revision as of 22:12, 12 October 2017

2,710 bytes added ,  22:12, 12 October 2017
Add some instructions to build with Xcode
m (use pre; for whatever reason the wiki isn't displaying the space-prefixed lines properly)
(Add some instructions to build with Xcode)
(6 intermediate revisions by 3 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 SVN checkout of: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/trunk
* 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 and get it to work on your non-jailbroken iPhone or iPad.


== 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:
<source lang="bash">
git clone https://github.com/scummvm/scummvm.git
</source>
 
Generate the create_project tool:
<source lang="bash">
cd scummvm/devtools/create_project/xcode
xcodebuild
</source>
 
Create a build directory, extract the [https://www.scummvm.org/frs/build/scummvm-ios7-libs.zip iOS libraries package] and generate the Xcode project
<source lang="bash">
cd ../../../..
mkdir build
cd build
</source>
 
Download the [https://www.scummvm.org/frs/build/scummvm-ios7-libs.zip iOS libraries package] and extract them in the build directory:
<source lang="bash">
unzip ~/Downloads/ScummVM-iOS-libraries.zip
</source>
 
Generate Xcode project and open it:
<source 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
open scummvm.xcodeproj
</source>
 
== 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.
 
 
= 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. You can add mpeg2dec as well, but it's only used for MPEG2 BS1/2 cutscene support and you really should be using the DXA versions instead (can be downloaded from [http://scummvm.org/downloads.php ScummVM's download page].
 
=== 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>
<source lang="bash">
./configure --host=arm-darwin --prefix=$SDKROOT/sys/
export TARGET=arm-apple-darwin9
make && make install
</source>
</pre>


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


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


<pre>
<source 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 \
</source>
--with-mpeg2-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.
--with-tremor-prefix=/$SYSROOT/usr/local
</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:
<source lang="bash">
./path/to/scummvm/configure --host=ios7 --with-staticlib-prefix=$IOS_TOOLCHAIN_BASE/$TARGET/usr
</source>
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:
<source lang="bash">
make iphone
</source>
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
<source lang="bash">
</pre>
make ios7bundle
</source>
for the ''ios7'' backend. Or
<source lang="bash">
make iphonebundle
</source>
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/16127...24011"

Navigation menu