Add coin flip/random number/die skill

README.md

@@ -41,6 +41,7 @@ Currently Dicio answers questions about:
 - **media**: play, pause, previous, next song
 - **translation**: translate from/to any language with **Lingva** - _How do I say Football in German?_
 - **wake word control**: turn on/off the wakeword - _Stop listening_
+- **random**: Ask for a random number, flip a coin, or roll dice - _Pick a number between 1 and 100_
 
 ## Speech to text
 

app/src/main/kotlin/org/stypox/dicio/eval/SkillHandler.kt

@@ -25,6 +25,7 @@ import org.stypox.dicio.skills.lyrics.LyricsInfo
 import org.stypox.dicio.skills.media.MediaInfo
 import org.stypox.dicio.skills.navigation.NavigationInfo
 import org.stypox.dicio.skills.open.OpenInfo
+import org.stypox.dicio.skills.random.RandomInfo
 import org.stypox.dicio.skills.search.SearchInfo
 import org.stypox.dicio.skills.telephone.TelephoneInfo
 import org.stypox.dicio.skills.timer.TimerInfo
@@ -53,6 +54,7 @@ class SkillHandler @Inject constructor(
         CurrentTimeInfo,
         MediaInfo,
         JokeInfo,
+        RandomInfo,
         ListeningInfo(dataStore),
         TranslationInfo,
     )

app/src/main/kotlin/org/stypox/dicio/skills/random/RandomInfo.kt

@@ -0,0 +1,32 @@
+package org.stypox.dicio.skills.random
+
+import android.content.Context
+import androidx.compose.material.icons.Icons
+import androidx.compose.material.icons.filled.Casino
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.graphics.vector.rememberVectorPainter
+import org.dicio.skill.context.SkillContext
+import org.dicio.skill.skill.Skill
+import org.dicio.skill.skill.SkillInfo
+import org.stypox.dicio.R
+import org.stypox.dicio.sentences.Sentences
+
+object RandomInfo : SkillInfo("random") {
+    override fun name(context: Context) =
+        context.getString(R.string.skill_name_random)
+
+    override fun sentenceExample(context: Context) =
+        context.getString(R.string.skill_sentence_example_random)
+
+    @Composable
+    override fun icon() =
+        rememberVectorPainter(Icons.Default.Casino)
+
+    override fun isAvailable(ctx: SkillContext): Boolean {
+        return Sentences.Random[ctx.sentencesLanguage] != null
+    }
+
+    override fun build(ctx: SkillContext): Skill<*> {
+        return RandomSkill(RandomInfo, Sentences.Random[ctx.sentencesLanguage]!!)
+    }
+}

app/src/main/kotlin/org/stypox/dicio/skills/random/RandomOutput.kt

@@ -0,0 +1,79 @@
+package org.stypox.dicio.skills.random
+
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Column
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.unit.dp
+import org.dicio.skill.context.SkillContext
+import org.dicio.skill.skill.SkillOutput
+import org.stypox.dicio.R
+import org.stypox.dicio.io.graphical.Body
+import org.stypox.dicio.io.graphical.Headline
+import org.stypox.dicio.io.graphical.Subtitle
+import org.stypox.dicio.util.getString
+
+sealed interface RandomOutput : SkillOutput {
+
+    data class CoinFlip(private val result: String) : RandomOutput {
+        override fun getSpeechOutput(ctx: SkillContext): String =
+            ctx.getString(R.string.skill_random_coin_flip, result)
+
+        @Composable
+        override fun GraphicalOutput(ctx: SkillContext) {
+            Headline(text = result.uppercase())
+        }
+    }
+
+    data class DiceRoll(private val results: List<Int>, private val sides: Int) : RandomOutput {
+        override fun getSpeechOutput(ctx: SkillContext): String {
+            val total = results.sum()
+            return if (results.size == 1) {
+                ctx.getString(R.string.skill_random_dice_roll, results[0], sides)
+            } else {
+                ctx.getString(R.string.skill_random_dice_roll_multiple, total, results.size, sides)
+            }
+        }
+
+        @Composable
+        override fun GraphicalOutput(ctx: SkillContext) {
+            Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
+                Headline(
+                    text = if (results.size == 1) results[0].toString() else results.sum().toString()
+                )
+                if (results.size == 1) {
+                    Subtitle(text = ctx.getString(R.string.skill_random_dice_sides, sides))
+                } else {
+                    Subtitle(text = ctx.getString(R.string.skill_random_dice_sides, sides))
+                    Body(text = results.joinToString(" + ") + " = ${results.sum()}")
+                }
+            }
+        }
+    }
+
+    data class RandomNumber(
+        private val result: Int,
+        private val min: Int,
+        private val max: Int
+    ) : RandomOutput {
+        override fun getSpeechOutput(ctx: SkillContext): String =
+            ctx.getString(R.string.skill_random_random_number, result, min, max)
+
+        @Composable
+        override fun GraphicalOutput(ctx: SkillContext) {
+            Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
+                Headline(text = result.toString())
+                Subtitle(text = ctx.getString(R.string.skill_random_range, min, max))
+            }
+        }
+    }
+
+    data object InvalidRange : RandomOutput {
+        override fun getSpeechOutput(ctx: SkillContext): String =
+            ctx.getString(R.string.skill_random_invalid_range)
+
+        @Composable
+        override fun GraphicalOutput(ctx: SkillContext) {
+            Headline(text = ctx.getString(R.string.skill_random_invalid_range))
+        }
+    }
+}

