Difference between revisions of "Compiling ScummVM/Docker"

Jump to navigation Jump to search
→‎Using the docker images: remove outdated info
(First draft)
 
(→‎Using the docker images: remove outdated info)
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
{| border="0" cellpadding="1" cellspacing="2" style="margin-left:5em; background:#FF9999; width:80%"
== Compiling ScummVM using Docker ==
|- align="center"
The ScummVM buildbot uses [https://www.docker.com/ Docker] for building the toolchains. As such, this makes it possible for the individual toolchains to be used for local builds, avoiding the need to install the toolchain and required libraries manually.
| '''NOTE'''
 
|- style="margin-left:1em; background:#ffffff;"
The following toolchain images are available:
|- style="background:#ffffff"
{| class="wikitable sortable"
| This page is still a draft, and lacks a lot of detail.
|-
|}
!Name
!Target platform
!class=unsortable|Required compiler flags
!class=unsortable|Packaging command
!class=unsortable|Notes
|-
| toolchains/amigaos4
| [[AmigaOS]] 4
| <code>--host=ppc-amigaos --enable-plugins --default-dynamic --enable-detection-dynamic</code>
| <code>make amigaosdist</code>
|
|-
| toolchains/android
| [[Android]] for ARMv7, AArch64, x86 and x86_64
| <code>--host=android-arm-v7a --enable-debug</code>
 
<code>--host=android-arm64-v8a --enable-debug</code>
 
<code>--host=android-x86 --enable-debug</code>
 
<code>--host=android-x86_64 --enable-debug</code>
| <code>make androiddistdebug</code>
|
|-
| toolchains/caanoo
| [[Caanoo]]
| <code>--host=caanoo --enable-plugins --default-dynamic --enable-vkeybd</code>
| <code>make caanoo-bundle</code>
|
|-
| toolchains/devkit3ds
| [[Nintendo 3DS]]
| <code>--host=3ds --enable-plugins --default-dynamic</code>
| <code>make dist_3ds</code>
|
|-
| toolchains/devkitnds
| [[Nintendo DS]]
| <code>--host=ds --enable-plugins --default-dynamic</code>
| <code>make dsdist</code>
|
|-
| toolchains/devkitppc
| [[Nintendo Wii]] and [[Nintendo GameCube|GameCube]]
| <code>--host=wii --enable-plugins --default-dynamic --enable-vkeybd</code>
 
<code>--host=gamecube --enable-plugins --default-dynamic --enable-vkeybd</code>
| <code>make wiidist</code>
|
|-
| toolchains/devkitswitch
| [[Nintendo Switch]]
| <code>--host=switch</code>
| <code>make switch_release</code>
|
|-
| toolchains/dreamcast
| [[Dreamcast]]
| <code>--host=dreamcast --enable-plugins --default-dynamic --enable-vkeybd</code>
| <code>make dcdist</code>
|
|-
| toolchains/gcw0
| [[GCW Zero]]
| <code>--host=gcw0 --enable-plugins --default-dynamic --enable-vkeybd</code>
| <code>make gcw-opk</code>
|
|-
| toolchains/iphone
| [[iOS]] 7 for AArch64
| ?
| <code>make ios7bundle</code>
| Requires building the image from source.
|-
| toolchains/macosx-arm64
| [[macOS]] for AArch64
| ?
| <code>make bundle</code>
| Requires building the image from source.
|-
| toolchains/macosx-i386
| [[macOS]] for x86
| ?
| <code>make bundle</code>
| Requires building the image from source.
|-
| toolchains/macosx-x86_64
| [[macOS]] for x86_64
| ?
| <code>make bundle</code>
| Requires building the image from source.
|-
| toolchains/mxe
| [[Windows]] for x86 and x86_64
| <code>--host=i686-w64-mingw32.static --enable-debug --enable-updates</code>


<code>--host=x86_64-w64-mingw32.static --enable-debug --enable-updates</code>
| <code>make win32dist-mingw DESTDIR=win32dist-mingw</code>
|
|-
| toolchains/n64
| [[Nintendo 64]]
| <code>--host=n64 --enable-vkeybd</code>
| <code>make n64-dist</code>
| Requires building with a reduced number of engines.
|-
| toolchains/open2x
| [[GP2X]]
| <code>--host=gp2x --enable-vkeybd</code>
| <code>make gp2x-bundle</code>
| Requires building with a reduced number of engines.
|-
| toolchains/opendingux
| [[Dingux]]
| <code>--host=dingux --enable-plugins --default-dynamic --enable-vkeybd --disable-theoradec</code>
| <code>make dingux-dist</code>
|
|-
| toolchains/openpandora
| [[OpenPandora]]
| <code>--host=openpandora --enable-plugins --default-dynamic --enable-vkeybd</code>
| <code>make op-pnd</code>
|
|-
| toolchains/ps3
| [[PlayStation 3]]
| <code>--host=ps3</code>
| <code>make ps3pkg</code>
|
|-
| toolchains/psp
| [[PlayStation Portable]]
| <code>--host=psp --disable-debug --enable-plugins --default-dynamic</code>
|
| Requires building with a reduced number of engines.
|-
| toolchains/raspberrypi
| [[Raspberry Pi]]
| <code>--host=raspberrypi</code>
| <code>make dist-generic</code>
|
|-
| toolchains/riscos
| [[RISC OS]]
| <code>--host=arm-unknown-riscos</code>


== Compiling ScummVM using Docker ==
<code>--host=arm-vfp-riscos</code>
'''''TODO'''''
| <code>make riscosdist</code>
| Requires building with a reduced number of engines.
|-
| toolchains/vita
| [[PlayStation Vita]]
| <code>--host=psp2</code>
| <code>make psp2vpk</code>
| Requires building with a reduced number of engines.
|-
| toolchains/windows-9x
| [[Windows]] 95/98/ME
| <code>--host=mingw32 --disable-windows-unicode</code>
| <code>make win32dist-mingw DESTDIR=win32dist-mingw</code>
|
|}


The following images are available:
For more details on how to build ScummVM for a specific platform, see the relevant page from [[Compiling ScummVM]].
* toolchains/amigaos4
* toolchains/android
* toolchains/caanoo
* toolchains/devkit3ds
* toolchains/devkitnds
* toolchains/devkitppc
* toolchains/devkitswitch
* toolchains/dreamcast
* toolchains/gcw0
* toolchains/iphone
* toolchains/macosx-arm64
* toolchains/macosx-i386
* toolchains/macosx-x86_64
* toolchains/mxe
* toolchains/open2x
* toolchains/opendingux
* toolchains/openpandora
* toolchains/ps3
* toolchains/psp
* toolchains/raspberrypi
* toolchains/riscos
* toolchains/vita


=== Installing the needed packages ===
=== Installing the needed packages ===
==== Debian-based distributions ====
==== Debian-based distributions ====
The following should install all the needed packages:
The following should install all the necessary packages:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
apt-get install docker.io git make m4 acl
apt-get install docker.io git
</syntaxhighlight>
</syntaxhighlight>


Line 47: Line 182:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
git clone https://github.com/scummvm/scummvm.git
git clone https://github.com/scummvm/scummvm.git
git clone https://github.com/scummvm/dockerized-bb.git
</syntaxhighlight>
</syntaxhighlight>


=== Getting the docker images ===
=== Using the docker images ===
To fetch a toolchain image from the Docker Hub, issue the following command inside the dockerized-bb folder:
To fetch a toolchain image from the Docker Hub, issue the following command from the ScummVM source directory:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
make <toolchain>/pull
./devtools/docker.sh <toolchain>
</syntaxhighlight>
</syntaxhighlight>


where <toolchain> is the name of the toolchain you want to use. The following command can be used to fetch all toolchains at once:
where <toolchain> is the name of the toolchain you want to use. This will fetch the requested toolchain from the Docker Hub if it isn't installed, mount the scummvm folder in the Docker image and launch a shell that can be used to build ScummVM for the relevant platform. Alternatively, you can use the following command to fetch updates for an already installed toolchain before launching the shell:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
make pull-toolchains
./devtools/docker.sh --update <toolchain>
</syntaxhighlight>
</syntaxhighlight>


=== Using the docker images ===
Once in the Docker image, the following commands should be issued in order to build ScummVM:
'''''TODO'''''
 
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
docker run -v <path-to-scummvm>:/data/scummvm -w /data/scummvm -it <toolchain> /bin/bash
./configure <configure-flags>
make -j$(nproc)
</syntaxhighlight>
</syntaxhighlight>
where <configure-flags> is the list of required compiler flags specified in the table at the top of the page. This should be followed by the packaging command if one is specified.
Once done, the <code>exit</code> command can be used to leave the Docker image.
TrustedUser
2,147

edits

Navigation menu