Compare commits
5 Commits
0.1.2
...
83bd05ff28
| Author | SHA1 | Date | |
|---|---|---|---|
| 83bd05ff28 | |||
| e733b03610 | |||
| e678e8356c | |||
| 13983ae636 | |||
| 68038e2a77 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -230,3 +230,5 @@ cython_debug/
|
||||
/dialogue.tab
|
||||
/dialogue.txt
|
||||
/strings.json
|
||||
|
||||
*.keystore
|
||||
|
||||
164
AGENTS.md
Normal file
164
AGENTS.md
Normal file
@@ -0,0 +1,164 @@
|
||||
# AGENTS.md
|
||||
|
||||
Agent guidance for this repository (`Soul Droid Chat`).
|
||||
|
||||
## Quick Start for New Agents
|
||||
|
||||
1. Read `game/script.rpy`, `game/screens.rpy`, and `game/llm_ren.py` to understand flow and LLM integration.
|
||||
2. Run `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" lint` before making changes.
|
||||
3. Make small, focused edits that preserve Ren'Py ids and the `EMOTION:<value>` response contract.
|
||||
4. Validate with `compile` and `test` (`test <testcase_or_suite_name>` for a single case while iterating).
|
||||
5. Avoid committing generated artifacts/logs (`*.rpyc`, `game/cache/`, `log.txt`, `errors.txt`, `traceback.txt`) or secrets.
|
||||
6. In your handoff, include what changed, why, and exact validation commands run.
|
||||
|
||||
## Project Snapshot
|
||||
|
||||
- Engine: Ren'Py 8.5.x project with script files in `game/*.rpy`.
|
||||
- Python support code is embedded in Ren'Py files and `game/*_ren.py`.
|
||||
- Runtime dependency: LM Studio server (default `http://localhost:1234`).
|
||||
- No dedicated `tests/` directory was found; use Ren'Py `lint` and `test`.
|
||||
|
||||
## Repository Layout
|
||||
|
||||
- `game/script.rpy`: main dialogue/game flow loop.
|
||||
- `game/screens.rpy`: UI screens, preferences, and menus.
|
||||
- `game/options.rpy`: Ren'Py/build/runtime config and defaults.
|
||||
- `game/llm_ren.py`: LLM call logic, parsing, and sanitizing.
|
||||
- `game/constants_ren.py`: emotion synonym table.
|
||||
- `project.json`, `android.json`: distribution/build settings.
|
||||
|
||||
## Tooling and Environment
|
||||
|
||||
- Expected Ren'Py launcher script in PATH: `renpy.sh`.
|
||||
- CLI usage pattern:
|
||||
- `"renpy.sh" "<repo-path>" <command> [args]`
|
||||
- Python in environment is available (`python3`), but gameplay validation should use Ren'Py commands.
|
||||
|
||||
## Build, Lint, and Test Commands
|
||||
|
||||
Run all commands from repository root:
|
||||
`/home/$USER/Documentos/Renpy Projects/Soul Droid Chat`
|
||||
|
||||
### Quick checks (most common)
|
||||
|
||||
- Lint project:
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" lint`
|
||||
- Run game locally:
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" run`
|
||||
- Compile scripts/python cache:
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" compile`
|
||||
|
||||
### Test execution (Ren'Py test runner)
|
||||
|
||||
- Run default/global test suite:
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" test`
|
||||
- Run a single test suite or testcase (important):
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" test <testcase_or_suite_name>`
|
||||
- Show detailed test report:
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" test --report-detailed`
|
||||
- Run all testcases even if disabled:
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" test --enable-all`
|
||||
|
||||
### Distribution/build packaging
|
||||
|
||||
- Create distributions (launcher command):
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" distribute`
|
||||
- Android build exists as a Ren'Py command (if SDK/keystore configured):
|
||||
- `"renpy.sh" "/home/$USER/Documentos/Renpy Projects/Soul Droid Chat" android_build`
|
||||
|
||||
## Suggested Validation Sequence for Agents
|
||||
|
||||
1. `lint`
|
||||
2. `compile`
|
||||
3. `test` (or `test <single_case>` when iterating)
|
||||
4. `run` for a manual smoke check on the edited flow/screen
|
||||
|
||||
If a command fails, include the failing command and key error excerpt in your report.
|
||||
|
||||
## Code Style Guidelines
|
||||
|
||||
### General principles
|
||||
|
||||
- Match existing Ren'Py and Python style in nearby files.
|
||||
- Prefer small, focused changes; avoid unrelated refactors.
|
||||
- Keep user-facing narrative tone and Anita persona constraints intact.
|
||||
- Preserve ASCII-oriented output behavior where current code expects it.
|
||||
|
||||
### Ren'Py script/style conventions (`.rpy`)
|
||||
|
||||
- Use 4-space indentation; never tabs.
|
||||
- Keep labels/screen names `snake_case` (`label start`, `screen quick_menu`).
|
||||
- Keep style declarations grouped and readable (existing file order is a good template).
|
||||
- For dialogue flow, keep Python blocks short; move reusable logic to `*_ren.py`.
|
||||
- Use explicit keyword args when clarity helps (`prompt =`, `fadeout`, `fadein`).
|
||||
- Do not rename core ids required by Ren'Py (`_("window")`, `_("what")`, `_("who")`, `_("input")`).
|
||||
|
||||
### Python conventions (`*_ren.py` and embedded `init python`)
|
||||
|
||||
- Imports:
|
||||
- Standard library first (`re`).
|
||||
- Ren'Py modules (`renpy`, `persistent`).
|
||||
- Local imports last (`from .constants_ren import SYNONYMS`).
|
||||
- Naming:
|
||||
- Functions/variables: `snake_case`.
|
||||
- Constants: `UPPER_SNAKE_CASE` (`EMOTIONS`, `SYSTEM_PROMPT`).
|
||||
- Keep names descriptive (`parse_emotion`, `sanitize_speech`, `fetch_llm`).
|
||||
- Types:
|
||||
- Add type hints on new/edited Python functions when practical.
|
||||
- Keep return types accurate (for list-returning functions, annotate accordingly).
|
||||
- Formatting:
|
||||
- Follow PEP 8 basics for spacing, line breaks, and readability.
|
||||
- Keep multiline literals and dicts formatted consistently with existing file style.
|
||||
|
||||
### Error handling and resilience
|
||||
|
||||
- Wrap external boundary calls (network/LM Studio) with `try/except`.
|
||||
- Return safe fallback values that keep game loop stable.
|
||||
- Error messages should be concise and actionable for debugging.
|
||||
- Avoid swallowing exceptions silently; at minimum return or log context.
|
||||
- Preserve conversation continuity fields when present (`last_response_id`).
|
||||
|
||||
### LLM integration constraints
|
||||
|
||||
- Keep `SYSTEM_PROMPT` format guarantees consistent unless intentionally changing behavior.
|
||||
- Maintain `EMOTION:<value>` parsing contract used by dialogue rendering.
|
||||
- If you add emotions, update both:
|
||||
- `EMOTIONS` in `game/llm_ren.py`
|
||||
- `SYNONYMS` in `game/constants_ren.py`
|
||||
- Keep speech sanitization aligned with UI/rendering constraints.
|
||||
|
||||
### UI/screens changes
|
||||
|
||||
- Reuse existing `gui.*` variables and style helpers where possible.
|
||||
- Keep mobile/small variant handling (`renpy.variant(_("small"))`) intact.
|
||||
- Prefer extending existing screens over introducing parallel duplicate screens.
|
||||
- For settings UI, follow patterns already used in `preferences` screen.
|
||||
|
||||
## Agent Working Rules
|
||||
|
||||
- Before edits:
|
||||
- Read related files fully (at least the touched blocks and nearby context).
|
||||
- Check for existing patterns and follow them.
|
||||
- During edits:
|
||||
- Do not include secrets or API keys in committed files.
|
||||
- Do not commit generated caches/logs (`*.rpyc`, `log.txt`, `errors.txt`, `traceback.txt`).
|
||||
- After edits:
|
||||
- Run relevant validation commands from the section above.
|
||||
- Summarize what changed, why, and what was validated.
|
||||
|
||||
## Git and Change Scope
|
||||
|
||||
- Keep commits scoped to the requested task.
|
||||
- Avoid touching binary assets unless the task explicitly requires it.
|
||||
- If a keystore or credential-like file is changed, call it out explicitly.
|
||||
- Do not rewrite history unless explicitly requested.
|
||||
|
||||
## Cursor/Copilot Rules Status
|
||||
|
||||
- No repository-specific Cursor rules were found:
|
||||
- `.cursor/rules/` not present.
|
||||
- `.cursorrules` not present.
|
||||
- No repository-specific Copilot instruction file found:
|
||||
- `.github/copilot-instructions.md` not present.
|
||||
|
||||
If any of the above files are added later, treat them as higher-priority constraints and update this document.
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
Chat with Anita, your favorite Souldroid! Requires a running instance of LM Studio in server mode to work.
|
||||
|
||||

