Setup working environment

Setup your working environment for contributing.

1. Git

• install git
• setup git

Make sure git is on your PATH (Windows, OSX)

MANDATORY: set this git setting: git config --global push.default simple

2. Android Studio

• install Android Studio

3. Clone Repository

• open Android Studio and select Get from Version Control
• sign in with your GitHub account and select Catrobat/Catroid

OR

• open git bash and run git clone https://github.com/Catrobat/Catroid.git
• open as a project in Android Studio (not import!)

4. Configuration

• wait until Gradle has finished configuration (approx. 1 minute)
• to constantly ignore some configuration files changed by Android Studio run Gradle Task :gitSkipWorktreeForIntellijConfigFiles

Possible Errors+Solutions

• ERROR: Module 'catroid': platform 'android-29' not found Go to Tools -> sdk manager -> install API Level 29 then restart.
• Wrong Build-tool Version Install Version 19.1.0 in Tools->Android->SDK Manager
• No Access to SDK-Manager Create a new Project, open there the SDK-Manager and Update the Build-tools
• Everything in SDK-Manager is installed, but Gradle says it is missing? you have more than one SDK-Manager installed. Check $PROJECT_DIR/local.properties which one is used
• Cant Update Build-tools on Windows run Android Studio as Administrator
• Exception: null: null Update Android Studio to Version 0.6.1 or higher
• Can't create Emulator Device Spaces in Emulator name?
• gradle not found Maybe Gradle is not installed. Then you should use ./gradlew assembleDebug or gradlew.bat assembleDebug instead

Notes

• egit (Eclipse extension for git) will ignore some git settings and will make trouble with line endings!
• You should have following path variables defined:
  • JAVA_HOME
  • ANDROID_HOME
  • and your git location in PATH

How to set (global or repository-specific) username/email configuration:

globally (for each and every git repository):

open git bash anywhere

Set your username:

git config --global user.name "YOUR FIRST_NAME & LAST_NAME"

Set your email address:

git config --global user.email "YOUR EMAIL ADDRESS"

repository-specific (only for catroid repository):

open git bash in Catroid folder

Set your username:

git config user.name "YOUR FIRST_NAME & LAST_NAME"

Set your email address:

git config user.email "YOUR EMAIL ADDRESS"

Verify your configuration by displaying your configuration file:

cat .git/config