Build Instructions for pxScene

Supported Platforms

macOS, Windows, Linux, and Raspberry Pi

Minimum requirements

macOS

OS : Macbook Pro (macOS Sierra >= 10.12)

RAM Size : 256 MB

Disk space : 24 MB

Processor speed : 1 GHz

Windows

OS : Windows 10

OS Build : 15063

RAM Size : 128 MB

Disk space : 24 MB

Processor speed : 1 GHz

Ubuntu Setup

Setup Ubuntu

Create a linux VM. The following version is recommended: ubuntu-14.04.1-desktop-amd64

Install required packages:

sudo apt-get install git libglew-dev freeglut3 freeglut3-dev libgcrypt11-dev zlib1g-dev g++ libssl-dev nasm autoconf libtool cmake quilt xmlto yasm bison flex  python-dev python3-dev  libuv-dev

update gcc to 6+ (sudo apt-get install gcc-6 g++-6 -y)

For Ubuntu 18.04+ also install:
```
sudo apt-get install gnutls-dev
```

macOS Setup

Install Xcode, CMake and quilt

Download the latest version of Xcode ( >= 9.2 <= 10) from https://developer.apple.com/xcode/download/ (XCode 10+ will currently not work!)

Download and install the latest version of brew from https://brew.sh/

From terminal install dependencies: cmake, pkg-config, quilt, java.

    brew install cmake pkg-config quilt caskroom/cask/java libuv xmlto glfw3 glew yasm bison flex python

Windows Setup

Setup Windows 10

Windows 10

VMware Fusion + VMware Tools

Visual Studio 2017 community with Desktop development with C++ workload

