Difference between revisions of "Compiling ScummVM/Docker"

From ScummVM :: Wiki
Jump to navigation Jump to search
 
(17 intermediate revisions by 4 users 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.
| '''NOTE'''
 
|- style="margin-left:1em; background:#ffffff;"
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.
|- style="background:#ffffff"
 
| This page is still a draft, and lacks a lot of detail.
Some convenience aliases are provided in every toolchains to make it easier to build ScummVM for the supported platforms.
There are three commands defined:
* <code>scummvm_configure</code>: invokes the configure script (located in <code>/data/scummvm</code>) with the proper options for the platform
* <code>scummvm_build</code>: builds the project
* <code>scummvm_package</code>: packages the project ready for use on the targeted platform
 
Some toolchains support several platforms at once. In this case, the aliases have been defined per platform with a suffix. The aliases can then be found using the <code>aliases</code> command.
 
=== Current platforms ===
 
The following toolchain images are available:
{| class="wikitable sortable"
|-
!Name
!Target platform
!class=unsortable|Required configure 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/appletv
| [[Apple TV]]
| ?
| ?
| Requires building the image from source.
|-
| 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
| [[Dingux|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-updates</code>
 
<code>--host=x86_64-w64-mingw32.static --enable-updates</code>
| <code>make win32dist-mingw DESTDIR=win32dist-mingw</code>
|
|-
| toolchains/opendingux-beta
| [[OpenDingux Beta]]
| <code>--host=opendingux-gcw0</code>
 
<code>--host=opendingux-lepus</code>
 
<code>--host=opendingux-rs90</code>
| <code>make od-make-opk</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>
| <code>make</code>
|
|-
| toolchains/raspberrypi
| [[Raspberry Pi]]
| <code>--host=raspberrypi</code>
| <code>make dist-generic</code>
|
|-
| toolchains/riscos
| [[RISC OS]]
| <code>--host=arm-unknown-riscos --enable-plugins --default-dynamic</code>
 
<code>--host=arm-vfp-riscos --enable-plugins --default-dynamic</code>
| <code>make riscosdist</code>
|
|-
| toolchains/vita
| [[PlayStation Vita]]
| <code>--host=psp2 --enable-plugins --default-dynamic</code>
| <code>make psp2vpk</code>
|
|-
| toolchains/windows-9x
| [[Windows]] 95/98/ME
| <code>--host=mingw32 --disable-windows-unicode</code>
| <code>make win32dist-mingw DESTDIR=win32dist-mingw</code>
|
|}
|}


For more details on how to build ScummVM for a specific platform, see the relevant page from [[Compiling ScummVM]].
=== Obsolete platforms ===


== Compiling ScummVM using Docker ==
The toolchains for the following platforms are still available, but they're considered '''obsolete'''.
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.


The following toolchain images are available:
{| class="wikitable sortable"
* toolchains/amigaos4
|-
* toolchains/android
!Name
* toolchains/caanoo
!Target platform
* toolchains/devkit3ds
!class=unsortable|Required configure flags
* toolchains/devkitnds
!class=unsortable|Packaging command
* toolchains/devkitppc
!class=unsortable|Notes
* toolchains/devkitswitch
|-
* toolchains/dreamcast
| toolchains/caanoo
* toolchains/gcw0
| [[Caanoo]]
* toolchains/iphone
| <code>--host=caanoo --enable-plugins --default-dynamic --enable-vkeybd</code>
* toolchains/macosx-arm64
| <code>make caanoo-bundle</code>
* toolchains/macosx-i386
|
* toolchains/macosx-x86_64
|-
* toolchains/mxe
| toolchains/n64
* toolchains/open2x
| [[Nintendo 64]]
* toolchains/opendingux
| <code>--host=n64 --enable-vkeybd</code>
* toolchains/openpandora
| <code>make n64-dist</code>
* toolchains/ps3
| Requires building with a reduced number of engines.
* toolchains/psp
|-
* toolchains/raspberrypi
| toolchains/opendingux
* toolchains/riscos
| [[Dingux]]
* toolchains/vita
| <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>
|
|}


=== Installing the needed packages ===
=== Installing the needed packages ===
Line 39: Line 209:
The following should install all the necessary 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 217:
<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:
To fetch a toolchain image from the Docker Hub, issue the following command:
 
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
docker run -v <path-to-scummvm>:/data/scummvm -w /data/scummvm -it <toolchain> /bin/bash
scummvm_configure <configure-flags>
scummvm_build
scummvm_package
</syntaxhighlight>
</syntaxhighlight>


where <toolchain> is the name of the toolchain you want to use, and <path-to-scummvm> is the path to the scummvm folder. This will mount the scummvm folder in the Docker image and launch a shell that can be used to build ScummVM for the relevant platform. Once done, the <code>exit</code> command can be used to leave the Docker image.
where <configure-flags> is the list of additional configure flags. The packaging command is optional.
 
On toolchain images supporting several platforms, the aliases are diversified in the form <code>scummvm_<action>_<variant></code>.
Use the <code>aliases</code> command to find the proper ones.


For more details on how to build ScummVM for a given platform, see the relevant page from [[Compiling ScummVM]].
Once done, the <code>exit</code> command can be used to leave the Docker image.

Latest revision as of 07:42, 8 September 2024

Compiling ScummVM using Docker

The ScummVM buildbot uses 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.

Some convenience aliases are provided in every toolchains to make it easier to build ScummVM for the supported platforms. There are three commands defined:

  • scummvm_configure: invokes the configure script (located in /data/scummvm) with the proper options for the platform
  • scummvm_build: builds the project
  • scummvm_package: packages the project ready for use on the targeted platform

Some toolchains support several platforms at once. In this case, the aliases have been defined per platform with a suffix. The aliases can then be found using the aliases command.

Current platforms

The following toolchain images are available:

Name Target platform Required configure flags Packaging command Notes
toolchains/amigaos4 AmigaOS 4 --host=ppc-amigaos --enable-plugins --default-dynamic --enable-detection-dynamic make amigaosdist
toolchains/android Android for ARMv7, AArch64, x86 and x86_64 --host=android-arm-v7a --enable-debug

--host=android-arm64-v8a --enable-debug

--host=android-x86 --enable-debug

--host=android-x86_64 --enable-debug

make androiddistdebug
toolchains/appletv Apple TV ? ? Requires building the image from source.
toolchains/devkit3ds Nintendo 3DS --host=3ds --enable-plugins --default-dynamic make dist_3ds
toolchains/devkitnds Nintendo DS --host=ds --enable-plugins --default-dynamic make dsdist
toolchains/devkitppc Nintendo Wii and GameCube --host=wii --enable-plugins --default-dynamic --enable-vkeybd

--host=gamecube --enable-plugins --default-dynamic --enable-vkeybd

make wiidist
toolchains/devkitswitch Nintendo Switch --host=switch make switch_release
toolchains/dreamcast Dreamcast --host=dreamcast --enable-plugins --default-dynamic --enable-vkeybd make dcdist
toolchains/gcw0 GCW Zero --host=gcw0 --enable-plugins --default-dynamic --enable-vkeybd make gcw-opk
toolchains/iphone iOS 7 for AArch64 ? make ios7bundle Requires building the image from source.
toolchains/macosx-arm64 macOS for AArch64 ? make bundle Requires building the image from source.
toolchains/macosx-i386 macOS for x86 ? make bundle Requires building the image from source.
toolchains/macosx-x86_64 macOS for x86_64 ? make bundle Requires building the image from source.
toolchains/mxe Windows for x86 and x86_64 --host=i686-w64-mingw32.static --enable-updates

--host=x86_64-w64-mingw32.static --enable-updates

make win32dist-mingw DESTDIR=win32dist-mingw
toolchains/opendingux-beta OpenDingux Beta --host=opendingux-gcw0

--host=opendingux-lepus

--host=opendingux-rs90

make od-make-opk
toolchains/ps3 PlayStation 3 --host=ps3 make ps3pkg
toolchains/psp PlayStation Portable --host=psp --disable-debug --enable-plugins --default-dynamic make
toolchains/raspberrypi Raspberry Pi --host=raspberrypi make dist-generic
toolchains/riscos RISC OS --host=arm-unknown-riscos --enable-plugins --default-dynamic

--host=arm-vfp-riscos --enable-plugins --default-dynamic

make riscosdist
toolchains/vita PlayStation Vita --host=psp2 --enable-plugins --default-dynamic make psp2vpk
toolchains/windows-9x Windows 95/98/ME --host=mingw32 --disable-windows-unicode make win32dist-mingw DESTDIR=win32dist-mingw

For more details on how to build ScummVM for a specific platform, see the relevant page from Compiling ScummVM.

Obsolete platforms

The toolchains for the following platforms are still available, but they're considered obsolete.

Name Target platform Required configure flags Packaging command Notes
toolchains/caanoo Caanoo --host=caanoo --enable-plugins --default-dynamic --enable-vkeybd make caanoo-bundle
toolchains/n64 Nintendo 64 --host=n64 --enable-vkeybd make n64-dist Requires building with a reduced number of engines.
toolchains/opendingux Dingux --host=dingux --enable-plugins --default-dynamic --enable-vkeybd --disable-theoradec make dingux-dist
toolchains/openpandora OpenPandora --host=openpandora --enable-plugins --default-dynamic --enable-vkeybd make op-pnd

Installing the needed packages

Debian-based distributions

The following should install all the necessary packages:

apt-get install docker.io git

Getting the source

  • Open a Terminal and type:
git clone https://github.com/scummvm/scummvm.git

Using the docker images

To fetch a toolchain image from the Docker Hub, issue the following command from the ScummVM source directory:

./devtools/docker.sh <toolchain>

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:

./devtools/docker.sh --update <toolchain>

Once in the Docker image, the following commands should be issued in order to build ScummVM:

scummvm_configure <configure-flags>
scummvm_build
scummvm_package

where <configure-flags> is the list of additional configure flags. The packaging command is optional.

On toolchain images supporting several platforms, the aliases are diversified in the form scummvm_<action>_<variant>. Use the aliases command to find the proper ones.

Once done, the exit command can be used to leave the Docker image.