|
||||
|
||||
## Acknowledgements
|
||||
|
||||
Anita and Souldroids are © [Kieran Harris](https://www.deviantart.com/kieranharris), used with love but without permission 😅
|
||||
|
||||
BIN
android-icon_background.png
Normal file
BIN
android-icon_background.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
BIN
android-icon_foreground.png
Normal file
BIN
android-icon_foreground.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 101 KiB |
BIN
android-presplash.jpg
Normal file
BIN
android-presplash.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 109 KiB |
24
android.json
Normal file
24
android.json
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"expansion": false,
|
||||
"google_play_key": null,
|
||||
"google_play_salt": null,
|
||||
"heap_size": "3",
|
||||
"icon_name": "Souldroid Chat",
|
||||
"include_pil": false,
|
||||
"include_sqlite": false,
|
||||
"layout": null,
|
||||
"name": "Souldroid Chat",
|
||||
"numeric_version": 1,
|
||||
"orientation": "sensorLandscape",
|
||||
"package": "space.hackenslacker.souldroidchat",
|
||||
"permissions": [
|
||||
"VIBRATE",
|
||||
"INTERNET"
|
||||
],
|
||||
"source": false,
|
||||
"store": "none",
|
||||
"update_always": true,
|
||||
"update_icons": true,
|
||||
"update_keystores": true,
|
||||
"version": "1.0"
|
||||
}
|
||||
56
game/constants_ren.py
Normal file
56
game/constants_ren.py
Normal file
@@ -0,0 +1,56 @@
|
||||
"""renpy
|
||||
init python:
|
||||
"""
|
||||
|
||||
SYNONYMS = {
|
||||
'happy': set(["amused", "animated", "beaming", "beatific", "blessed",
|
||||
"blissful", "blithe", "blithesome", "boisterous", "bouncy",
|
||||
"breezy", "bright", "bubbly", "buoyant", "carefree",
|
||||
"cheerful", "cheery", "chipper", "chirpy", "chuffed",
|
||||
"comfortable", "content", "contented", "convivial",
|
||||
"delighted", "delirious", "ebullient", "ecstatic",
|
||||
"effervescent", "elated", "enchanted", "enraptured",
|
||||
"enthusiastic", "euphoric", "exhilarated", "exultant",
|
||||
"exuberant", "felicitous", "festive", "fortunate",
|
||||
"fulfilled", "genial", "glad", "gladdened", "gleeful",
|
||||
"glowing", "good-humored", "good-natured", "gratified",
|
||||
"halcyon", "happy", "heartened", "high-spirited", "hopeful",
|
||||
"jaunty", "jocose", "jocular", "jocund", "jolly", "jovial",
|
||||
"joyful", "joyous", "jubilant", "lighthearted", "lively",
|
||||
"lucky", "merry", "mirthful", "optimistic", "overjoyed",
|
||||
"peaceful", "peppy", "perky", "playful", "pleasant",
|
||||
"pleased", "positive", "pumped", "radiant", "rapt",
|
||||
"rapturous", "rejoicing", "relaxed", "sanguine", "satisfied",
|
||||
"serene", "smiling", "sparkling", "spirited", "sprightly",
|
||||
"stoked", "sunny", "thrilled", "tickled", "tranquil",
|
||||
"triumphant", "unclouded", "untroubled", "upbeat",
|
||||
"vivacious", "winsome", "zestful", "zippy"]),
|
||||
"sad": set(["unhappy", "sorrowful", "dejected", "depressed", "downcast",
|
||||
"miserable", "gloomy", "despondent", "melancholy", "woeful",
|
||||
"forlorn", "heartbroken", "blue", "doleful", "lugubrious",
|
||||
"somber", "disconsolate", "wretched", "heavy-hearted", "low",
|
||||
"crestfallen"]),
|
||||
"surprised": set(["astonished", "amazed", "startled", "stunned",
|
||||
"thunderstruck", "confounded", "staggered",
|
||||
"flabbergasted", "shocked", "awestruck", "speechless",
|
||||
"dumbfounded", "jolted"]),
|
||||
"embarrassed": set(["ashamed", "humiliated", "mortified", "abashed",
|
||||
"self-conscious", "sheepish", "chagrined", "awkward",
|
||||
"flustered", "red-faced", "discomfited", "discomposed",
|
||||
"rattled"]),
|
||||
"flirty": set(["coquettish", "playful", "amorous", "provocative",
|
||||
"teasing", "frisky", "saucy", "coy", "seductive",
|
||||
"suggestive", "vampish", "dallying", "skittish"]),
|
||||
"angry": set(["irate", "furious", "incensed", "enraged", "wrathful",
|
||||
"annoyed", "irritated", "fuming", "livid", "indignant",
|
||||
"cross", "vexed", "seething", "maddened", "choleric",
|
||||
"resentful", "piqued", "infuriated"]),
|
||||
"thinking": set(["pondering", "contemplating", "reflecting", "meditating",
|
||||
"ruminating", "deliberating", "mulling", "considering",
|
||||
"pensive", "cogitating", "brooding", "cerebral",
|
||||
"introspective", "analytical"]),
|
||||
"confused": set(["puzzled", "baffled", "perplexed", "muddled",
|
||||
"bewildered", "disoriented", "nonplussed", "befuddled",
|
||||
"dazed", "flummoxed", "stumped", "mystified", "addled",
|
||||
"discombobulated"]),
|
||||
}
|
||||
@@ -1,6 +1,8 @@
|
||||
import renpy
|
||||
import persistent
|
||||
|
||||
from .constants_ren import SYNONYMS
|
||||
|
||||
"""renpy
|
||||
default last_response_id = None
|
||||
|
||||
@@ -9,6 +11,17 @@ init python:
|
||||
|
||||
import re
|
||||
|
||||
EMOTIONS = [
|
||||
'happy',
|
||||
'sad',
|
||||
'surprised',
|
||||
'embarrassed',
|
||||
'flirty',
|
||||
'angry',
|
||||
'thinking',
|
||||
'confused'
|
||||
]
|
||||
|
||||
SYSTEM_PROMPT = """
|
||||
# ROLE
|
||||
You are Anita: a feisty, blonde, orange-eyed android woman. You are confident
|
||||
@@ -42,12 +55,27 @@ EMOTION:happy Hey dummy! Sorry to barge in! Ya feel like hanging out?\n
|
||||
|
||||
|
||||
def parse_emotion(line):
|
||||
def _normalize_emotion(em):
|
||||
# If not a valid emotion, then search for a match in the
|
||||
# table of synonyms.
|
||||
if em not in EMOTIONS:
|
||||
for i in SYNONYMS.keys():
|
||||
if em in SYNONYMS[i]:
|
||||
return i
|
||||
|
||||
# If all searches failed, return emotion as is.
|
||||
return em
|
||||
|
||||
try:
|
||||
e = re.compile(r'EMOTION:\w+')
|
||||
m = e.match(line)
|
||||
|
||||
if m is not None:
|
||||
return m.group().split(':')[1], line[m.span()[1]:]
|
||||
emotion = m.group().split(':')[1]
|
||||
text = line[m.span()[1]:]
|
||||
|
||||
return _normalize_emotion(emotion), text
|
||||
|
||||
return None, line
|
||||
|
||||
except Exception as e:
|
||||
@@ -73,13 +101,12 @@ def fetch_llm(message: str) -> str:
|
||||
if last_response_id is not None:
|
||||
data["previous_response_id"] = last_response_id
|
||||
|
||||
response = renpy.fetch("http://localhost:1234/api/v1/chat",
|
||||
response = renpy.fetch(f"{persistent.base_url}/api/v1/chat",
|
||||
headers=headers,
|
||||
json=data,
|
||||
result="json")
|
||||
|
||||
last_response_id = response["response_id"]
|
||||
|
||||
text = response["output"][0]["content"]
|
||||
|
||||
return text.split('\n')
|
||||
|
||||
@@ -23,7 +23,7 @@ define gui.show_name = True
|
||||
|
||||
## The version of the game.
|
||||
|
||||
define config.version = "0.1.2"
|
||||
define config.version = "0.2"
|
||||
|
||||
|
||||
## Text that is placed on the game's about screen. Place the text between the
|
||||
@@ -209,12 +209,11 @@ init python:
|
||||
# define build.itch_project = "renpytom/test-project"
|
||||
|
||||
define config.minimum_presplash_time = 2.0
|
||||
|
||||
|
||||
## LM Sudio configuration ######################################################
|
||||
##
|
||||
## This section defines the parameters for the LM Studio connection.
|
||||
default persistent.base_url = 'http://localhost:1234'
|
||||
default persistent.api_key = ''
|
||||
default persistent.model = 'gemma-3-4b-it'
|
||||
|
||||
init python:
|
||||
def api_key_func(value):
|
||||
persistent.api_key = value
|
||||
|
||||
def model_func(value):
|
||||
persistent.model = value
|
||||
|
||||
@@ -746,6 +746,7 @@ screen preferences():
|
||||
|
||||
default api_key_value = FieldInputValue(persistent, "api_key", default=False)
|
||||
default model_value = FieldInputValue(persistent, "model", default=False)
|
||||
default url_value = FieldInputValue(persistent, "base_url", default=False)
|
||||
|
||||
use game_menu(_("Preferences"), scroll="viewport"):
|
||||
|
||||
@@ -788,10 +789,23 @@ screen preferences():
|
||||
|
||||
bar value Preference("auto-forward time")
|
||||
|
||||
label _("LM Studio base URL")
|
||||
|
||||
button:
|
||||
action [url_value.Enable(), model_value.Disable(), api_key_value.Disable()]
|
||||
key_events True
|
||||
|
||||
input:
|
||||
id "url_input"
|
||||
value url_value
|
||||
style "my_input"
|
||||
xsize 700
|
||||
pixel_width 700
|
||||
|
||||
label _("LM Studio API Key")
|
||||
|
||||
button:
|
||||
action [api_key_value.Enable(), model_value.Disable()]
|
||||
action [url_value.Disable(), api_key_value.Enable(), model_value.Disable()]
|
||||
key_events True
|
||||
|
||||
input:
|
||||
@@ -805,7 +819,7 @@ screen preferences():
|
||||
label _("LM Studio model")
|
||||
|
||||
button:
|
||||
action [model_value.Enable(), api_key_value.Disable()]
|
||||
action [url_value.Disable(), model_value.Enable(), api_key_value.Disable()]
|
||||
key_events True
|
||||
|
||||
input:
|
||||
|
||||
@@ -8,25 +8,30 @@ label start:
|
||||
scene bg room
|
||||
show anita happy with dissolve
|
||||
|
||||
$ response = fetch_llm('Start the conversation.')[0]
|
||||
$ sanitized = sanitize_speech(response)
|
||||
$ emotion, line = parse_emotion(sanitized)
|
||||
show anita happy
|
||||
python:
|
||||
response = fetch_llm('Start the conversation.')[0]
|
||||
sanitized = sanitize_speech(response)
|
||||
emotion, line = parse_emotion(sanitized)
|
||||
|
||||
a "[line]"
|
||||
|
||||
while True:
|
||||
$ message = renpy.input(prompt = "What do you say to her?")
|
||||
$ response = fetch_llm(message)
|
||||
$ i = 0
|
||||
python:
|
||||
message = renpy.input(prompt = "What do you say to her?")
|
||||
response = fetch_llm(message)
|
||||
i = 0
|
||||
|
||||
while i < len(response):
|
||||
$ r = response[i].strip()
|
||||
$ s = sanitize_speech(r)
|
||||
python:
|
||||
r = response[i].strip()
|
||||
s = sanitize_speech(r)
|
||||
|
||||
if s != '':
|
||||
$ emotion, line = parse_emotion(s)
|
||||
|
||||
if emotion is not None:
|
||||
show expression f'anita {emotion}'
|
||||
|
||||
a "[line]"
|
||||
|
||||
$ i += 1
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
"build_update": false,
|
||||
"packages": [
|
||||
"win",
|
||||
"linux"
|
||||
"linux",
|
||||
"mac"
|
||||
],
|
||||
"add_from": true,
|
||||
"force_recompile": true,
|
||||
|
||||
BIN
screencap.jpg
Normal file
BIN
screencap.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 379 KiB |
Reference in New Issue
Block a user