[windows sdk 10.0.15063.0, windows sdk 10.0.16299 and windows sdk 10.0.17134(aka 1803)] (https://developer.microsoft.com/en-us/windows/downloads/sdk-archive)

python 2.7.x , make sure python can work in cmd (setup environment variables depending on install location)

git for windows , make sure git can work in cmd (setup environment variables depending on install location). While installing git, make sure that "Use Git and optional Unix tools from the Windows Command Prompt" option is checked.

patch utility for windows (this comes with git. setup environment variables depending on install location of patch.exe)

Download and install cmake for windows from https://cmake.org/download/

Download and install NSIS installer from http://nsis.sourceforge.net/Download

Download ans install active state perl 5.28 https://www.activestate.com/products/activeperl/downloads/

Run all these commands from a Visual Studio Command Prompt Environment variables after compilation -> 1. NODE_PATH -> pxCore/examples/pxScene2d/src; pxCore/examples/pxScene2d/src/node_modules/; [Add them as separate lines]

Building with CMake (this will work for all platforms after setup is complete)

Get source code:

git clone https://github.com/pxscene/pxCore.git

Checkout current development branch
```
cd pxCore
git checkout master
```

Build externals: a. Build all externals for use during the pxscene build.

cd examples/pxScene2d/external

For Linux and Mac run (Without AAMP Support):

./build.sh

For Linux and Mac run (With AAMP Support):

./build.sh SPARK_ENABLE_VIDEO

For Raspberry Pi run:

./build_rpi.sh

For Windows (Run from inside a Visual Studio Command Prompt):

buildWindows.bat

b. To use system libraries for external libs during pxscene build, install libs on the system. To build just node, duktape and breakpad with the patches necessary for pxscene, do the following.

For Mac and Linux OS.

Build duktape

cd examples/pxScene2d/external/dukluv/
mkdir build
cd build
cmake ..
cmake --build . --config Release

Build Node

cd examples/pxScene2d/external/node
./configure --shared
make -j1
ln -sf out/Release/obj.target/libnode.so.* ./
ln -sf libnode.so.* libnode.so
ln -sf out/Release/libnode.*.dylib ./
ln -sf libnode.*.dylib libnode.dylib

Build breakpad

cd examples/pxScene2d/external/breakpad-chrome_55
./configure
make

For Windows

Build Duktape

cd examples/pxScene2d/external/dukluv/
patch -p1 -i patches/dukluv.git.patch
mkdir build
cd build
cmake ..
cmake --build . --config Release -- /m

Build node

cd examples/pxScene2d/external/libnode-v6.9.0
CALL vcbuild.bat x86 nosign
cd ..

Build breakpad

cd examples/pxScene2d/external/breakpad-chrome_55
CALL gyp\gyp.bat src\client\windows\breakpad_client.gyp --no-circular-check
cd src\client\windows
msbuild breakpad_client.sln /p:Configuration=Release /p:Platform=Win32 /m

Build pxScene

On following step 3b, Specify -DPREFER_SYSTEM_LIBRARIES=ON to use system libraries rather than libraries from externals directory. Note 1: To enable VIDEO support, specify -DSPARK_ENABLE_VIDEO=ON in cmake command Note 2: If a dependent library is not found installed on the system, then the version in externals will be used.
```
cd pxCore/
mkdir temp
cd temp
cmake DPXSCENE_COMPILE_WARNINGS_AS_ERRORS=OFF -DPXCORE_COMPILE_WARNINGS_AS_ERRORS=OFF BUILD_STATIC_LIBS=ON  CMAKE_BUILD_TYPE=Release ..  -G Xcode
```
If you wish to build the unit tests then run
```
cmake -DBUILD_PX_TESTS=ON -DBUILD_PXSCENE_STATIC_LIB=ON -DPXSCENE_TEST_HTTP_CACHE=OFF ..
```
For Linux, Mac, and Raspberry Pi run:
```
cmake --build . --config Release
```
For Windows (Run from inside a Visual Studio Command Prompt):
```
cmake --build . --config Release -- /m
```

Run a sample javascript file:

On Linux

cd pxCore/examples/pxScene2d/src
./spark.sh {path_to_javascript_file_name}.js

On macOS

cd pxCore/examples/pxScene2d/src/spark.app/Contents/MacOS
./spark.sh {path_to_javascript_file_name}.js

On Windows

cd pxCore\temp\
cpack .
cd pxCore\temp\_CPack_Packages\win32\NSIS\spark-setup
Spark.exe {path_to_javascript_file_name}.js

Examples:

./spark.sh http://www.sparkui.org/examples/gallery/picturepile.js
./spark.sh http://www.sparkui.org/examples/gallery/gallery.js

Running ./spark.sh without a parameter will load the local browser.js that will take a .js pathname relative to http://www.sparkui.org/examples/gallery to run. Alternatively, a fully qualified url can be used, for example:

http://www.sparkui.org/examples/gallery/picturepile.js
http://www.sparkui.org/examples/gallery/gallery.js
file:///home/username/directory/filename.js

Write your own app!
Run the unit tests (if they were built using the configuration in step 4)
```
cd pxCore/tests/pxScene2d
```
On Linux, Mac, and Raspberry Pi run:
```
./pxscene2dtests.sh
```
On Windows
```
pxscene2dtests.exe
```

Building and running unit tests

Get source code

git clone https://github.com/pxscene/pxCore

Build

cd pxCore/
mkdir temp
cd temp
cmake -DBUILD_PX_TESTS=ON -DBUILD_PXSCENE_STATIC_LIB=ON -DPXSCENE_TEST_HTTP_CACHE=OFF ..
cmake --build . --config Release

Run

cd pxCore/tests/pxScene2d
./pxscene2dtests.sh

Developer CMake options

ENABLE_THREAD_SANITIZER - Turn on this option to enable thread sanitizer support. The default value is OFF

On Mac OS X - Xcode Workspace

Get source code

git clone https://github.com/pxscene/pxCore.git

Checkout current development branch
```
cd pxCore
git checkout master
```
Build pxScene2d using Xcode
1. Open project pxCore/examples/pxScene2d/pxScene2d.xcworkspace in Xcode
2. Select "pxScene2d" as the target in the pulldown on the toolbar
3. From menu, go to Product menu and select "Build" or type ⌘B

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Supported Platforms

Minimum requirements

Ubuntu Setup

macOS Setup

Windows Setup

Building with CMake (this will work for all platforms after setup is complete)

Building and running unit tests

Developer CMake options

On Mac OS X - Xcode Workspace

Files

README.md

Latest commit

History

README.md

File metadata and controls

Supported Platforms

Minimum requirements

Ubuntu Setup

macOS Setup

Windows Setup

Building with CMake (this will work for all platforms after setup is complete)

Building and running unit tests

Developer CMake options

On Mac OS X - Xcode Workspace