app/src/main/kotlin/org/stypox/dicio/skills/random/RandomSkill.kt

@@ -0,0 +1,65 @@
+package org.stypox.dicio.skills.random
+
+import org.dicio.numbers.unit.Number
+import org.dicio.skill.context.SkillContext
+import org.dicio.skill.skill.SkillInfo
+import org.dicio.skill.skill.SkillOutput
+import org.dicio.skill.standard.StandardRecognizerData
+import org.dicio.skill.standard.StandardRecognizerSkill
+import org.stypox.dicio.R
+import org.stypox.dicio.sentences.Sentences.Random
+import org.stypox.dicio.util.getString
+import kotlin.random.Random as KotlinRandom
+
+class RandomSkill(
+    correspondingSkillInfo: SkillInfo,
+    data: StandardRecognizerData<Random>
+) : StandardRecognizerSkill<Random>(correspondingSkillInfo, data) {
+
+    private fun extractNumber(ctx: SkillContext, text: String?): Int? {
+        return text?.let {
+            ctx.parserFormatter?.extractNumber(it)?.mixedWithText
+                ?.filterIsInstance<Number>()
+                ?.firstOrNull()
+                ?.integerValue()
+                ?.toInt()
+        }
+    }
+
+    override suspend fun generateOutput(ctx: SkillContext, inputData: Random): SkillOutput {
+        return when (inputData) {
+            is Random.CoinFlip -> {
+                val result = if (KotlinRandom.nextBoolean()) {
+                    ctx.getString(R.string.skill_random_heads)
+                } else {
+                    ctx.getString(R.string.skill_random_tails)
+                }
+                RandomOutput.CoinFlip(result)
+            }
+
+            is Random.DiceRoll -> {
+                val sides = extractNumber(ctx, inputData.sides) ?: 6
+                val amount = extractNumber(ctx, inputData.amount) ?: 1
+
+                if (sides <= 0 || amount <= 0 || amount > 100) {
+                    return RandomOutput.InvalidRange
+                }
+
+                val results = List(amount) { KotlinRandom.nextInt(1, sides + 1) }
+                RandomOutput.DiceRoll(results, sides)
+            }
+
+            is Random.RandomNumber -> {
+                val min = extractNumber(ctx, inputData.min) ?: 1
+                val max = extractNumber(ctx, inputData.max) ?: 100
+
+                if (min > max) {
+                    return RandomOutput.InvalidRange
+                }
+
+                val result = KotlinRandom.nextInt(min, max + 1)
+                RandomOutput.RandomNumber(result, min, max)
+            }
+        }
+    }
+}

app/src/main/res/values/strings.xml

@@ -152,6 +152,8 @@
     <string name="skill_sentence_example_timer">Set a timer for five minutes</string>
     <string name="skill_name_current_time">Current time</string>
     <string name="skill_sentence_example_current_time">What time is it?</string>
+    <string name="skill_name_random">Random</string>
+    <string name="skill_sentence_example_random">Roll a 20-sided die</string>
     <string name="skill_fallback_name_text">Text message</string>
     <string name="skill_search_here_is_what_i_found">Here is what I found</string>
     <string name="skill_search_no_results">The search returned no results, try telling me again what you want to search for</string>
