"The Länd of Adventure" is a native Android application developed as an application/software project for the summer semester 2023 at the Hochschule der Medien.
It offers an exciting GPS-based exploration game in the city of Stuttgart, motivating users to explore the city on foot while enjoying an entertaining gaming experience. Designed as a single-player experience, "The Länd of Adventure" immerses players in a medieval-themed dialog and interface, encouraging them to embark on an adventurous journey through Stuttgart's urban landscape at their own pace.
Our project is designed to support Android devices running version 8 (Android Oreo) and above.
- Kotlin: The primary programming language, known for its conciseness and interoperability with Java
- Mapbox: Integration of Mapbox provides advanced mapping and location services
- Room: Room library simplifies working with SQLite databases, ensuring efficient data management
- You will need to have Android Studio installed to build this project.
- Make sure you have the Android Studio default JDK installed and selected (Settings> Build, Execution, Deployment> Build tools> Gradle)
The steps may vary depending on your operating system.
Clone the repository to your local machine using Git or download the source code as a ZIP file and extract it. Open the project in Android Studio.
A MapBox account is required to use the application. After you have created an account, you will need to create a Mapbox API token on your profile and copy it into the mapbox.env file. The Token has to have the Downloads:Read Flag.
To run the project, first install an emulator. Once the emulator is installed, run the Länd of Adventure app to launch the application on the emulator and start the adventure.
For instructions on navigating the emulator, click here: Emulator Navigation
This program is fully documented using Dokka. To generate the javadoc files, you can navigate to the project folder and run the following command
On Windows:
gradlew dokkaHtml
On Mac and Linux:
./gradlew dokkaHtml
The HTML file will be in the build directory and then in the dokka directory.
For this command to work, you must have gradle installed.
| Dependency | Version | License |
|---|---|---|
| Androidx Legacy: Legacy Support | v4:1.0.0 | Apache-2.0 License |
| Androidx Lifecycle: LiveData | 2.6.1 | Apache-2.0 License |
| Androidx Preference | 1.2.0 | Apache-2.0 License |
| Androidx ConstraintLayout | 2.1.4 | Apache-2.0 License |
| Android Google GMS Play-Services-Location | 21.0.1 | Android Software Development Kit License |
| Dependency | Version | License |
|---|---|---|
| Mapbox Maps SDK For Android | 10.12.1 | Apache-2.0 License |
| Dependency | Version | License |
|---|---|---|
| Androidx Navigation Fragment | 2.5.3 | Apache-2.0 License |
| Androidx Navigation UI Kotlin Extensions | 2.5.3 | Apache-2.0 License |
| Androidx Navigation Fragment | 2.4.1 | Apache-2.0 License |
| Dependency | Version | License |
|---|---|---|
| Room Runtime | 2.5.1 | Apache-2.0 License |
| Room Compiler | 2.5.1 | Apache-2.0 License |
| Room Kotlin Extensions | 2.5.1 | Apache-2.0 License |
| Dependency | Version | License |
|---|---|---|
| Android Activity Kotlin Extensions | 1.7.1 | Apache-2.0 License |
| Android Fragment Kotlin Extensions | 1.5.7 | Apache-2.0 License |
| Android Lifecycle ViewModel Kotlin Extensions | 2.6.1 | Apache-2.0 License |
| Core Kotlin Extensions | 1.10.1 | Apache-2.0 License |
| Glide | 4.14.2 | License |
| Glide Compiler | 4.14.2 | License |
| Material Components For Android | 1.9.0 | Apache-2.0 License |
| Dependency | Version | License |
|---|---|---|
| JUnit | 4.13.2 | Apache-2.0 License |
| JUnit Jupiter | 5.8.1 | EPL 2.0 |
| Androix Test JUnit Extension | 1.1.5 | Apache-2.0 License |
| Androidx Espresso | 3.5.1 | Apache-2.0 License |
| Dependency | Version | License |
|---|---|---|
| detekt Plugins | 1.22.0 | Apache-2.0 License |
| Android Application Gradle Plugin | Apache-2.0 License | |
| Google Kotlin Symbol Processing | 1.8.0-1.0.8 | Apache-2.0 License |
| Dokka | 1.8.20 | Apache-2.0 License |
The-Länd-of-Adventure (c) 2023 Johannes Hausch, Sebastian Maier, Konstantinos Gimoussiakakis, Aylin Alagöz, Dorina Sobiecki
SPDX-License-Identifier: GPL-3.0