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.
Get the source
- 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
- Install an Eclipse distribution for your OS from http://eclipse.org/downloads/ (you may choose the Java developers distribution).
- Start Eclipse, choose any directory as workspace. Close the welcome screen, if it appears.
- After the workbench has started, select File | Import | Install | Install Software Items From File and select a locally downloaded copy of https://github.com/cgeo/cgeo/tree/master/main/project/eclipse%20installation/cgeo%20eclipse%20components.p2f. This way you can easily install all necessary plugins.
- After forking the project you should import the Eclipse projects in your workspace with File | Import | Projects from Git.
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
settings.gradlein the root directory of the git repository.
- 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.
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.
- opencaching.de OKAPI signup
- opencaching.pl OKAPI signup
- opencaching.ro OKAPI signup
- opencaching.nl OKAPI signup
- opencaching.us OKAPI signup
- opencaching.org.uk OKAPI signup
Building with gradle
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)
private.properties(see comments in the file)
local.properties(see comments in the file)
local.propertiesto all other projects (currently android-support-v7-appcompat, google-play-services_lib, mapswithme-api, showcaseview)
local.propertiesto cgeo-calendar and cgeo-contacts if you plan to hack on the plugins
Run one of the following commands in
ant help ant clean ant debug ant release
or use the Ant view of Eclipse
In Eclipse, create a Debug Configuration for an Android Application using the menu Run | Debug Configurations
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.
c:geo is distributed under Apache License, Version 2.0.
- Website: http://www.cgeo.org/
- Support: email@example.com
- Twitter: http://twitter.com/android_gc
- Facebook: http://www.facebook.com/android.geocaching
- Google+: https://plus.google.com/105588163414303246956
- Google Play: https://play.google.com/store/apps/details?id=cgeo.geocaching
- Live status: http://status.cgeo.org/
- Developer chat: #cgeo on freenode.net