Updated README.md

Adventure Missions progress

README.md

@@ -1,38 +1,69 @@
 # VBHelper
 
-## Developer Setup
+Application to interact with the Vital series, VB, VH, VBC and VBBE.
 
-1. Clone vb-nfc-reader (https://github.com/cfogrady/lib-vb-nfc)
+## Current state of the project
-2. Run vb-nfc-reader/publishToMavenLocal gradle task in the lib-vb-nfc project.
+
-3. Clone vb-dim-reader (https://github.com/cfogrady/vb-dim-reader)
+Right now the project is still under development, and until further notice, any database updates will result in having to erase application data.
-4. Run publishToMavenLocal gradle task in the vb-dim-reader project.
+
-5. Create res/values/keys.xml within the app module.
+This document will be updated once the application does not need any more database resets.
-6. Populate with:
+
-```
+## Features
-<?xml version="1.0" encoding="utf-8"?>
+
-<resources>
+As of now, the project allows you to read characters, view characters stats, and send them back to your watch. 
-    <string name="password1">beHmacKey1</string>
+
-    <string name="password2">beHmacKey2</string>
+You can also apply items to the characters read, such as special missions, or change timers, and store characters in the storage section.
-    <string name="decryptionKey">aesKey</string>
+
-    <integer-array name="substitutionArray">
+You also earn new items every time an item such as a special mission (VB only) or a character completes an in-app adventure mission.
-        <item>0</item>
+
-        <item>1</item>
+App also comes with a dex that will update every time a new character is added, and allows you to see evolution requirements and current adventure stage in the watch.
-        <item>2</item>
+
-        <item>3</item>
+## How to set up
-        <item>4</item>
+
-        <item>5</item>
+1. Download the latest version for VB Arena APK from a trustworthy source. If your download is a standalone APK, continue to step 2. Otherwise, if your download is an XAPK, do the following:
-        <item>6</item>
+
-        <item>7</item>
+    1. Using your phone file manager, rename the XAPK file to ZIP, and extract its contents. You can also do this with any other device, such as Windows, macOS and Linux. 
-        <item>8</item>
+
-        <item>9</item>
+    2. Once the files are extracted, look for an APK called `com.bandai.vitalbraceletarena.apk`. Copy it somewhere else, you will need it.
-        <item>10</item>
+
-        <item>11</item>
+2. Install an APK release for VB Arena. You will find the releases [here](http://github.com/nacabaro/vbhelper/releases). Download the latest release and install its APK.
-        <item>12</item>
+
-        <item>13</item>
+    Note, in the current stage of the project, you will have to delete the old application from your device. If the app keeps crashing after installing, clear application data and storage.
-        <item>14</item>
+
-        <item>15</item>
+3. Import secrets in the app. These secrets will allow the app to talk to the watch. On the main screen, click on the gear icon, then `Import secrets`.
-    </integer-array>
+    
-</resources>
+    You will be prompted to choose a file. Choose the APK file that was previously obtained.
-```
+
-7. Replace the values in the keys.xml file with those extracted from the original app.
+4. Import cards. Due to copyright laws, we cannot offer the characters and sprites themselves in the application. In order to import the cards do the following.
-8. Run
+
+    1. Using your own DiM/BEm cards, dump the cards to your device. You can get an in-depth tutorial in [here](http://mrblinky.net/digimon/vb/dimcardtool/dimcardtool.html). You can download the dump tool from [here](http://mrblinky.net/digimon/vb/dimcardtool/)
+
+    2. Once installed the tool and drivers, open the tool, connect your DiM/BEm reader hardware to yout computer and click on Read card.
+
+    3. Transfer the resulting file to your mobile device. You can put them anywhere, as long as they are accessible. My recommendation is to put them under a folder called `Cards` in your `Internal storage` or `SD Card`
+
+    4. In the app, click on import card. Next choose the BIN file corresponding to the card you want to import.
+
+    **Note: if you do not import the card, whenever you attempt to read a character from th watch, the character you read will get deleted.** 
+
+5. App will now be ready to be used.
+
+## Planned features
+
+- Online battles, undegoing development by `lightheel`.
+
+- VitalWear compatibility, undergoing development by `cfogrady`.
+
+- Support for multiple languages, not yet started.
+
+- Database backup/restore.
+
+## Credits
+
+- `cyanic` for helping us understand more about the VB connection protocol.
+
+- `cfogrady` for making both [`VB-DIM-Reader`](https://github.com/cfogrady/VB-DIM-Reader) and [`lib-vb-nfc`](https://github.com/cfogrady/lib-vb-nfc)
+
+- `lightheel` for working on the online component in the application, both server and battle client.
+
+- `shvstrz` for the app icon.

app/src/main/java/com/github/nacabaro/vbhelper/daos/CardProgressDao.kt

@@ -1,17 +1,28 @@
 package com.github.nacabaro.vbhelper.daos
 
 import androidx.room.Dao
+import androidx.room.Insert
 import androidx.room.Query
-import androidx.room.Upsert
 import com.github.nacabaro.vbhelper.domain.card.CardProgress
+import com.github.nacabaro.vbhelper.dtos.CharacterDtos
 
 @Dao
 interface CardProgressDao {
-    @Upsert
+    @Query("""
-    fun updateDimProgress(vararg cardProgresses: CardProgress)
+        UPDATE CardProgress 
+        SET 
+            currentStage = :currentStage, 
+            unlocked = :unlocked
+        WHERE cardId = :cardId AND
+            currentStage < :currentStage
+    """)
+    fun updateCardProgress(currentStage: Int, cardId: Long, unlocked: Boolean)
 
     @Query(
         "SELECT currentStage FROM CardProgress WHERE cardId = :cardId"
     )
     fun getCardProgress(cardId: Long): Int
+
+    @Insert
+    fun insertCardProgress(cardProgress: CardProgress)
 }

app/src/main/java/com/github/nacabaro/vbhelper/daos/CharacterDao.kt

@@ -24,10 +24,12 @@ interface CharacterDao {
             d.cardId as cardId,
             c.charaIndex as charId,
             c.stage as stage,
-            c.attribute as attribute
+            c.attribute as attribute,
+            cp.currentStage as currentStage
         FROM CardCharacter c
         JOIN UserCharacter uc ON c.id = uc.charId
         JOIN Card d ON c.cardId = d.id
+        JOIN CardProgress cp ON d.id = cp.cardId
         WHERE c.id = :charId
     """
     )

app/src/main/java/com/github/nacabaro/vbhelper/dtos/CharacterDtos.kt

@@ -38,7 +38,8 @@ object CharacterDtos {
         val cardId: Long,
         val charId: Int,
         val stage: Int,
-        val attribute: NfcCharacter.Attribute
+        val attribute: NfcCharacter.Attribute,
+        val currentStage: Int
     )
 
     data class TransformationHistory(

app/src/main/java/com/github/nacabaro/vbhelper/screens/cardScreen/CardAdventureScreen.kt

@@ -7,8 +7,11 @@ import androidx.compose.foundation.verticalScroll
 import androidx.compose.material3.Scaffold
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableIntStateOf
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
+import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
 import androidx.navigation.NavController
 import com.github.nacabaro.vbhelper.components.TopBanner
@@ -23,7 +26,7 @@ fun CardAdventureScreen(
     cardId: Long
 ) {
     val cardAdventureMissions = remember { mutableStateOf(emptyList<CardDtos.CardAdventureWithSprites>()) }
-    var currentCardAdventure = remember { 0 }
+    var currentCardAdventure by remember { mutableIntStateOf(0) }
 
     LaunchedEffect(cardId) {
         withContext(Dispatchers.IO) {
@@ -55,7 +58,7 @@ fun CardAdventureScreen(
             cardAdventureMissions.value.mapIndexed { index, it ->
                 CardAdventureEntry(
                     cardAdventureEntry = it,
-                    obscure = index > currentCardAdventure
+                    obscure = index > currentCardAdventure - 1
                 )
             }
         }

app/src/main/java/com/github/nacabaro/vbhelper/screens/scanScreen/converters/FromNfcConverter.kt

@@ -152,15 +152,13 @@ class FromNfcConverter (
         nfcCharacter: NfcCharacter,
         cardData: Card
     ) {
-        val currentCardProgress = CardProgress(
-            cardId = cardData.id,
-            currentStage = nfcCharacter.nextAdventureMissionStage.toInt(),
-            unlocked = nfcCharacter.nextAdventureMissionStage.toInt() > cardData.stageCount
-        )
-
         database
             .cardProgressDao()
-            .updateDimProgress(currentCardProgress)
+            .updateCardProgress(
+                currentStage = nfcCharacter.nextAdventureMissionStage.toInt(),
+                cardId = cardData.id,
+                unlocked = nfcCharacter.nextAdventureMissionStage.toInt() > cardData.stageCount,
+            )
     }
 
 

app/src/main/java/com/github/nacabaro/vbhelper/screens/scanScreen/converters/ToNfcConverter.kt

@@ -38,14 +38,10 @@ class ToNfcConverter(
             .characterDao()
             .getCharacterInfo(userCharacter.charId)
 
-        val currentCardStage = database
-            .cardProgressDao()
-            .getCardProgress(characterInfo.cardId)
-
         return if (userCharacter.characterType == DeviceType.BEDevice)
-            nfcToBENfc(characterId, characterInfo, currentCardStage, userCharacter)
+            nfcToBENfc(characterId, characterInfo, userCharacter)
         else
-            nfcToVBNfc(characterId, characterInfo, currentCardStage, userCharacter)
+            nfcToVBNfc(characterId, characterInfo, userCharacter)
     }
 
 
@@ -53,7 +49,6 @@ class ToNfcConverter(
     private suspend fun nfcToVBNfc(
         characterId: Long,
         characterInfo: CharacterDtos.CardCharacterInfo,
-        currentCardStage: Int,
         userCharacter: UserCharacter
     ): VBNfcCharacter {
         val vbData = database
@@ -70,7 +65,7 @@ class ToNfcConverter(
             stage = characterInfo.stage.toByte(),
             attribute = characterInfo.attribute,
             ageInDays = userCharacter.ageInDays.toByte(),
-            nextAdventureMissionStage = currentCardStage.toByte(),
+            nextAdventureMissionStage = characterInfo.currentStage.toByte(),
             mood = userCharacter.mood.toByte(),
             vitalPoints = userCharacter.vitalPoints.toUShort(),
             transformationCountdownInMinutes = userCharacter.transformationCountdown.toUShort(),
@@ -173,7 +168,6 @@ class ToNfcConverter(
     private suspend fun nfcToBENfc(
         characterId: Long,
         characterInfo: CharacterDtos.CardCharacterInfo,
-        currentCardStage: Int,
         userCharacter: UserCharacter
     ): BENfcCharacter {
         val beData = database
@@ -188,7 +182,7 @@ class ToNfcConverter(
             stage = characterInfo.stage.toByte(),
             attribute = characterInfo.attribute,
             ageInDays = userCharacter.ageInDays.toByte(),
-            nextAdventureMissionStage = currentCardStage.toByte(),
+            nextAdventureMissionStage = characterInfo.currentStage.toByte(),
             mood = userCharacter.mood.toByte(),
             vitalPoints = userCharacter.vitalPoints.toUShort(),
             itemEffectMentalStateValue = beData.itemEffectMentalStateValue.toByte(),

app/src/main/java/com/github/nacabaro/vbhelper/screens/settingsScreen/SettingsScreenControllerImpl.kt

@@ -336,15 +336,15 @@ class SettingsScreenControllerImpl(
     private fun updateCardProgress(
         cardId: Long,
     ) {
-        val cardProgress = CardProgress(
-            cardId = cardId,
-            currentStage = 0,
-            unlocked = false
-        )
-
         database
             .cardProgressDao()
-            .updateDimProgress(cardProgress)
+            .insertCardProgress(
+                CardProgress(
+                    cardId = cardId,
+                    currentStage = 1,
+                    unlocked = false
+                )
+            )
     }
 
     private fun importCard(uri: Uri) {