@@ -246,4 +248,13 @@
     <string name="failed_to_copy">Failed to copy to clipboard</string>
     <string name="skill_translation_auto">Auto</string>
     <string name="skill_search_duckduckgo_recaptcha">DuckDuckGo did not provide results, asking for a Captcha to be solved</string>
+    <string name="skill_random_coin_flip">The coin landed on %1$s</string>
+    <string name="skill_random_dice_roll">You rolled a %1$d on a %2$d-sided die</string>
+    <string name="skill_random_dice_roll_multiple">You rolled %1$d total on %2$d %3$d-sided dice</string>
+    <string name="skill_random_dice_sides">%1$d-sided die</string>
+    <string name="skill_random_random_number">Your random number is %1$d</string>
+    <string name="skill_random_range">Range: %1$d to %2$d</string>
+    <string name="skill_random_invalid_range">Invalid range, please specify valid numbers</string>
+    <string name="skill_random_heads">heads</string>
+    <string name="skill_random_tails">tails</string>
 </resources>

app/src/main/sentences/en/random.yml

@@ -0,0 +1,25 @@
+coin_flip:
+  - flip (a|the) coin<s?>
+  - heads or tails
+
+dice_roll:
+  # Simple dice roll (defaults to 6 sides)
+  - roll (a|the|some)? (die|dice)
+  - throw (a|the|some)? (die|dice)
+
+  # Dice with specific sides
+  - (roll|throw) (a|an)? .sides. sided? (die|dice)
+  - (roll|throw) a? d .sides.
+
+  # RPG notation: "roll 1 d 20", "roll 4 d 10", etc
+  - (roll|throw) .amount. d .sides.
+
+random_number:
+  # Generic random number (no range specified)
+  - (give me|pick|choose|select|generate|get) (a|any)? random? number
+  - random number
+
+  # Random number with specific range
+  - pick (a|any)? number (from|between)? .min. (to|and|through) .max.
+  - random number (from|between)? .min. (to|and|through) .max.
+  - (choose|select|give me|generate|get) (a|any)? random? number (from|between)? .min. (to|and|through) .max.

app/src/main/sentences/en/rng.yml

@@ -0,0 +1,25 @@
+coin_flip:
+  - flip (a|the) coin<s?>
+  - heads or tails
+
+dice_roll:
+  # Simple dice roll (defaults to 6 sides)
+  - roll (a|the|some)? (die|dice)
+  - throw (a|the|some)? (die|dice)
+
+  # Dice with specific sides
+  - (roll|throw) (a|an)? .sides. sided? (die|dice)
+  - (roll|throw) a? d .sides.
+
+  # RPG notation: "roll 1 d 20", "roll 4 d 10", etc
+  - (roll|throw) .amount. d .sides.
+
+random_number:
+  # Generic random number (no range specified)
+  - (give me|pick|choose|select|generate|get) (a|any)? random? number
+  - random number
+
+  # Random number with specific range
+  - pick (a|any)? number (from|between)? .min. (to|and|through) .max.
+  - random number (from|between)? .min. (to|and|through) .max.
+  - (choose|select|give me|generate|get) (a|any)? random? number (from|between)? .min. (to|and|through) .max.

app/src/main/sentences/skill_definitions.yml

@@ -123,3 +123,20 @@ skills:
             type: string
           - id: target
             type: string
+
+  - id: random
+    specificity: high
+    sentences:
+      - id: coin_flip
+      - id: dice_roll
+        captures:
+          - id: sides
+            type: string
+          - id: amount
+            type: string
+      - id: random_number
+        captures:
+          - id: min
+            type: string
+          - id: max
+            type: string

fastlane/metadata/android/en-US/full_description.txt

@@ -14,6 +14,7 @@ Dicio answers questions about:
 <li><b>jokes</b>: tells you a joke - <i>Tell me a joke</i></li>
 <li><b>media</b>: play, pause, previous, next song - <i>Next Song</i></li>
 <li><b>translation</b>: translate from/to any language with <b>Lingva</b> - <i>How do I say Football in German?</i></li>
+<li><b>random</b>: Ask for a random number, flip a coin, or roll dice - <i>Pick a number between 1 and 100</i></li>
 </ul>
 
 Dicio can receive input through a text box or through <a href="https://github.com/alphacep/vosk-api/">Vosk</a> <i>speech to text</i>, and can talk using toasts or the Android <i>speech synthesis</i> engine. <b>Interactive graphical output</b> is provided by skills when they answer a question.