Difference between revisions of "Compiling Gideros Luau Source"

From GiderosMobile
(Created page with "The following instructions are for developers who want to contribute to or otherwise experiment with the Gideros C/C++ engine and are not necessary for either building or depl...")
 
(23 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
The Gideros project consists of the Gideros Studio IDE, the Gideros SDK libraries, Gideros Texture Packer, Gideros Font Creator, "players" or export templates for all the platforms Gideros supports, all targets of all plugins, a daemon and a bridge. The build system is flexible, so you only need the tools for the targets you are interested in deploying to with Qt (and MSYS2 on Windows) being a realistic minimum.
 
The Gideros project consists of the Gideros Studio IDE, the Gideros SDK libraries, Gideros Texture Packer, Gideros Font Creator, "players" or export templates for all the platforms Gideros supports, all targets of all plugins, a daemon and a bridge. The build system is flexible, so you only need the tools for the targets you are interested in deploying to with Qt (and MSYS2 on Windows) being a realistic minimum.
 +
 +
 +
 +
'''A QUICK GUIDE TO BUILD GIDEROS STUDIO ONLY'''
 +
 +
Here are the easy steps to build Gideros Studio only without all the bells and whistles (no android, no html5, ...). Please follow the steps:
 +
*1.1 Install QT6
 +
*1.2 Install MSYS2 Console
 +
*2.1 Fetch gideros source code
 +
 +
Since we only build Gideros Studio (if you have not set up the plugins), you need to edit '''scripts/Makefile.gid''':
 +
<source lang="bash">
 +
PLUGINS_WIN=$(PLUGINS_ALL) clipper struct controller camera
 +
#PLUGINS_WINONLY=spout steam luamidi
 +
PLUGINS_WINONLY=luamidi
 +
</source>
 +
 +
*2.2 Configure scripts
 +
Your '''Makefile.def''' can look something as simple as this:
 +
<source lang="bash">
 +
#QTBASEDIR=/c/Applications/Qt
 +
QTBASEDIR=/c/Qt6
 +
MAKEJOBS=-j8
 +
 +
#WIN32_BIN=/mingw32/bin
 +
#WIN32_BIN=/c/msys64/mingw32/bin
 +
WIN32_BIN=/c/msys64/mingw64/bin
 +
export WIN32_BIN
 +
 +
QT_ARCH=mingw_64
 +
#QT_TOOLSARCH=mingw900_64
 +
QT_TOOLSARCH=mingw1120_64
 +
QTVER=6.2.2
 +
QT5ICUVER=54
 +
</source>
 +
 +
*3 Building Gideros
 +
*3.1 Build QT tools
 +
 +
And that's it, you will have latest Gideros Studio and all its tools available.
 +
 +
'''Extra''': you can copy the templates from original Gideros and put them in the templates folder of your Gideros. You will then be able to export to usual devices (android, html, ...)
  
 
__TOC__
 
__TOC__
  
== Requirements for Windows 10 64bit ==
+
== Windows 10 64bit ==
  
 
=== Install QT ===
 
=== Install QT ===
Line 11: Line 53:
  
 
https://www.qt.io/download
 
https://www.qt.io/download
 
Recommended version 6.2.3 with MinGW 9.0
 
  
 
Double click on the downloaded file and follow instructions.
 
Double click on the downloaded file and follow instructions.
When installing:
 
* change the install directory to /Qt rather than /Qt6 (optional)
 
* expand the tree view and ensure you have ticked the MinGW child option of the Qt version checkbox, as well as the MinGW option in the Tools section
 
* Qt 5 compatibility module
 
* and following additional Qt libraries:
 
** Qt Multimedia
 
** Qt Websockets
 
  
If you already have Qt6 installed without those modules, you can add them via Qt MaintenanceTool.exe located in your Qt folder like so:
+
Recommended version 6.2.2 with MinGW 9.0 (if you don’t see it check the box Archive and click Filter). Should work fine with Qt version 6.2.3 (LTS) and MinGW 11.20.
  
(to add capture)
+
When installing, expand the tree view and ensure you have checked the following boxes:
 +
* Qt 6.2.2: MinGW 9.0.0 64-bit
 +
* Qt 6.2.2: Qt 5 compatibility module
 +
* Qt 6.2.2, Additional Libraries: Qt Multimedia
 +
* Qt 6.2.2, Additional Libraries: Qt Websockets
 +
* Developer and Designer Tools: MinGW 11.2.0 64-bit
  
 
Here is a screenshot of the Qt modules:
 
Here is a screenshot of the Qt modules:
  
(to add capture)
+
[[File:01_qt6_installing_modules10x.png]]
 +
 
 +
[[File:01_qt6_installing_modules11x.png]]
 +
 
 +
If you already have Qt6 installed without those modules, you can add them via Qt MaintenanceTool.exe located in your Qt folder like so:
 +
 
 +
[[File:01_qt6_maintenance_tool.png]]
  
 
When you are done click finish.
 
When you are done click finish.
 
  
 
=== Install MSYS2 Console ===
 
=== Install MSYS2 Console ===
Line 39: Line 82:
 
Once installed, open MSYS2 shell (msys2_shell.cmd):
 
Once installed, open MSYS2 shell (msys2_shell.cmd):
  
(to add capture)
+
[[File:02_msys_01.png]]
  
 
Then run the following commands:
 
Then run the following commands:
  
'''note''': copy/paste won’t work, you have to type the commands
+
'''note''': copy/paste won’t work, you have to type the commands:
 
<source lang="bash">
 
<source lang="bash">
pacman –Sy pacman
+
pacman -Sy pacman
pacman –Syu
+
pacman -Syu
pacman –Su
+
pacman -Su
pacman –S tar
+
pacman -S git
pacman –S zip
+
pacman -S make
pacman –S unzip
 
pacman –S git
 
pacman –S base-devel
 
 
pacman -S python
 
pacman -S python
 +
pacman -S tar
 +
pacman -S zip
 +
pacman -S unzip
 +
pacman -S base-devel
  
#For compiling win32 under a MinGW64
+
# For exporting apps to the win32/32bit platform under a MinGW64
pacman -S mingw-w64-i686-toolchain
+
pacman -S mingw-w64-i686-toolchain # note: if asked choose ALL #
 
pacman -S mingw-w64-i686-glew
 
pacman -S mingw-w64-i686-glew
 +
pacman -S mingw-w64-i686-curl
 +
pacman -S mingw-w64-i686-libpng
 +
# For exporting apps to the win32/64bit platform under a MinGW64
 +
pacman -S mingw-w64-x86_64-toolchain # note: if asked choose ALL #
 +
pacman -S mingw-w64-x86_64-glew
 +
pacman -S mingw-w64-x86_64-curl
 +
pacman -S mingw-w64-x86_64-libpng
 
</source>
 
</source>
  
'''note''': for pacman -S mingw-w64-i686-toolchain, if asked choose group 17?
+
'''note''': for the i686-toolchain/x86_64-toolchain if you get ''error: failed to commit transaction (invalid or corrupted package)'', you may need either reinstalling a newer version of '''msys''' or you can try these commands:
 +
<source lang="bash">
 +
rm -r /etc/pacman.d/gnupg/
 +
pacman-key --init
 +
pacman-key --populate msys2
 +
</source>
 +
You should then redo the pacman commands from the begining (pacman -Sy pacman, ...).
  
 +
=== Install Android Studio and NDK ===
 +
('''Not tested yet''')
  
=== Install Android Studio and NDK ===
 
 
https://developer.android.com/studio/index.html
 
https://developer.android.com/studio/index.html
  
Line 73: Line 131:
  
 
Once downloaded, copy the contents of the NDK to your home or C: folder, rename the folder that you copied to 'android-ndk', for example you will end up with 'c:\android-ndk' and below that folders that say build, meta, platforms, etc.
 
Once downloaded, copy the contents of the NDK to your home or C: folder, rename the folder that you copied to 'android-ndk', for example you will end up with 'c:\android-ndk' and below that folders that say build, meta, platforms, etc.
 
 
=== Ant (obsolete?) ===
 
Install Ant (no longer required but kept until someone confirms this)
 
https://ant.apache.org/
 
 
Once downloaded, copy the contents of the install archive/zip file to your home folder or C: drive.
 
 
Eg: so you have a folder called c:\apache-ant-1.10.5 with bin, etc, lib, manual folders within that.
 
 
 
=== Fix for Android (obsolete?) ===
 
Mix Old and New Tools (no longer required but kept until someone confirms this).
 
 
Gideros uses Ant to build the player, unfortunately the tools to support Ant are now missing from the latest Android tools.
 
 
There is a fix for this:
 
# rename the existing 'tools' folder in the Android SDK folder to 'tools_new'
 
# download an older (March 2016) version of the tools and copy that folder to the Android SDK folder
 
# copy the contents of 'tools_new' over the contents of 'tools'
 
 
Here is where you can download the compatible set of tools from:
 
 
(PC) https://dl.google.com/android/repository/tools_r25.2.5-windows.zip
 
(MAC) https://dl.google.com/android/repository/tools_r25.2.5-macosx.zip
 
(LINUX) https://dl.google.com/android/repository/tools_r25.2.5-linux.zip
 
 
  
 
=== Install JAVA ===
 
=== Install JAVA ===
Line 110: Line 141:
 
https://adoptopenjdk.net/
 
https://adoptopenjdk.net/
  
 +
=== Install Visual Studio ===
 +
('''Not tested yet''')
  
=== Install Visual Studio ===
 
 
Visual Studio Community Edition 2022:
 
Visual Studio Community Edition 2022:
  
 
https://www.visualstudio.com/downloads/
 
https://www.visualstudio.com/downloads/
  
Ensure that you have MSBuild v12 or v14 installed (building with the makefile will fail with an incorrect version).
+
Select the box Developing for Desktop apps and install.
  
 
– to come --
 
– to come --
Line 123: Line 155:
 
– to come --
 
– to come --
  
 +
=== Install Python ===
 +
('''Not tested yet''')
  
=== Install QScintilla ===
 
https://www.riverbankcomputing.com/software/qscintilla/download
 
 
Double click on the downloaded file and follow instructions.
 
 
Recommended 2.10.8
 
 
https://sourceforge.net/projects/pyqt/files/QScintilla2/QScintilla-2.10.8/QScintilla_gpl-2.10.8.zip
 
 
Unzip the file into the folder of your choice.
 
* with the command line, go to Q4Qt5 subfolder of QScintilla:
 
* open Qt command prompt (called (eg) Qt 5.9.1 for Desktop). This command prompt just sets environment variables, allowing direct running of tools installed with Qt
 
* navigate to QScintilla's Qt4Qt5 subfolder with ‘cd’ command, then type:
 
<source lang="bash">
 
qmake qscintilla.pro
 
mingw32-make
 
mingw32-make install
 
</source>
 
 
For the debug build necessary for debugging Gideros Studio run:
 
<source lang="bash">
 
make -f Makefile.Debug # mingw32-make on Windows
 
make -f Makefile.Debug install # mingw32-make on Windows
 
</source>
 
 
 
=== Download Scintilla ===
 
As a zip file from https://www.scintilla.org/ScintillaDownload.html
 
 
 
=== Download Lexilla ===
 
As a zip file from https://www.scintilla.org/LexillaDownload.html
 
 
 
=== Install Python ===
 
 
https://www.python.org/downloads/release/python-2712/
 
https://www.python.org/downloads/release/python-2712/
  
Line 166: Line 165:
 
On windows you can do this by right-clicking on 'myComputer' or 'This PC', go to 'Properties', click 'Advanced System Settings', Click 'Environmental Variables', double-click 'Path', add 'c:\python27'
 
On windows you can do this by right-clicking on 'myComputer' or 'This PC', go to 'Properties', click 'Advanced System Settings', Click 'Environmental Variables', double-click 'Path', add 'c:\python27'
  
 +
=== Install emscripten ===
 +
('''Not tested yet''')
  
=== Install emscripten ===
 
 
http://kripken.github.io/emscripten-site/
 
http://kripken.github.io/emscripten-site/
  
 
You need this if you want to build for HTML5 + Facebook games.
 
You need this if you want to build for HTML5 + Facebook games.
  
Using a shell or MSYS2 (previously installed) on windows, go to your home or C: folder and type:
+
Using a shell or MSYS2 (msys2_shell.cmd) go to your home or C: folder and type:
*git clone https://github.com/juj/emsdk.git
+
<source lang="bash">
 +
git clone https://github.com/juj/emsdk.git
 +
</source>
  
 
Once that has completed open a command prompt in that folder on Windows.
 
Once that has completed open a command prompt in that folder on Windows.
Line 220: Line 222:
 
</source>
 
</source>
  
(PC)
 
 
<source lang="bash">
 
<source lang="bash">
 
emsdk_env.bat
 
emsdk_env.bat
 
</source>
 
</source>
  
(PC) Make sure the environment variable EM_CONFIG is set to the location of your emscripten config file.
+
Make sure the environment variable EM_CONFIG is set to the location of your emscripten config file.
  
 
The emscripten build also needs the CMake command. You can download it and extract it to your home or C: folder. Don't forget to add it's path to the end of the EMSDKPATH in Makefile.def.
 
The emscripten build also needs the CMake command. You can download it and extract it to your home or C: folder. Don't forget to add it's path to the end of the EMSDKPATH in Makefile.def.
Line 231: Line 232:
 
https://cmake.org/download/
 
https://cmake.org/download/
  
 +
=== Install Steam SDK ===
 +
('''Not tested yet''')
  
=== Install Steam SDK ===
 
 
https://partner.steamgames.com/?goto=%2Fdownloads%2Fsteamworks_sdk.zip
 
https://partner.steamgames.com/?goto=%2Fdownloads%2Fsteamworks_sdk.zip
  
Line 239: Line 241:
 
This is necessary for the Steam plugin.
 
This is necessary for the Steam plugin.
  
 +
=== Install NSIS ===
 +
https://nsis.sourceforge.io/Download
 +
 +
Install the software as you would any software. We will edit Makefile.def for it later.
  
 
== Install Gideros from Source ==
 
== Install Gideros from Source ==
 
=== Fetch gideros source code ===
 
=== Fetch gideros source code ===
(PC) Open MSYS2 32 bit shell
+
Open MSYS2 shell (msys2_shell.cmd).
  
Navigate to the folder where you want to work.
+
Navigate to the folder where you want to work. For example I want to put Gideros Github repo in my dev folder:
 
<source lang="bash">
 
<source lang="bash">
git clone https://github.com/gideros/gideros
+
$ cd /c/dev
 
</source>
 
</source>
  
=== Configure scripts ===
+
Then in the dev folder we will clone Gideros from GH to a folder of our choice (“gideros_dev” for example) using this git command:
Make a copy of the file gideros/scripts/Makefile.def.example, rename it to Makefile.def and update the file copy according to your installation. Ensure that the QT\_ARCH and QT_TOOLSARCH paths are formatted correctly according to your Qt install directory structure (see below that they are named differently by Qt). Example:
 
 
 
On PC:
 
For Qt:
 
 
<source lang="bash">
 
<source lang="bash">
QTBASEDIR=/c/Qt
+
git clone https://github.com/gideros/gideros gideros_dev
QT_ARCH=mingw53_32
+
</source>
QT_TOOLSARCH=mingw530_32
 
QTVER=5.9.1
 
QT5ICUVER=59
 
  
# for steam:
 
STEAMSDK=/c/Applications/steamworks_sdk_142
 
export STEAMSDK
 
  
# for Android:
+
'''If you already have cloned Gideros to a local repo you can update it''' (cf: https://stackoverflow.com/questions/26984847/how-to-update-local-repo-with-master):
# on Windows, also add this to PATH
+
* in MSYS2 shell (msys2_shell.cmd) navigate to your local repo, example:
NDK_HOME=/c/android/android-ndk-r17b
+
<source lang="bash">
NDKBUILD=cmd //c /c/android/android-ndk-r17b/ndk-build.cmd
+
cd /c/dev/gideros_dev
# We use windows syntax for this one, as it will be used by gradle.bat script
+
</source>
JAVA_HOME=C:\Program Files\Java\jdk1.8.0_144
+
* check your current branch with:
# Windows syntax with quadruple backslashs!
+
<source lang="bash">
ANDROID_HOME=C:\\\\Users\\\\Gideros\\\\AppData\\\\Local\\\\Android\\\\sdk
+
git branch
 +
</source>
 +
* then update your local branch with the remote branch (''master'' should be the name of your branch):
 +
<source lang="bash">
 +
git pull origin master
 +
</source>
  
# for WinRT:
 
FXC="/c/Program Files (x86)/Windows Kits/8.1/bin/x86/fxc.exe"
 
MSBUILD="/c/Program Files (x86)/MSBuild/14.0/Bin/MSbuild.exe"
 
  
# for html5:
+
'''If you want to update your existing local repo you can try:'''
EMSDK=/c/emsdkwin
+
<source lang="bash">
EMSDKPATH=$(EMSDK):$(EMSDK)/clang/e1.35.0_64bit:$(EMSDK)/node/4.1.1_64bit/bin:$(EMSDK)/python/2.7.5.3_64bit:$(EMSDK)/emscripten/1.35.0
+
git fetch
EMSDK_PREFIX=PATH=$(EMSDKPATH):$$$$PATH cmd //c
+
(git merge OR git pull)
CRUNCHME=crunchme-win32.exe
 
 
</source>
 
</source>
  
  
=== Complete working example Makefile.def for Windows ===
+
'''If you already have cloned Gideros to a local repo but you made some changes to some files, then you may get this error message''':
Here is a working example, you will have to change the filename details to match your setup:
+
  '''error: Your local changes to the following files would be overwritten by merge'''
example Makefile.def file
+
  '''Please, commit your changes or stash them before you can merge.'''
 
+
* to fix this issue in MSYS2 shell (msys2_shell.cmd) you can try this:
 
<source lang="bash">
 
<source lang="bash">
QTBASEDIR=/c/Qt
+
git reset --hard
 +
</source>
  
#export PATH=$PATH:~/Android_SDK/NDK/
 
  
# on Windows, also add this to PATH
+
'''If you want to go to a specific branch, you can try''':
NDK_HOME=/c/android-ndk
+
<source lang="bash">
 +
git checkout `git rev-list -n 1 --before="2022-10-10 14:00" master`
 +
</source>
  
NDKBUILD=cmd //c /c/android-ndk/ndk-build.cmd
+
=== Configure scripts ===
 +
Make a copy of the file gideros/scripts/Makefile.def.example, rename it to '''Makefile.def''' and update the file copy according to your installation. Ensure that the QT\_ARCH and QT_TOOLSARCH paths are formatted correctly according to your Qt install directory structure (see below that they are named differently by Qt). Here is the current version you will find in gideros scripts folder, please adapt accordingly:
  
# remember to escape disallowed characters, or wrap in quotes
+
<source lang="bash">
JAVA_HOME=C:\Program Files (x86)\Java\jdk1.8.0_181
+
QTBASEDIR=/c/Applications/Qt
ANT_HOME=/c/apache-ant-1.10.5
+
MAKEJOBS=-j8
ANDROID_HOME=C:\\\\Users\\\\antho\\\\AppData\\\\Local\\\\Android\\\\Sdk
+
NDKBUILD=cmd //c /c/Applications/android-ndk-r17b/ndk-build.cmd
 +
JAVA_HOME=C:\Program Files\Android\Android Studio\jre
 +
ANDROID_HOME=C:\\\\Users\\\\User\\\\AppData\\\\Local\\\\Android\\\\Sdk
 +
FXC="/c/Program Files (x86)/Windows Kits/10/bin/10.0.19041.0/x86/fxc.exe"
 +
# the following is one line!
 +
MSBUILD="/c/Program Files/Microsoft Visual Studio/2022/Community/MSbuild/Current/Bin/MSBuild.exe"
  
FXC="/c/Program Files (x86)/Windows Kits/8.1/bin/x86/fxc.exe"
+
EMSDK=/c/Applications/emscripten
FXCx64="/c/Program Files (x86)/Windows Kits/8.1/bin/x64/fxc.exe"
+
EMSDKPATH=$(EMSDK):$(EMSDK)/node/14.15.5_64bit/bin:$(EMSDK)/python/3.9.2-1_64bit:$(EMSDK)/upstream/emscripten:$(EMSDK)/upstream/bin
MSBUILD="/c/Program Files (x86)/MSBuild/14.0/Bin/MSBuild.exe"
+
EMSDK_PREFIX=PATH=$(EMSDKPATH):$$$$PATH
 +
EMSDK_PREFIX=cmd //c
  
EMSDK=/c/emsdk
+
STEAMSDK=/c/Applications/steamworks_sdk_142
EMSDKPATH=$(EMSDK):$(EMSDK)/clang/e1.38.12_64bit:$(EMSDK)/node/8.9.1_64bit/bin:$(EMSDK)/python/2.7.13.1_64bit/python-2.7.13.amd64:$(EMSDK)/emscripten/1.38.12:/c/cmake-3.12.3-win32-x86/bin
+
export STEAMSDK
EMSDK_PREFIX=PATH=$(EMSDKPATH):$$$$PATH
 
  
#EMSDK_PREFIX+=BINARYEN_ROOT=$(EMSDK)/clang/e1.38.12_64bit/binaryen
+
#WIN32_BIN=/mingw32/bin
#EMSDK_PREFIX+=EMSDK=$(EMSDK)
+
WIN32_BIN=/mingw64/bin
#EMSDK_PREFIX+=EMSCRIPTEN=$(EMSDK)/emscripten/1.38.12
+
export WIN32_BIN
#EMSDK_PREFIX+=EMSCRIPTEN_ROOT=$(EMSDK)/emscripten/incoming
 
#EMSDK_PREFIX+=JAVA=$(EMSDK)/emscripten/java/8.152_64bit/bin/java.exe
 
EMSDK_PREFIX+=cmd //c
 
  
 
CRUNCHME=crunchme-qt-win.exe
 
CRUNCHME=crunchme-qt-win.exe
 
STEAMSDK=/c/steamworks_sdk_142
 
export STEAMSDK
 
 
 
NSIS=cmd //c "/c/Program Files (x86)/NSIS/makensis.exe"
 
NSIS=cmd //c "/c/Program Files (x86)/NSIS/makensis.exe"
 
WIN_SIGN="/c/Program Files (x86)/Windows Kits/10/bin/x86/signtool.exe"
 
WIN_SIGN="/c/Program Files (x86)/Windows Kits/10/bin/x86/signtool.exe"
WIN_KEYSTORE=/c/comodo-code-signing.p12
+
#WIN_KEYSTORE=/path/to/cert.p12
WIN_KEYPASS=xxxx
+
#WIN_KEYPASS=KeyPassword
WIN_KEYTSS="http://timestamp.comodoca.com"
+
#WIN_KEYTSS="http://timestamp.comodoca.com"
  
 
MAC_HOST=user@host
 
MAC_HOST=user@host
Line 336: Line 334:
 
OSX_SIGNING_PASSWORD="keychain password"
 
OSX_SIGNING_PASSWORD="keychain password"
  
QT_ARCH=mingw53_32
+
QT_ARCH=mingw_64
QT_TOOLSARCH=mingw530_32
+
QT_TOOLSARCH=mingw900_64
QTVER=5.10.1
+
#QT_TOOLSARCH=mingw1120_64
QT5ICUVER=59  #deprecated stuff
+
QTVER=6.2.2
 +
#QTVER=6.2.3
 +
QT5ICUVER=54
 +
#QT5ICUVER=56
 
</source>
 
</source>
  
 
+
== Building Gideros ==
=== Fetch additional repositories ===
+
After setting up the Makefile.def, in MSYS2 shell (msys2_shell.cmd) navigate to your Gideros repo:
Go into just cloned gideros source folder and run make prep.repo
 
 
<source lang="bash">
 
<source lang="bash">
cd gideros
+
cd gideros_dev
make -f scripts/Makefile.gid prep.repo
 
 
</source>
 
</source>
  
 
+
Then the first steps to build Gideros are:
== Building ==
 
If you have all dependencies in place for all targets, you can build everything at once via MSYS2 or Terminal with:
 
 
<source lang="bash">
 
<source lang="bash">
make -f scripts/Makefile.gid
+
make -f scripts/Makefile.gid prep.repo
 +
make -f scripts/Makefile.gid qscintilla
 +
make -f scripts/Makefile.gid qlexilla
 +
make -f scripts/Makefile.gid versioning
 
</source>
 
</source>
  
 
+
=== Build QT tools: ===
=== Compilation on PC ===
+
This will build Gideros Studio and all its associated apps.
Open MSYS2 shell (msys2_shell.cmd). Standard compilation is 32 bit so use a 32 bit shell. Make sure you have installed the necessary build tools in MSYS2 using pacman, as detailed in Install MSYS2 Console
 
 
 
Navigate to gideros folder
 
 
 
==== Build QT tools: ====
 
 
<source lang="bash">
 
<source lang="bash">
 
make –f scripts/Makefile.gid qtapp.install
 
make –f scripts/Makefile.gid qtapp.install
 
</source>
 
</source>
  
=> files GiderosStudio.exe, GiderosPlayer.exe, GiderosTexturePacker.exe (…) in Build.Win folder  
+
=> files GiderosStudio.exe, GiderosPlayer.exe, GiderosTexturePacker.exe (…) in '''Build.Win folder'''
  
==== Android: ====
+
=== Android: ===
 +
This will build Gideros Android export template.
 
<source lang="bash">
 
<source lang="bash">
 
make –f scripts/Makefile.gid android.install
 
make –f scripts/Makefile.gid android.install
Line 377: Line 373:
 
=> file GiderosAndroidPlayer.apk in folder Build.Win/Players
 
=> file GiderosAndroidPlayer.apk in folder Build.Win/Players
  
==== winRT: ====
+
=== winRT: ===
 +
This will build Gideros winRT export template.
 
<source lang="bash">
 
<source lang="bash">
 
make –f scripts/Makefile.gid winrt.install
 
make –f scripts/Makefile.gid winrt.install
Line 386: Line 383:
 
Note: if necessary, open the solution, gideros/winRT_example/giderosgame.sln in Visual Studio. Check that the SQLite version for Windows and Windows Phone is up to date. Save and close the solution.
 
Note: if necessary, open the solution, gideros/winRT_example/giderosgame.sln in Visual Studio. Check that the SQLite version for Windows and Windows Phone is up to date. Save and close the solution.
  
==== win32: ====
+
=== win32: ===
 +
This will build Gideros win32 export template.
 
<source lang="bash">
 
<source lang="bash">
 
make –f scripts/Makefile.gid win32.install
 
make –f scripts/Makefile.gid win32.install
Line 393: Line 391:
 
=> files in folder Build.Win/Templates/win32
 
=> files in folder Build.Win/Templates/win32
  
==== Html5: ====
+
=== Html5: ===
 +
This will build Gideros Html5 export template.
 
<source lang="bash">
 
<source lang="bash">
 
make –f scripts/Makefile.gid html5.install
 
make –f scripts/Makefile.gid html5.install
Line 400: Line 399:
 
=> files in folders Build.Win//Players/Html5 and Build.Win/Templates/Html5
 
=> files in folders Build.Win//Players/Html5 and Build.Win/Templates/Html5
  
==== Plugins: ====
+
=== Plugins: ===
 
<source lang="bash">
 
<source lang="bash">
 
make –f scripts/Makefile.gid bundle.win
 
make –f scripts/Makefile.gid bundle.win
Line 407: Line 406:
 
=> folder bin and file gplugin in folder Build.Win/All Plugins
 
=> folder bin and file gplugin in folder Build.Win/All Plugins
  
==== To build everything that can be built on Windows: ====
+
=== To build everything that can be built on Windows: ===
 
<source lang="bash">
 
<source lang="bash">
 
make -f scripts/Makefile.gid all
 
make -f scripts/Makefile.gid all
Line 443: Line 442:
  
  
 
+
----
 
 
 
 
 
 
  
 
== Troubleshooting: ==
 
== Troubleshooting: ==
Line 541: Line 537:
 
Sprinkles44 commented on 30 Jul 2021  
 
Sprinkles44 commented on 30 Jul 2021  
 
Thank you so much, it works perfectly now.
 
Thank you so much, it works perfectly now.
 +
 +
 +
 +
 +
 +
 +
== END ==

Revision as of 09:56, 17 February 2023

The following instructions are for developers who want to contribute to or otherwise experiment with the Gideros C/C++ engine and are not necessary for either building or deploying apps made with Gideros.

The Gideros project consists of the Gideros Studio IDE, the Gideros SDK libraries, Gideros Texture Packer, Gideros Font Creator, "players" or export templates for all the platforms Gideros supports, all targets of all plugins, a daemon and a bridge. The build system is flexible, so you only need the tools for the targets you are interested in deploying to with Qt (and MSYS2 on Windows) being a realistic minimum.


A QUICK GUIDE TO BUILD GIDEROS STUDIO ONLY

Here are the easy steps to build Gideros Studio only without all the bells and whistles (no android, no html5, ...). Please follow the steps:

  • 1.1 Install QT6
  • 1.2 Install MSYS2 Console
  • 2.1 Fetch gideros source code

Since we only build Gideros Studio (if you have not set up the plugins), you need to edit scripts/Makefile.gid:

PLUGINS_WIN=$(PLUGINS_ALL) clipper struct controller camera 
#PLUGINS_WINONLY=spout steam luamidi
PLUGINS_WINONLY=luamidi
  • 2.2 Configure scripts

Your Makefile.def can look something as simple as this:

#QTBASEDIR=/c/Applications/Qt
QTBASEDIR=/c/Qt6
MAKEJOBS=-j8

#WIN32_BIN=/mingw32/bin
#WIN32_BIN=/c/msys64/mingw32/bin
WIN32_BIN=/c/msys64/mingw64/bin
export WIN32_BIN

QT_ARCH=mingw_64
#QT_TOOLSARCH=mingw900_64
QT_TOOLSARCH=mingw1120_64
QTVER=6.2.2
QT5ICUVER=54
  • 3 Building Gideros
  • 3.1 Build QT tools

And that's it, you will have latest Gideros Studio and all its tools available.

Extra: you can copy the templates from original Gideros and put them in the templates folder of your Gideros. You will then be able to export to usual devices (android, html, ...)

Windows 10 64bit

Install QT

You can download the Qt for open source users at:

https://www.qt.io/download

Double click on the downloaded file and follow instructions.

Recommended version 6.2.2 with MinGW 9.0 (if you don’t see it check the box Archive and click Filter). Should work fine with Qt version 6.2.3 (LTS) and MinGW 11.20.

When installing, expand the tree view and ensure you have checked the following boxes:

  • Qt 6.2.2: MinGW 9.0.0 64-bit
  • Qt 6.2.2: Qt 5 compatibility module
  • Qt 6.2.2, Additional Libraries: Qt Multimedia
  • Qt 6.2.2, Additional Libraries: Qt Websockets
  • Developer and Designer Tools: MinGW 11.2.0 64-bit

Here is a screenshot of the Qt modules:

01 qt6 installing modules10x.png

01 qt6 installing modules11x.png

If you already have Qt6 installed without those modules, you can add them via Qt MaintenanceTool.exe located in your Qt folder like so:

01 qt6 maintenance tool.png

When you are done click finish.

Install MSYS2 Console

https://www.msys2.org/

Once installed, open MSYS2 shell (msys2_shell.cmd):

02 msys 01.png

Then run the following commands:

note: copy/paste won’t work, you have to type the commands:

pacman -Sy pacman
pacman -Syu
pacman -Su
pacman -S git
pacman -S make
pacman -S python
pacman -S tar
pacman -S zip
pacman -S unzip
pacman -S base-devel

# For exporting apps to the win32/32bit platform under a MinGW64
pacman -S mingw-w64-i686-toolchain # note: if asked choose ALL #
pacman -S mingw-w64-i686-glew
pacman -S mingw-w64-i686-curl
pacman -S mingw-w64-i686-libpng
# For exporting apps to the win32/64bit platform under a MinGW64
pacman -S mingw-w64-x86_64-toolchain # note: if asked choose ALL #
pacman -S mingw-w64-x86_64-glew
pacman -S mingw-w64-x86_64-curl
pacman -S mingw-w64-x86_64-libpng

note: for the i686-toolchain/x86_64-toolchain if you get error: failed to commit transaction (invalid or corrupted package), you may need either reinstalling a newer version of msys or you can try these commands:

rm -r /etc/pacman.d/gnupg/
pacman-key --init
pacman-key --populate msys2

You should then redo the pacman commands from the begining (pacman -Sy pacman, ...).

Install Android Studio and NDK

(Not tested yet)

https://developer.android.com/studio/index.html

https://developer.android.com/ndk/downloads/older_releases.html (old for gideros ndk 17c)

https://github.com/android/ndk/wiki (for newer releases)

Recommended NDK is 17c (the x86_64 version)

Once downloaded, copy the contents of the NDK to your home or C: folder, rename the folder that you copied to 'android-ndk', for example you will end up with 'c:\android-ndk' and below that folders that say build, meta, platforms, etc.

Install JAVA

You need the Java JDK from Oracle:

https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

Or an open JDK (recommanded):

https://adoptopenjdk.net/

Install Visual Studio

(Not tested yet)

Visual Studio Community Edition 2022:

https://www.visualstudio.com/downloads/

Select the box Developing for Desktop apps and install.

– to come -- For UWP ads: https://social.msdn.microsoft.com/Forums/windowsapps/en-US/db8d44cb-1381-47f7-94d3-c6ded3fea36f/microsoft-ad-monetization-platform-shut-down-as-of-june-1st?forum=aiamgr – to come --

Install Python

(Not tested yet)

https://www.python.org/downloads/release/python-2712/

You need Python 2.7.12 or later to install emscripten properly.

Once installed, add it to your command line path, eg: c:\python27. On windows you can do this by right-clicking on 'myComputer' or 'This PC', go to 'Properties', click 'Advanced System Settings', Click 'Environmental Variables', double-click 'Path', add 'c:\python27'

Install emscripten

(Not tested yet)

http://kripken.github.io/emscripten-site/

You need this if you want to build for HTML5 + Facebook games.

Using a shell or MSYS2 (msys2_shell.cmd) go to your home or C: folder and type:

git clone https://github.com/juj/emsdk.git

Once that has completed open a command prompt in that folder on Windows.

Using emsdk, install and activate all the latest packages:

note: (on non-PC put ./ before emsdk)

emsdk install latest
emsdk activate latest
emsdk_env.bat

To use incoming branch of emscripten, use these commands instead:

note: (on non-PC put ./ before emsdk)

emsdk install sdk-incoming-64bit
emsdk activate sdk-incoming-64bit

To further use Gideros own git fork of emscripten:

cd emscripten/incoming
#Add a git remote link to your own repository
git remote add gideros https://github.com/gideros/emscripten.git
#Obtain the changes in your link
git fetch gideros
#Switch the emscripten-incoming tool to use your fork
git checkout -b gideros_incoming --track gideros/incoming
#Get back to emscripten directory and rebuild
cd ../..
emsdk install sdk-incoming-64bit

These can also be installed within emsdk: git, crunch, and spidermonkey:

note: (on non-PC put ./ before emsdk)

emsdk install git-1.9.4
emsdk install crunch-1.03
emsdk install spidermonkey-37.0.1-64bit
emsdk activate git-1.9.4
emsdk activate crunch-1.03
emsdk activate spidermonkey-37.0.1-64bit
emsdk_env.bat

Make sure the environment variable EM_CONFIG is set to the location of your emscripten config file.

The emscripten build also needs the CMake command. You can download it and extract it to your home or C: folder. Don't forget to add it's path to the end of the EMSDKPATH in Makefile.def.

https://cmake.org/download/

Install Steam SDK

(Not tested yet)

https://partner.steamgames.com/?goto=%2Fdownloads%2Fsteamworks_sdk.zip

Extract the archive/zip file to your home or C: folder, for example if the file is called 'steamworks_sdk_142.zip' then you will have a 'c:\steamworks_sdk_142' folder with a solder called 'sdk' within it. The sdk folder contains other folders such as glmgr, public, tools, etc.

This is necessary for the Steam plugin.

Install NSIS

https://nsis.sourceforge.io/Download

Install the software as you would any software. We will edit Makefile.def for it later.

Install Gideros from Source

Fetch gideros source code

Open MSYS2 shell (msys2_shell.cmd).

Navigate to the folder where you want to work. For example I want to put Gideros Github repo in my dev folder:

$ cd /c/dev

Then in the dev folder we will clone Gideros from GH to a folder of our choice (“gideros_dev” for example) using this git command:

git clone https://github.com/gideros/gideros gideros_dev


If you already have cloned Gideros to a local repo you can update it (cf: https://stackoverflow.com/questions/26984847/how-to-update-local-repo-with-master):

  • in MSYS2 shell (msys2_shell.cmd) navigate to your local repo, example:
cd /c/dev/gideros_dev
  • check your current branch with:
git branch
  • then update your local branch with the remote branch (master should be the name of your branch):
git pull origin master


If you want to update your existing local repo you can try:

git fetch
(git merge OR git pull)


If you already have cloned Gideros to a local repo but you made some changes to some files, then you may get this error message:

 error: Your local changes to the following files would be overwritten by merge
 Please, commit your changes or stash them before you can merge.
  • to fix this issue in MSYS2 shell (msys2_shell.cmd) you can try this:
git reset --hard


If you want to go to a specific branch, you can try:

git checkout `git rev-list -n 1 --before="2022-10-10 14:00" master`

Configure scripts

Make a copy of the file gideros/scripts/Makefile.def.example, rename it to Makefile.def and update the file copy according to your installation. Ensure that the QT\_ARCH and QT_TOOLSARCH paths are formatted correctly according to your Qt install directory structure (see below that they are named differently by Qt). Here is the current version you will find in gideros scripts folder, please adapt accordingly:

QTBASEDIR=/c/Applications/Qt
MAKEJOBS=-j8
NDKBUILD=cmd //c /c/Applications/android-ndk-r17b/ndk-build.cmd
JAVA_HOME=C:\Program Files\Android\Android Studio\jre
ANDROID_HOME=C:\\\\Users\\\\User\\\\AppData\\\\Local\\\\Android\\\\Sdk
FXC="/c/Program Files (x86)/Windows Kits/10/bin/10.0.19041.0/x86/fxc.exe"
# the following is one line!
MSBUILD="/c/Program Files/Microsoft Visual Studio/2022/Community/MSbuild/Current/Bin/MSBuild.exe"

EMSDK=/c/Applications/emscripten
EMSDKPATH=$(EMSDK):$(EMSDK)/node/14.15.5_64bit/bin:$(EMSDK)/python/3.9.2-1_64bit:$(EMSDK)/upstream/emscripten:$(EMSDK)/upstream/bin
EMSDK_PREFIX=PATH=$(EMSDKPATH):$$$$PATH
EMSDK_PREFIX=cmd //c

STEAMSDK=/c/Applications/steamworks_sdk_142
export STEAMSDK

#WIN32_BIN=/mingw32/bin
WIN32_BIN=/mingw64/bin
export WIN32_BIN

CRUNCHME=crunchme-qt-win.exe
NSIS=cmd //c "/c/Program Files (x86)/NSIS/makensis.exe"
WIN_SIGN="/c/Program Files (x86)/Windows Kits/10/bin/x86/signtool.exe"
#WIN_KEYSTORE=/path/to/cert.p12
#WIN_KEYPASS=KeyPassword
#WIN_KEYTSS="http://timestamp.comodoca.com"

MAC_HOST=user@host
MAC_PATH=gideros/gideros
OSX_SIGNING_IDENTITY="ID"
OSX_SIGNING_PASSWORD="keychain password"

QT_ARCH=mingw_64
QT_TOOLSARCH=mingw900_64
#QT_TOOLSARCH=mingw1120_64
QTVER=6.2.2
#QTVER=6.2.3
QT5ICUVER=54
#QT5ICUVER=56

Building Gideros

After setting up the Makefile.def, in MSYS2 shell (msys2_shell.cmd) navigate to your Gideros repo:

cd gideros_dev

Then the first steps to build Gideros are:

make -f scripts/Makefile.gid prep.repo
make -f scripts/Makefile.gid qscintilla
make -f scripts/Makefile.gid qlexilla
make -f scripts/Makefile.gid versioning

Build QT tools:

This will build Gideros Studio and all its associated apps.

make –f scripts/Makefile.gid qtapp.install

=> files GiderosStudio.exe, GiderosPlayer.exe, GiderosTexturePacker.exe (…) in Build.Win folder

Android:

This will build Gideros Android export template.

make –f scripts/Makefile.gid android.install

=> file GiderosAndroidPlayer.apk in folder Build.Win/Players

winRT:

This will build Gideros winRT export template.

make –f scripts/Makefile.gid winrt.install

=> file _bundle.appxupload in folder Build.Win/Players/WinRT

Note: if necessary, open the solution, gideros/winRT_example/giderosgame.sln in Visual Studio. Check that the SQLite version for Windows and Windows Phone is up to date. Save and close the solution.

win32:

This will build Gideros win32 export template.

make –f scripts/Makefile.gid win32.install

=> files in folder Build.Win/Templates/win32

Html5:

This will build Gideros Html5 export template.

make –f scripts/Makefile.gid html5.install

=> files in folders Build.Win//Players/Html5 and Build.Win/Templates/Html5

Plugins:

make –f scripts/Makefile.gid bundle.win

=> folder bin and file gplugin in folder Build.Win/All Plugins

To build everything that can be built on Windows:

make -f scripts/Makefile.gid all

Then you need to copy all the plugins to the 'Build.Win' folder with:

make -f scripts/Makefile.gid bundle.win

Cleaning

If you want to reset the build process and start again then you can issue a 'clean' command. To do this type 'make -f scripts/Makefile.gid clean'. Example:

make -f scripts/Makefile.gid clean

Sometimes you need to make clean a particular build. To do this type 'make -f scripts/Makefile.gid' followed by something like 'html5' then '.clean'. Example:

make -f scripts/Makefile.gid html5.clean










Troubleshooting:

MSYS2 on Windows 10 - cannot update the package database using pacman #2589 Sprinkles44 opened this issue on 28 Jul 2021 · 7 comments MSYS2 on Windows 10 - cannot update the package database using pacman #2589 Sprinkles44 opened this issue on 28 Jul 2021 · 7 comments Comments


Sprinkles44 commented on 28 Jul 2021 I tried to update my MSYS2 on Windows 10 (as per the instructions on https://www.msys2.org/) and I got this error:

OscarAlvarez@Lambda-Station-OA MINGW64 ~
$ pacman -Syu
error: config file /etc/pacman.d/mirrorlist.mingw could not be read: No such file or directory

So I did a fresh install of MSYS2 on Windows 10. I got the binaries from the MSYS2 website and installed it successfully. Now, I am getting the same error. I went into the /etc/pacman.d/ directory and this is what was inside:

OscarAlvarez@Lambda-Station-OA MINGW64 /etc/pacman.d
$ ls
gnupg  mirrorlist.clang64  mirrorlist.mingw32  mirrorlist.mingw64  mirrorlist.msys  mirrorlist.ucrt64

I didn't find the file so I created an empty file with the name "mirrorlist.mingw" and ran the update but to no avail. So I just deleted the empty file I created. No other flags like -S, -Su, or -Syy, etc. work and produce the same error. Thank you.

  • OS: Windows 10 Education


Collaborator Biswa96 commented on 28 Jul 2021 There is something wrong in your pc setup. Antivirus software may delete files without any reason. To workaround this situation


Author Sprinkles44 commented on 28 Jul 2021 I only have the Windows 10 antivirus that comes with the OS. I do not have any other antivirus software. I downloaded the file then opened MSYS2 and ran the command. I get the same error:

OscarAlvarez@Lambda-Station-OA MSYS ~
# pacman -U --overwrite=* pacman-mirrors-20210706-1-any.pkg.tar.zst
error: config file /etc/pacman.d/mirrorlist.mingw could not be read: No such file or directory

It seems to me that I can't run any pacman command. You say to run that command but where do I run it, in MSYS2? If I run it with MSYS2, do I move the downloaded file to a specific directory or will the downloaded file just be detected automatically anywhere on my system? It's in my download folder right now. Thank you.


Collaborator Biswa96 commented on 28 Jul 2021

error: config file /etc/pacman.d/mirrorlist.mingw could not be read: No such file or directory

Create that empty file as you have said in original post. Then run the pacman -U command. You say to run that command but where do I run it, in MSYS2? Any msys2/mingw window. will the downloaded file just be detected automatically anywhere on my system? You need to specify the full path of that .pkg.tar.zst file in that pacman -U command. Or drag and drop the .pkg.tar.zst file in msys2 window, it will automatically show the full path.


Author Sprinkles44 commented on 30 Jul 2021

error: config file /etc/pacman.d/mirrorlist.mingw could not be read: No such file or directory

Create that empty file as you have said in original post. Then run the pacman -U command. You say to run that command but where do I run it, in MSYS2? Any msys2/mingw window. will the downloaded file just be detected automatically anywhere on my system? You need to specify the full path of that .pkg.tar.zst file in that pacman -U command. Or drag and drop the .pkg.tar.zst file in msys2 window, it will automatically show the full path. Thank you that seems to have worked (sort of). Now I only get this error:

OscarAlvarez@Lambda-Station-OA MSYS ~
$ pacman -Syu
:: Synchronizing package databases...
error: failed to synchronize all databases (no servers configured for repository)

I think I have to add to the repository or something like that but I am not too sure. Thank you again for helping.


Collaborator jeremyd2019 commented on 30 Jul 2021

mv /etc/pacman.d/mirrorlist.mingw.pacnew /etc/pacman.d/mirrorlist.mingw


Author Sprinkles44 commented on 30 Jul 2021 Thank you so much, it works perfectly now.




END