Candy Android Client

This project is the Android client for the Candy VPN project: https://github.com/lanthora/candy

This client is built with a Go mobile library for the protocol logic.

Download APK

You can download the latest version for Android directly from the Releases: https://github.com/Jercrox/Candy_Android_Client/releases

Prerequisites for compiling the Android client

• Go 1.18+
• Android Studio / Android SDK
• gomobile tool installed:

  go install golang.org/x/mobile/cmd/gomobile@latest
  gomobile init
  

Local Configuration

Before building, you must create a local.properties file in the root of the Android directory to point to your Android SDK. This file is specific to your local machine and should not be committed to version control.

1. Create a file named local.properties in the Android folder.
2. Add the following content (adjusting the path to match your user name):

## This file must *NOT* be checked into Version Control Systems,
# as it contains information specific to your local configuration.
#
# Location of the SDK. This is only used by Gradle.
# For customization when using a Version Control System, please read the
# header note.
#
sdk.dir=C\:\\Users\\%username%\\AppData\\Local\\Android\\Sdk

Note: Replace %username% with your Windows session user name. Ensure the path points to where your Android SDK is actually installed.

Building the Go Library

1. Navigate to the candy_go directory:

   cd candy_go
   

2. Build the Android AAR:

   gomobile bind -target=android -o ../app/libs/candy.aar .
   

   Note: You may need to create the ../app/libs directory if it doesn't exist.

Building the APK

1. Open this Android folder in Android Studio.
2. Sync the project with Gradle files.
3. Build and Run on your device/emulator.

License

This project is licensed under the MIT License - see the LICENSE file for details.