Instructions to use AGofficial/MyName_RPG with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use AGofficial/MyName_RPG with llama.cpp:
Install (macOS, Linux)
curl -LsSf https://llama.app/install.sh | sh # Start a local OpenAI-compatible server with a web UI: llama serve -hf AGofficial/MyName_RPG # Run inference directly in the terminal: llama cli -hf AGofficial/MyName_RPG
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama serve -hf AGofficial/MyName_RPG # Run inference directly in the terminal: llama cli -hf AGofficial/MyName_RPG
Use pre-built binary
# Download pre-built binary from: # https://github.com/ggerganov/llama.cpp/releases # Start a local OpenAI-compatible server with a web UI: ./llama-server -hf AGofficial/MyName_RPG # Run inference directly in the terminal: ./llama-cli -hf AGofficial/MyName_RPG
Build from source code
git clone https://github.com/ggerganov/llama.cpp.git cd llama.cpp cmake -B build cmake --build build -j --target llama-server llama-cli # Start a local OpenAI-compatible server with a web UI: ./build/bin/llama-server -hf AGofficial/MyName_RPG # Run inference directly in the terminal: ./build/bin/llama-cli -hf AGofficial/MyName_RPG
Use Docker
docker model run hf.co/AGofficial/MyName_RPG
- Llama new
- LM Studio
- Jan
- Ollama
How to use AGofficial/MyName_RPG with Ollama:
ollama run hf.co/AGofficial/MyName_RPG
- Unsloth Desktop
- Docker Model Runner
How to use AGofficial/MyName_RPG with Docker Model Runner:
docker model run hf.co/AGofficial/MyName_RPG
- Lemonade
How to use AGofficial/MyName_RPG with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull AGofficial/MyName_RPG
Run and chat with the model
lemonade run user.MyName_RPG-{{QUANT_TAG}}List all available models
lemonade list
- Atomic Chat
File size: 13,517 Bytes
e95022e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | """Window loop and script runner for Dream Chat Engine."""
from __future__ import annotations
import queue
import threading
import time
import tkinter as tk
from collections import OrderedDict
from pathlib import Path
from typing import Any, Sequence
from PIL import Image, ImageTk
from .actions import Ask, Generate, GeneratedReply, Hide, Say, SetBackground, Show
from .assets import AssetManager
from .character import CharacterSprite
from .config import EngineConfig
from .dialogue import DialogueState
from .renderer import SceneRenderer
ScriptAction = SetBackground | Show | Hide | Say | Generate | Ask
class DreamChatEngine:
def __init__(
self,
script: Sequence[ScriptAction],
project_root: str | Path,
config: EngineConfig | None = None,
voice_manager: object | None = None,
) -> None:
self.script = list(script)
self.config = config or EngineConfig()
self.assets = AssetManager(project_root)
self.dialogue = DialogueState(text_speed=self.config.text_speed)
self.renderer = SceneRenderer(self.config)
self.voice_manager = voice_manager
self.background: Image.Image | None = None
self.characters: OrderedDict[str, CharacterSprite] = OrderedDict()
self.variables: dict[str, str] = {}
self.history: list[dict[str, str]] = []
self._index = 0
self._active_ask: Ask | None = None
self._generation_queue: queue.Queue[dict[str, Any]] | None = None
self._generation_thread: threading.Thread | None = None
self._speech_handle: Any | None = None
self._demo_finished = False
self._last_tick = time.perf_counter()
self._root: tk.Tk | None = None
self._canvas: tk.Canvas | None = None
self._photo: ImageTk.PhotoImage | None = None
def run(self) -> None:
self._root = tk.Tk()
self._root.title(self.config.title)
self._root.geometry(f"{self.config.width}x{self.config.height}")
self._root.minsize(self.config.min_width, self.config.min_height)
self._canvas = tk.Canvas(self._root, highlightthickness=0, bg="black")
self._canvas.pack(fill=tk.BOTH, expand=True)
self._canvas.focus_set()
self._root.bind("<Key>", self._on_key)
self._root.bind("<Button-1>", self._on_click)
self._canvas.bind("<Button-1>", self._on_click)
self._advance_script()
self._tick()
self._root.mainloop()
def _tick(self) -> None:
now = time.perf_counter()
delta = now - self._last_tick
self._last_tick = now
self.dialogue.update(delta)
self._drain_generation_queue()
self._maybe_auto_advance()
self._render()
if self._root is not None:
delay_ms = max(1, int(1000 / self.config.fps))
self._root.after(delay_ms, self._tick)
def _render(self) -> None:
if self._canvas is None:
return
width = max(1, self._canvas.winfo_width())
height = max(1, self._canvas.winfo_height())
if width <= 1 or height <= 1:
width, height = self.config.width, self.config.height
frame = self.renderer.compose(
(width, height),
self.background,
self.characters.values(),
self.dialogue,
)
self._photo = ImageTk.PhotoImage(frame)
self._canvas.delete("all")
self._canvas.create_image(0, 0, anchor=tk.NW, image=self._photo)
def _advance_script(self) -> None:
self._active_ask = None
self._speech_handle = None
while self._index < len(self.script):
action = self.script[self._index]
self._index += 1
if isinstance(action, SetBackground):
self.background = self.assets.load_background(action.image)
continue
if isinstance(action, Show):
tag = action.tag or action.name
self.characters[tag] = CharacterSprite(
tag=tag,
name=action.name,
image=self.assets.load_character(action.image),
position=action.position,
)
continue
if isinstance(action, Hide):
self.characters.pop(action.tag, None)
continue
if isinstance(action, Say):
speaker = self._format(action.speaker)
text = self._format(action.text)
self.dialogue.start_say(speaker, text)
self._record_line(speaker, text)
self._speech_handle = self._speak(speaker, text)
return
if isinstance(action, Generate):
self._start_generated_reply(action)
return
if isinstance(action, Ask):
self._active_ask = action
self.dialogue.start_input(
self._format(action.speaker),
self._format(action.prompt),
)
return
if self.config.end_message is not None and not self._demo_finished:
self._demo_finished = True
self.dialogue.start_say(self.config.end_speaker, self.config.end_message)
else:
self.close()
def _on_click(self, _event: tk.Event) -> None:
if self.dialogue.mode == "input":
return
self._continue_or_skip()
def _on_key(self, event: tk.Event) -> None:
keysym = event.keysym
if self.dialogue.mode == "input":
self._handle_input_key(event)
return
if keysym in {"space", "Return"}:
self._continue_or_skip()
def _continue_or_skip(self) -> None:
if self.config.auto_advance or self.dialogue.mode == "loading":
return
if not self._speech_is_done():
return
if self.dialogue.mode != "say":
return
if not self.dialogue.is_complete:
self.dialogue.reveal_all()
return
self._advance_script()
def _handle_input_key(self, event: tk.Event) -> None:
keysym = event.keysym
if keysym == "Return":
self._submit_input()
elif keysym == "BackSpace":
self.dialogue.backspace()
elif keysym == "Delete":
self.dialogue.delete()
elif keysym == "Left":
self.dialogue.move_caret(-1)
elif keysym == "Right":
self.dialogue.move_caret(1)
elif keysym == "Home":
self.dialogue.move_caret_home()
elif keysym == "End":
self.dialogue.move_caret_end()
elif event.char:
self._insert_input_text(event.char)
def _insert_input_text(self, text: str) -> None:
max_chars = self.config.max_input_chars
if self._active_ask is not None and self._active_ask.max_chars is not None:
max_chars = self._active_ask.max_chars
if self._active_ask is not None and self._active_ask.input_rule == "letters":
text = "".join(ch for ch in text if ch.isalpha())
self.dialogue.insert_text(text, max_chars)
def _submit_input(self) -> None:
if self._active_ask is None:
return
response = self.dialogue.submit_input()
if len(response) < self._active_ask.min_chars:
self.dialogue.start_input(
self._format(self._active_ask.speaker),
self._format(self._active_ask.prompt),
)
return
if not response:
response = "..."
self.variables[self._active_ask.variable] = response
response_speaker = self._active_ask.response_speaker or self._active_ask.speaker
speaker = self._format(response_speaker)
self.dialogue.start_say(speaker, response)
self._record_line(speaker, response)
self._speech_handle = self._speak(speaker, response)
self._active_ask = None
def _start_generated_reply(self, action: Generate) -> None:
speaker = self._format(action.speaker)
self.dialogue.start_loading(speaker)
self._speech_handle = None
self._generation_queue = queue.Queue()
variables = dict(self.variables)
history = [dict(item) for item in self.history]
def worker() -> None:
try:
reply = action.producer(variables, history)
if isinstance(reply, str):
raw_text = reply
else:
raw_text = "".join(str(chunk) for chunk in reply if chunk)
generated = self._postprocess_generated(action, raw_text, variables, history)
prepared_audio = self._prepare_speech(speaker, generated.text)
self._generation_queue.put(
{
"text": generated.text,
"actions": list(generated.actions),
"variables": dict(generated.variables),
"prepared_audio": prepared_audio,
}
)
except Exception as exc:
self._generation_queue.put(
{
"text": f"I must pause. {exc}",
"actions": [],
"variables": {},
"prepared_audio": None,
}
)
self._generation_thread = threading.Thread(target=worker, daemon=True)
self._generation_thread.start()
def _drain_generation_queue(self) -> None:
if self._generation_queue is None:
return
try:
payload = self._generation_queue.get_nowait()
except queue.Empty:
return
speaker = self.dialogue.speaker
text = str(payload.get("text") or "").strip()
if not text:
text = "We will discuss that in due time."
self.variables.update(payload.get("variables") or {})
self.insert_actions(payload.get("actions") or [])
self.dialogue.start_say(speaker, text)
self._record_line(speaker, text)
self._speech_handle = self._speak(
speaker,
text,
prepared_audio=payload.get("prepared_audio"),
)
self._generation_queue = None
self._generation_thread = None
def _postprocess_generated(
self,
action: Generate,
raw_text: str,
variables: dict[str, str],
history: list[dict[str, str]],
) -> GeneratedReply:
text = raw_text.strip()
if action.postprocess is None:
return GeneratedReply(text=text)
processed = action.postprocess(text, variables, history)
if isinstance(processed, GeneratedReply):
return processed
return GeneratedReply(text=str(processed).strip())
def insert_actions(self, actions: Sequence[ScriptAction]) -> None:
if not actions:
return
self.script[self._index : self._index] = list(actions)
def _maybe_auto_advance(self) -> None:
if not self.config.auto_advance:
return
if self.dialogue.mode != "say":
return
if not self.dialogue.is_complete:
return
if not self._speech_is_done():
return
self._advance_script()
def _record_line(self, speaker: str, text: str) -> None:
self.history.append({"speaker": speaker, "text": text})
def _prepare_speech(self, speaker: str, text: str) -> Any | None:
if self.voice_manager is None:
return None
prepare = getattr(self.voice_manager, "prepare", None)
if prepare is None:
return None
try:
return prepare(speaker, text)
except Exception:
return None
def _speak(self, speaker: str, text: str, prepared_audio: Any | None = None) -> Any | None:
if self.voice_manager is None:
return None
speak = getattr(self.voice_manager, "speak", None)
if speak is None:
return None
try:
return speak(speaker, text, prepared_audio=prepared_audio)
except Exception:
return None
def _speech_is_done(self) -> bool:
if self._speech_handle is None:
return True
is_done = getattr(self._speech_handle, "is_done", None)
if is_done is not None:
try:
return bool(is_done())
except Exception:
return True
done = getattr(self._speech_handle, "done", None)
if done is not None:
return bool(done)
return True
def close(self) -> None:
if self.voice_manager is not None:
stop = getattr(self.voice_manager, "stop", None)
if stop is not None:
try:
stop()
except Exception:
pass
if self._root is not None:
self._root.destroy()
self._root = None
def _format(self, value: str) -> str:
try:
return value.format_map(_SafeVariables(self.variables))
except (KeyError, ValueError):
return value
class _SafeVariables(dict[str, str]):
def __missing__(self, key: str) -> str:
return "{" + key + "}"
|