I am making this little guite in order to help those who want to run custom versions of Quelea.
I hope this will help you avoid the sumbling blocks i went through. Ideally this should be in the readme.md or the documenttaion.
1.Requriements
In order to compile Quelea from source you need a an x86 CPU type machine running Windows or Linux (recommending latest). In this case we will explain how to do it on windows.
Install the the software required:
- Quelea source repository URL (GitHub - quelea-projection/Quelea: Open source projection software for churches.)
- Git / Desktop Git Client (Git - Downloads) - optional but reccomended
- InteliJ IDEA(Download IntelliJ IDEA – The Leading Java and Kotlin IDE)
- Java, version 17 or higher - install from within InteliJ IDEA
- Innosetup (https://jrsoftware.org/isinfo.php)
2.Download/Clone and Open the Project
First you have to select what fork you want to depoy. For most people this would be the official repository master branch, but it could be a fork and a branch with a feature.
Then load the project in Intelij.
-
Option 1: Use
git clone https://github.com/quelea-projection/Queleaor alternative fork URL to download the code locally from your terminal. Useopenand select the project directory and open the project.
-
Option 2: You can do that with a Git Desktop client too (https://desktop.github.com/), from which is really easy to select differnt banches. Use
openand select the project directory and open the project.
-
Option 3: Open Intelij, in the welcome screen select
Get from VCS' and thenGithub’ to clone the repository with the URL.
Note branch selection can also be done from within Intelij but a plugin might be needed.
3.Load gradle configuration
At this point you have the project loaded. This is a gradle project therefore locate the build.gradle from under the root directory name follwoed by Quelea/build.gradle.
A popup might appear to integrate or load the gradle configuration accept that and any security confirmations.
If not open the Run/Debug Configurations window and add new configuration by selecting gradle.
Can also use edit configuration tempaltes
Now select the directory where the gradle is stored and the gradle file will be located automatically.
If successful an elephant icon should appear on the side bar somewhere.
4.Setup Java SDK
Once the configuration is loaded it make take some time for all the setup to be completed.
The first thing to do is to build and run the project to verify everything is working as expected, but before that we need to setup Java.
Opne Project Structure and select the SDK.
Select Java SDK 17, and you may have to install it if you don’t have it already.
Just follow the onscreen instructions.
Gradle also needs to know what Java Vritual Environment (JVM) to use. This step is similar to setting up the project SDK, either can be done first.
Go to Settings
In the search bar type gradle selelect the “Gradle” tab submenu and select the same version for the Gradle JVM.
5.Run, verify the build, create deploymnet installers
Run the run task
If everything is ok the project should build and open.
- This could take a while
- You may or may not get
warrningmessages. This is OK! - You should not get any
errormessages! - When running you shouldn’t encounter any runtime errors.
- Note, (at least for me) when the Quelea opens there are 2 things that might not appear to work:
- Any database songs or other user items might not appear.
- Secondly the configuration menu might not open. (! I am not sure why that is but it is not a problem). You are currently running it in debug mode.
- Ignore compaints about Gstreamer( or previously VLC) this is 3rd party external library.
Assuming you have previously isntalled innosetup the paths should be automatically there.
Run the dist gradgle task.
This will take a while. Once done you can find the installers under ...\Quelea\Quelea\dist\standalone\
Congratulations!