-
-
Notifications
You must be signed in to change notification settings - Fork 105
Developer workflow
git clone https://github.com/Igalia/wolvic.git
cd wolvic
git clone https://github.com/Igalia/wolvic-third-parties.git third_party
git submodule update --init --recursive
Afterwards, the third_party folder can be updated like this:
pushd third_party && git fetch && git checkout main && git rebase origin/main && git submodule update --init --recursive --remote && popd
Open the wolvic folder in Android Studio and wait for the project to sync. Select the appropriate build variant for your device. For example, if you are developing for a Meta device:
Module: :app
Active Build Variant: oculusvrArm64GeckoGenericDebug
Active ABI: arm64-v8a
Build > Make project
And verify that the code compiles without problems.
If you have already set up a device, you can now launch the app with:
Run > Run 'app'
(for additional details check the github repo)
There are a few build properties that might be useful at this point. In the file user.properties you can include
simultaneousDevProduction=true
to append .dev to the application id of the compiled package. This is useful if you want to have the version from the app store installed at the same time. This setting is required on systems like PICO which will otherwise try (and fail) to validate the signature of the compiled package.
You might also need to provide the location of your Android SDK in the file local.properties, for example:
sdk.dir=/home/USERNAME/Android/Sdk
Gecko is Firefox's Web engine, the library that interprets the source code of a website and renders it on the screen.
These are the instructions to compile Gecko and use it in Wolvic.
Note: compiling Gecko is not strictly required to run Wolvic, which can also use a prebuilt binary from Maven. This is much faster than building Gecko but has the downside of not being able to run WebXR experiences.
| Wolvic release | Gecko version |
|---|---|
| 1.7.x | 128.1.0 |
| 1.6.x | 121.0.1 |
| 1.5.x | 116.0.3 |
| 1.1.x - 1.4.x | 103.0.2 |
| <= 1.0.x | 96 |
Note: because of recent changes to Mozilla's build system, we recommend using a newer release of Firefox that can find all the required tools and libraries. We also recommend adding the downloaded code to version control.
VERSION=127.0.1
curl -O https://ftp.mozilla.org/pub/firefox/releases/$VERSION/source/firefox-$VERSION.source.tar.xz
tar -xf firefox-$VERSION.source.tar.xz
git clone https://github.com/Igalia/wolvic-gecko-patches.git
cd firefox-$VERSION
find ../wolvic-gecko-patches/gecko-$VERSION/ -type f -name "*patch" -print0 | sort -z | xargs -t -n1 -0 patch -p1 -i
git clone [email protected]:Igalia/gecko-dev.git
cd gecko-dev
git checkout FIREFOX_103_0_2_RELEASE
Early versions of Wolvic used other branches. That is not very relevant now as it's becoming more and more difficult to get those old versions running in VR devices due to OS updates that broke the support for those versions.
Wolvic releases have been tagged since the beginning. The format of the tag names used is vX.Y.Z (note that the Wolvic repository still contains tags from the previous FirefoxReality project which do not start with the v character).
You can build a specific version just by checking out a specific flag
git checkout vX.Y.Z
Starting in the 1.3.x cycle, we have been also using release branches to backport fixes from main branch into the stable release branches. Currently you could find in the repo the following stable branches release/1.3, release/1.4 and release/1.5.
Create the file mozconfig in the firefox-$VERSION folder and add at least these two lines:
ac_add_options --enable-project=mobile/android
ac_add_options --target=aarch64 --enable-linker=lld
Optionally you could include the following
ac_add_options --enable-optimize --disable-debug --enable-geckoview-lite
./mach bootstrap
When prompted, select this option:
4. GeckoView/Firefox for Android
The script will install a bunch of packages required to compile the project inside the ~/.mozbuild folder and save the configuration in the mozconfig file.
(The packages in ~/.mozbuild take up several GB of space; if needed, it is safe to delete them after compiling the project).
./mach build
(This might take some time)
Go to the folder with the Wolvic source code and add two new lines in the file local.properties
dependencySubstitutions.geckoviewTopsrcdir=PATH_TO_GECKO_SOURCES
dependencySubstitutions.geckoviewTopobjdir=PATH_TO_GECKO_SOURCES/obj-aarch64-unknown-linux-android
These lines will tell Wolvic where to look for the alternative version of the library.
For example, if the Wolvic source code is in
/home/USER/Projects/wolvic
and the Gecko sources project are in
/home/USER/Projects/firefox-127.0.1
These two lines should be be added to /home/USER/Projects/wolvic/local.properties:
dependencySubstitutions.geckoviewTopsrcdir=/home/USER/Projects/firefox-127.0.1
dependencySubstitutions.geckoviewTopobjdir=/home/USER/Projects/firefox-127.0.1/obj-aarch64-unknown-linux-android
File > Sync project with Gradle files
Build > Make Project
If things have worked correctly, in the "Build" section (bottom bar) there should be a log line saying something like:
[substitute-local-geckoview] Will substitute GeckoView (geckoview-{nightly,beta}) with local GeckoView (geckoview-default) from …
Run Wolvic on your device and check that WebXR experiences now work correctly.