Skip to content
c:geo - The powerful Android geocaching app.
Java HTML Shell
Find file
Failed to load latest commit information.
.idea Merge branch 'release' into upstream
android-support-v7-appcompat Adjust IntelliJ IDEA files
cgeo-calendar Fixes #5390, Search result cannot be saved
cgeo-contacts Update IntelliJ settings
common/src/cgeo Move common code into separate source folder
crowdin Fix crowdin local patches application
gradle/wrapper Upgrade to Gradle 2.11
main crowdin: New translations
mapsforge_patches fix #2171: MapsForge-related crash on Android 4.2
mapswithme-api Update IntelliJ settings
nine-old-androids Adjust IntelliJ IDEA files
play-services-appinvite releng: update unbundled play-services to 8.4.0
play-services-base releng: update unbundled play-services to 8.4.0
play-services-basement releng: update unbundled play-services to 8.4.0
play-services-location releng: update unbundled play-services to 8.4.0
showcaseview Update IntelliJ settings
templates Move main/template/private.properties to template/private.properties
tests Adapt testSearchByOwner to reality
undobar Adjust IntelliJ IDEA files
.gitignore automatically login when installing the debug version
LICENSE Fixes #2946, Replace license file
NOTICE Fixes #2946, Replace license file
README.md README: Update prerequisites.
build.gradle update to play services 8.4 again
cgeo.iml Adjust IntelliJ IDEA files
gradle.properties releng: build in parallel
gradlew Increase VM heap in gradle wrapper
gradlew.bat releng: update wrapper to 2.7
settings.gradle releng: build addons with gradle

README.md

c:geo is an open source, full-featured, always ready-to-go client for geocaching.com (unofficial) and offers basic support for other geocaching platforms. It does not require a web browser or exports - just download and start right away.

You want to contribute?

Perfect! Please tell us in the issue tracker before hacking on your great new feature. It would be bad if you have implemented something great, but we can't include it because it doesn't fit the remaining architecture and code. You might also want to chat with the developers on channel #cgeo on the freenode IRC network.

Project status

Build Status
Issue Stats
Issue Stats

Get the source

Fork the project source code, make changes to your clone and create a pull request afterwards.

Branches

  • master is for development of new features. Nightly builds are created from this branch.
  • release is for all bug fixes of already existing features. So if a bug is reported in released version, it should be fixed on this branch (and merged to master afterwards).

A more complex bugfix can be first tested against the master branch and integrated in the nightly builds, while kept compatible with the release branch for a later integration. Such a procedure is described in the wiki.

Setting up an IDE

Eclipse

Please be warned, we might remove the support for development in Eclipse, once we switch to a gradle based build.

Android Studio (or IntelliJ IDEA)

  • Install Android Studio from https://developer.android.com/sdk/index.html
  • On first start, choose to clone a project from version control, and choose github afterwards. Supply your credentials.
  • Android Studio should detect that gradle is used for building cgeo. If it complains that this is not a gradle project, then close the project. Choose "Import project" and select the build.gradle or settings.gradle in the root directory of the git repository.

Build

Prerequisites

  • Android SDK (latest version) including Google APIs V19, Google APIs V22, Google repository and Android support repository
  • If you use Microsoft Windows, Google USB Driver to install the application on the smartphone
  • You need to provide several API keys for compiling the app. See next section for details.

API keys

Copy main/templates/keys.xml to main/res/values/. Then edit main/res/values/keys.xml and insert several keys (see comments in the file). Most important is the Google Maps API v1 key. You can leave it empty, but then Google Maps doesn't work. Google doesn't hand out new keys for Google Maps v1, you have to use an existing one.

Request your personal API key for the various OpenCaching sites we support. If you leave these blank, then those networks will remain disabled.

Building with gradle

Run gradlew from the root directory of the git repository. That will install the necessary build framework and display how to build cgeo.

Building with Ant (deprecated)

  1. copy ./templates/private.properties to ./
  2. edit private.properties (see comments in the file)
  3. copy ./main/templates/local.properties to ./main/
  4. copy ./main/templates/local.properties to ./tests/
  5. edit local.properties (see comments in the file)
  6. copy local.properties to all other projects (currently android-support-v7-appcompat, google-play-services_lib, mapswithme-api, showcaseview)
  7. copy local.properties to cgeo-calendar and cgeo-contacts if you plan to hack on the plugins

Run one of the following commands in ./main

ant help
ant clean
ant debug
ant release

or use the Ant view of Eclipse

Debugging

In Eclipse, create a Debug Configuration for an Android Application using the menu Run | Debug Configurations

Testing

The Test classes can be found in the project test. Test classes should be located in the same package as the class under test. Every class can be "Run As" (or "Debug As") an Android JUnit Test from Eclipse. To run all tests use the same "Run As" menu item from the context menu of the test project.

For tests to run successfully you need to configure c:geo on the emulator that runs the test with a valid geocaching.com account. In order for all tests to be successfull the account needs to be premium.

License

c:geo is distributed under Apache License, Version 2.0.

Contact

Something went wrong with that request. Please try again.