-
Notifications
You must be signed in to change notification settings - Fork 0
Try Crosswalk
This page is deprecated, and has been mostly superseded by the Getting Started pages on the Crosswalk website.
Note: If you are a C/C++ developer and want to develop your own runtime built with Crosswalk, reference Crosswalk Build Instructions for instructions on how to build your own binary.
For official binaries, see Downloads. If you would like a binary for an operating system not provided, you will need to build Crosswalk yourself.
Once you have the binaries built, you can follow these instructions.
On Windows, the zip package contains:
- Crosswalk launcher - xwalk.exe (~33M)
- Crosswalk packaged resources - xwalk.pak (~5M)
- Unicode and i18n support library - icudt.dll (~9M)
- EGL/OpenGLES support libraries - libEGL.dll, libGLESv2.dll (~1M)
- Installer creation script (.bat or .sh)
For a quick 'smoke test', unzip the file into a directory and try to run:
xwalk.exe http://www.google.com
You should see a native app window that renders the www.google.com page. Reference Crosswalk Command Line Options to see which options are provided by this early binary.
-
Download the binary for your platform from the URL in Get Crosswalk.
-
Unpack the zip file.
-
Move to the unzipped directory:
cd xwalk-linux -
Smoke test with a known URL, e.g.
./xwalk http://google.com/
See Installing Crosswalk. If you are running Android within the x86 emulator, be aware that depending on the capabilities of your host platform's graphics card, you may experience rendering and graphical issues.
See Installing Crosswalk.
Given a web app written in HTML5 and Javascript with an index.html
entry page, the Crosswalk tools allows you to package it into a native
app installer.
You can also pack a manifest.json file with your application. Reference Crosswalk manifest to see how to write a manifest file.
The create_windows_installer.bat contained in the Crosswalk binaries is used to package a web app into a native app installer.
A prerequisite for this installer is the Wix toolset. Download the toolset from http://wixtoolset.org/.
Run create_windows_installer.bat --help for instructions on how to use Wix.
usage: create_windows_installer.bat [options] [app_path]
The following options are supported:
app_path Path to your Crosswalk application. If not specified, the
current directory is used.
--wix_bin_path=<path> Path to Wix toolset binaries. If not specified, the
script will try to find them through PATH
--xwalk_path=<path> Path to Crosswalk binaries. If not specified, the script
will try to find them through PATH, the app path, or
the current directory.
--app_name=<name> Name of the application. If not specified, the name
of the application directory is used.
--version=<version> The version of the application, defaults to 1.0.0
--app_arguments=<args> Arguments that will be passed into Crosswalk executable.
If not specified, "index.html" is used. For example,
"--allow-file-access-from-files [INSTALLDIR]src/index.html"
--out=<pathname> File Path of the output installer file, defaults to the
current directory with %app_name%.msi as its name.
--publisher=<name> The manufacturer of this application, defaults to "Me"
--help Print this message
create_windows_installer.bat webapps-scientific-calculator-master --wix_bin_path="C:\Program Files (x86)\WiX Toolset v3.7\bin" --xwalk_path="C:\Users\username\Desktop\xwalk paking\xwalk-win32"
The create_linux_installer.sh contained is used to create native installer in RPM or DEB package format through checkinstall utility. You MUST install checkinstall firstly. Run sudo apt-get install checkinstall on Linux system.
The usage is similar with that on Windows, but without Wix:
usage: create_linux_installer.sh [options] [app_path]
This script is used to create a standalone installer for web app. It
depends on checkinstall and crosswalk to function properly.
The following options are supported:
app_path Path to your web application. If not specified, the
current directory is used.
--xwalk_path=<path> Path to Crosswalk binaries. If not specified, the script
will try to find them through PATH, the app path, or
the current directory.
--app_name=<name> Name of the application. If not specified, the name
of the application directory is used.
--version=<version> The version of the application, defaults to 1.0.0
--app_index=<path> Path of app index file, relative to app_path. If not
specified, index.html is used.
--out=<path> Path of the output package file, defaults to
/tmp/xwalk_build/<app_name>
--publisher=<name> The manufacturer of this application, defaults to Me
--help Print this message
The Android APK packaging tool is included with the crosswalk for Android release. It can work on Linux, Windows and Mac OSX. Below are instructions for Linux(Mac OSX). For setting up the environment for Windows, please see the section 'Windows environment setup'.
To package a web application, first unpack the tarball xwalk_app_template.tar.gz which is zipped in crosswalk-(version number)-[x86, arm].zip:
host$ tar xzvf xwalk_app_template.tar.gz
host$ cd xwalk_app_template
This facility contains utilities and dependencies for packaging a web app into an Android APK.
make_apk.py is the key script for packaging a web app as an Android APK.
Note: To make it work, you should ensure that the android command from the Android SDK, java from Oracle JDK(version 1.6) and ant are included in your PATH. Python is also needed.
Here is the help information for the make_apk.py script:
Usage: make_apk.py [options]
Options:
-h, --help show this help message and exit
-v, --version The version of this python tool.
--verbose Print debug messages.
--mode=MODE The packaging mode of the web application. The value
'shared' means that the runtime is shared across
multiple application instances and that the runtime
needs to be distributed separately. The value
'embedded' means that the runtime is embedded into the
application itself and distributed along with it.Set
the default mode as 'embedded'. For example:
--mode=embedded
--arch=ARCH The target architecture of the embedded runtime.
Supported values are 'x86' and 'arm'. Note, if
undefined, APKs for all possible architestures will be
generated.
Application Source Options:
This packaging tool supports 3 kinds of web application source: 1) XPK
package; 2) manifest.json; 3) various command line options, for
example, '--app-url' for website, '--app-root' and '--app-local-path'
for local web application.
--xpk=XPK The path of the XPK package. For example,
--xpk=/path/to/xpk/file
--manifest=MANIFEST
The manifest file with the detail description of the
application. For example,
--manifest=/path/to/your/manifest/file
--app-url=APP_URL The url of application. This flag allows to package
website as apk. For example, --app-
url=http://www.intel.com
--app-root=APP_ROOT
The root path of the web app. This flag allows to
package local web app as apk. For example, --app-
root=/root/path/of/the/web/app
--app-local-path=APP_LOCAL_PATH
The relative path of entry file based on the value
from 'app_root'. This flag should work with '--app-
root' together. For example, --app-local-
path=/relative/path/of/entry/file
Mandatory arguments:
They are used for describing the APK information through command line
options.
--name=NAME The apk name. For example, --name="Your Application
Name"
--package=PACKAGE The package name. For example,
--package=com.example.YourPackage
Optional arguments:
They are used for various settings for applications through command
line options.
--app-version=APP_VERSION
The version name of the application. For example,
--app-version=1.0.0
--app-versionCode=APP_VERSIONCODE
The version code of the application. For example,
--app-versionCode=24
--app-versionCodeBase=APP_VERSIONCODEBASE
The version code base of the application. Version code
will be made by adding a prefix based on architecture
to the version code base. For example, --app-
versionCodeBase=24
--xwalk-command-line=XWALK_COMMAND_LINE
Use command lines.Crosswalk is powered by Chromium and
supports Chromium command line.For example, --xwalk-
command-line='--chromium-command-1 --xwalk-command-2'
--description=DESCRIPTION
The description of the application. For example,
--description=YourApplicationDescription
--enable-remote-debugging
Enable remote debugging.
--extensions=EXTENSIONS
The list of external extension paths splitted by OS
separators. The separators are ':' , ';' and ':' on
Linux, Windows and Mac OS respectively. For example,
--extensions=/path/to/extension1:/path/to/extension2.
-f, --fullscreen Make application fullscreen.
--keep-screen-on Support keeping screen on
--icon=ICON The path of application icon. Such as:
--icon=/path/to/your/customized/icon
--orientation=ORIENTATION
The orientation of the web app's display on the
device. For example, --orientation=landscape. The
default value is 'unspecified'. The permitted values
are from Android:
http://developer.android.com/guide/topics/manifest
/activity-element.html#screen
--permissions=PERMISSIONS
The list of permissions to be used by web application.
For example, --permissions=geolocation:webgl
--target-dir=TARGET_DIR
Packaging tool will move the output APKS to the target
directory
Keystore Options:
The keystore is a signature from web developer, it's used when
developer wants to distribute the applications.
--keystore-path=KEYSTORE_PATH
The path to the developer keystore. For example,
--keystore-path=/path/to/your/developer/keystore
--keystore-alias=KEYSTORE_ALIAS
The alias name of keystore. For example, --keystore-
alias=name
--keystore-passcode=KEYSTORE_PASSCODE
The passcode of keystore. For example, --keystore-
passcode=code
--compressor=COMPRESSOR
Minify and obfuscate javascript and css.--compressor:
compress javascript and css.--compressor=js: compress
javascript.--compressor=css: compress css.
Importance: Crosswalk provides the embedded mode and the shared mode in the APK packaging tool as described in Crosswalk on Android.
#####Package a local web app (resources of a web app are stored in local disk) Assume that resources of a web app are located under the directory /home/foobar/dist and the entry HTML file is /home/foobar/dist/index.html. Package the web app with the embedded mode:
host$ python make_apk.py --package=com.foo.bar --name=FooBar \
--app-root=/home/foobar/dist --app-local-path=index.html --mode=embedded
An Android APK file called 'FooBar_x86.apk' will be generated if running with the packaging tool for X86 version. If the packaging tool is for ARM architecture, the APK file called 'FooBar_arm.apk' will be generated. Crosswalk will combine X86 and ARM into one packaging tool in future.
For the shared mode, do it like below:
host$ python make_apk.py --package=com.foo.bar --name=FooBar \
--app-root=/home/foobar/dist --app-local-path=index.html --mode=shared
An Android APK file called 'FooBar.apk' will be generated. It's architecture-independent which means it can work on IA and ARM devices.
Below is one example to package a host web app:
host$ python make_apk.py --package=com.foo.bar --name=Test1 \
--app-url=https://www.crosswalk-project.org --mode=[embedded|shared]
The Android APK will be generated as well like packaging local web apps.
For the embedded mode, install FooBar_x86.apk on an Android IA device (users can install FooBar_arm.apk on an Android ARM device as well) like below:
host$ adb install -r FooBar_x86.apk
For the shared mode, make sure XWalkRuntimeLib.apk(architecture dependent) has been installed on the Android device firstly. And install the web app APK like below:
host$ adb install -r FooBar.apk
-
Install the Android SDK. Make sure to add “%SDK_PATH%\platform-tools” and “%SDK_PATH%\platform-tools\tools” into the "PATH" environment variable.
-
Update to the latest Android API level.
-
Install python and ant. Add the installed path of python and the bin path of ant are added into the "PATH" environment variable as well.
-
Install Oracle JDK and add the paths of “%JAVA_HOME%/bin” and “%JAVA_HOME%/jre/bin” into "PATH". Make sure 'where java' is the path you've set with Oracle JDK. This is very IMPORTANT. The version 1.6.x is preferred.
Note: The Android APK maker works much slower on Windows than Linux and Mac because it takes a so long time to search executives on Windows.
TBD
Crosswalk also enables remote debugging to a separate instance of a Chrome browser.
- Step 1: Install Google's Chrome browser from https://www.google.com/chrome/.
- Step 2: Launch Crosswalk with remote debugging option
xwalk.exe --remote-debugging-port=9222 index.html - Step 3: Open
localhost:9222in the Chrome browser, and you will see the inspectable pages in Chrome tab. - Step 4: Click the inspectable page to open the Web Inspector UI to start debugging.
- Network proxy set by environment doesn't take effect on Linux. Instead, you have to set the system wide network proxy.
- Cannot play HTML5 video. It is because the ffmpeg library is not included in the Crosswalk binaries. Set Tips#1 for using ffmpeg to play HTML5 video in Crosswalk.
- CSS3D and WebGL can not work on Windows if DirectX End-User Runtime is not installed on your system. Go to here to install DirectX End-User Runtime on your system.
- How to enable multimedia in Crosswalk binary release?
See Enable Multimedia in Crosswalk
- How to debug Javascript code in window.onload?
Launch xwalk.exe with --remote-debugging-port=9222, and open localhost:9222 in Chrome browser to start debugging and set breakpoint inside window.onload body, press F5 in Chrome to refresh the Web inspector page. As expected, your app will be paused at the breakpoint you set.
- How to specify the app icon?
You can use --app-icon command line option or use favicon metatag inside <head> tag:
`