-
Notifications
You must be signed in to change notification settings - Fork 17
build guide
When creating builds, there are a few things to keep in mind.
Before building Pongball, asset bundles must be generated. These contain some of the Pongball's switchable content, and without them the game will not function correctly.
To generate asset bundles for the platform you are running the Unity editor on, either select AssetBundles->Build Asset Bundles
from the Assets menu, or right click on any folder in the Project panel and select the AssetBundles->Build Asset Bundles
option from the context menu.
Asset bundles are platform specific and need to be generated for each platform. To build asset bundles for a specific platform, change the Target Platform
dropdown in the Build Settings dialog to the desired platform and then select AssetBundles->Build Target Asset Bundles
from the Assets menu or right click context menu in the Project panel.
For Windows builds, build 32 bit for broader compatibility, for Mac OS, build Universal builds, and for Linux, use the option to build both 64 and 32 bit versions.
All builds should be compressed into archives (generally .zip for Mac and Windows, .tar.gz for Linux). These archives should use the same naming pattern as the builds themselves, but with a -platform suffix: pongball_YYYY-MM-DD_XXXXXXX
For example: pongball_2017-04-12_b01a8c5-windows.zip
Development builds should be named according to ISO date and the Git short revision that they're based on, using the pattern: pongball_YYYY-MM-DD_XXXXXXX
To get the short git revision, use the git rev-parse command with the --short argument. For example, to get the short revision of the current head, using the following command: git rev-parse --short HEAD
Here's an example build name: pongball_2017-04-12_b01a8c5
Release builds should be named: pongball_X.X.X_YYYYYYY
, where X.X.X is the version number according to semantic versioning based on the changes since the previous release build and YYYYYYY is the Git short revision as described above.
Here's an example release build name: pongball_0.1.1_b01a8c5
For security reasons, Mac OS and Linux file systems require files to have 'executable permissions' before they can be run. These can not be easily set from Windows.
The following command will set the executable permission on the Linux binaries (adjust file name as appropriate): chmod +x pongball_2017-04-12_b01a8c5*
The following command will set executable permission on the Mac OS binary (adjust .app folder name as appropriate): chmod +x pongball_2017-04-12_b01a8c5.app/Contents/MacOS/Pongball
If these binaries have executable permissions at the time they are added to a .zip or .tar.gz archive, those permissions should be preserved when they are extracted.