foxsnakecode 1.0.0__tar.gz

foxsnakecode-1.0.0/.gitignore

@@ -0,0 +1,11 @@
+*.tsbuildinfo
+.ipynb_checkpoints/
+.yarn/
+__pycache__/
+demo/.jupyterlite.doit.db
+demo/_output/
+dist/
+foxsnakecode/_version.py
+foxsnakecode/labextension/
+lib/
+node_modules/

foxsnakecode-1.0.0/.releaserc.json

@@ -0,0 +1,12 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    ["@semantic-release/changelog", { "changelogFile": "CHANGELOG.md" }],
+    ["@semantic-release/npm", { "npmPublish": false }],
+    ["@semantic-release/exec", { "prepareCmd": "jlpm build:prod && python -m build --no-isolation" }],
+    ["@semantic-release/git", { "assets": ["CHANGELOG.md", "package.json"], "message": "chore(release): ${nextRelease.version} [skip ci]" }],
+    "@semantic-release/github"
+  ]
+}

foxsnakecode-1.0.0/.yarnrc.yml

@@ -0,0 +1,2 @@
+nodeLinker: node-modules
+enableTelemetry: false

foxsnakecode-1.0.0/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0 (2026-11-08)
+
+
+### Features
+
+* release ([36b9ebd](https://github.com/trungleduc/FoxSnakeCode/commit/36b9ebdf258e202f83d8b24419bea473c133196b))

foxsnakecode-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Trung Le Duc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

foxsnakecode-1.0.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.5
+Name: foxsnakecode
+Version: 1.0.0
+Summary: A coding puzzle game for JupyterLab and JupyterLite
+Author-email: Trung Le <trung.le@quantstack.net>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: jupyter,jupyterlab,jupyterlab-extension
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: jupyter-ai-lite<0.22,>=0.21
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img src="docs/grep-fox.png" width="140" alt="Grep Fox">
+  <img src="docs/sudo-snake.svg" width="140" alt="Sudo Snake">
+
+  <h1>FoxSnakeCode</h1>
+  <p><strong>Tactical Coding Action</strong></p>
+  <p>Coding missions, challenges, stealth debugging, boss levels...</p>
+  <p><em>Write Python. Slip past the searchlights. Steal the data.</em></p>
+  <p><a href="https://trungleduc.github.io/FoxSnakeCode/lab/"><strong>Try it in your browser</strong></a></p>
+</div>
+
+## Meet the team
+
+| | Codename | Role | |
+| --- | --- | --- | --- |
+| 🦊 | **Grep Fox** | Field agent | Sniffs out any word, in any file, in a flash. Your code tells Grep Fox where to go. |
+| 🐍 | **Sudo Snake** | HQ | Sneaks past bugs and runs every command with superpowers. Briefs you on every mission. |
+
+## How it plays
+
+1. Click FoxSnakeCode in the launcher to start a new game, or double-click a saved `.fsc` file.
+2. Pick the next open level on the map. Solving a level unlocks the one after it, and every 10th level is a boss.
+3. Read your briefing from Sudo Snake.
+4. Write Python, then press Run.
+5. Watch Grep Fox dodge searchlights, lasers and decoys to grab every data chip.
+
+FoxSnakeCode runs in JupyterLab and JupyterLite. Your code runs on a Python kernel, and xeus-python is preferred. The `foxsnakecode` package must be installed in the same environment as the kernel.
+
+## Hints from Sudo Snake
+
+Press **Ask for a hint** during a mission to chat with Sudo Snake. Hints use [jupyter-ai-lite](https://github.com/jupyterlite/ai), so players connect their own AI provider or sign in with OpenRouter from **Set up AI**. By default the key is kept in memory and cleared when the page reloads. Never put your own API key in a deployed site, because anyone can read it.
+
+Sudo Snake only sees the current level, the player's code and their last result, and has no tools. Its instructions keep it on the game and away from full solutions, but they run in the player's browser and are not a guarantee. The demo site turns off the general AI chat and code completion.
+
+## Install for development
+
+```bash
+micromamba create -n cgs -c conda-forge python=3.12 'jupyterlab=4.*' 'nodejs=22' xeus-python jupyterlite-core jupyterlite-xeus pip
+micromamba activate cgs
+pip install -e .
+jupyter labextension develop . --overwrite
+jlpm install
+jlpm build
+jupyter lab
+```
+
+Then click FoxSnakeCode in the launcher.
+
+The game logic is in `foxsnakecode/engine.py` and the levels are in `foxsnakecode/missions.json`. After editing the engine, press Stop or restart the kernel to load the new code. After editing the levels, close and reopen the game.
+
+## JupyterLite demo site
+
+The `demo` folder holds a JupyterLite site with xeus-python running in the browser. Build the site with the extension installed:
+
+```bash
+pip install build hatchling hatch-nodejs-version hatch-jupyter-builder
+jlpm build:demo
+```
+
+This builds the `foxsnakecode` wheel and installs it into the site's kernel. The site is written to `demo/_output`, which you can host on any static web server.
+
+After changing the extension, the Python package or the missions, `jlpm update:demo` copies them into an existing `demo/_output` without a full rebuild.
+
+A local demo build keeps files in memory only, so nothing is saved in the browser and reloading the page loses any game you started.
+
+The site deployed to GitHub Pages saves games in the player's browser instead.
+
+Stop restarts the kernel, so the next Run can take a few seconds in JupyterLite.
+
+## Commands players can use
+
+| Command | What it does |
+| --- | --- |
+| `step(distance)` | Walk forward. A negative number walks backward. |
+| `turn(degrees)` | Turn right. A negative number turns left. |
+| `turn_to(target)` | Face a chip, a guard or an `(x, y)` position. |
+| `distance_to(target)` | Get the distance to a chip, a guard or an `(x, y)` position. |
+| `wait(seconds)` | Stay still for a number of seconds. |
+| `chips` | The list of chips. Each has `x`, `y`, `trapped` and `collected`. |
+| `guards` | The list of guards. Each has `x`, `y` and `angle`, and they update as time passes. |
+
+A level is solved when every chip that isn't trapped has been collected. Searchlights, lasers, trapped chips and being spotted by a guard end the attempt, while crates and walls just block the way.
+
+## Adding levels
+
+Levels are in `foxsnakecode/missions.json`, and their order in the list is their order on the map. The world is 800 by 500 steps, with `x` increasing to the right and `y` increasing downward. An `angle` of 0 faces right.
+
+```json
+{
+  "title": "FoxSnakeCode",
+  "levels": [
+    {
+      "id": "first-steps",
+      "title": "First Steps",
+      "instructions": "Reach the chip with `step`.",
+      "starterCode": "step(100)\n",
+      "scene": {
+        "start": { "x": 100, "y": 250, "angle": 0 },
+        "chips": [{ "x": 400, "y": 250 }, { "x": 600, "y": 250, "trapped": true }],
+        "obstacles": [{ "x": 300, "y": 50, "w": 100, "h": 100 }],
+        "hazards": [
+          { "x": 600, "y": 100, "r": 50 },
+          { "x": 200, "y": 400, "w": 300, "h": 6 }
+        ],
+        "guards": [
+          { "route": [{ "x": 200, "y": 300 }, { "x": 600, "y": 300 }], "speed": 80 }
+        ]
+      }
+    }
+  ]
+}
+```
+
+Each level needs a unique `id`. Saved games refer to levels by `id`, so never change one after release; new levels can go anywhere in the list without breaking saves. Add `"boss": true` to mark a boss level.
+
+In `hazards`, an item with `r` is a searchlight and an item with `w` and `h` is a laser. Text between backticks in `instructions` is shown as code.
+
+In `guards`, each guard walks its `route` at `speed` steps per second, then returns to the first point and starts again. Grep Fox is spotted inside a guard's vision cone or by touching the guard, and crates block the cone. Put guard routes where they don't pass through crates.
+
+## The `.fsc` file
+
+A `.fsc` file holds only the player's save and starts empty, so each file is a separate playthrough. Work is saved automatically so players can close it and continue later:
+
+```json
+{
+  "progress": {
+    "currentLevel": "first-steps",
+    "solved": ["first-steps"],
+    "code": { "first-steps": "step(300)\n" }
+  }
+}
+```
+
+Sharing a file also shares the player's answers.

foxsnakecode-1.0.0/README.md

@@ -0,0 +1,134 @@
+<div align="center">
+  <img src="docs/grep-fox.png" width="140" alt="Grep Fox">
+  <img src="docs/sudo-snake.svg" width="140" alt="Sudo Snake">
+
+  <h1>FoxSnakeCode</h1>
+  <p><strong>Tactical Coding Action</strong></p>
+  <p>Coding missions, challenges, stealth debugging, boss levels...</p>
+  <p><em>Write Python. Slip past the searchlights. Steal the data.</em></p>
+  <p><a href="https://trungleduc.github.io/FoxSnakeCode/lab/"><strong>Try it in your browser</strong></a></p>
+</div>
+
+## Meet the team
+
+| | Codename | Role | |
+| --- | --- | --- | --- |
+| 🦊 | **Grep Fox** | Field agent | Sniffs out any word, in any file, in a flash. Your code tells Grep Fox where to go. |
+| 🐍 | **Sudo Snake** | HQ | Sneaks past bugs and runs every command with superpowers. Briefs you on every mission. |
+
+## How it plays
+
+1. Click FoxSnakeCode in the launcher to start a new game, or double-click a saved `.fsc` file.
+2. Pick the next open level on the map. Solving a level unlocks the one after it, and every 10th level is a boss.
+3. Read your briefing from Sudo Snake.
+4. Write Python, then press Run.
+5. Watch Grep Fox dodge searchlights, lasers and decoys to grab every data chip.
+
+FoxSnakeCode runs in JupyterLab and JupyterLite. Your code runs on a Python kernel, and xeus-python is preferred. The `foxsnakecode` package must be installed in the same environment as the kernel.
+
+## Hints from Sudo Snake
+
+Press **Ask for a hint** during a mission to chat with Sudo Snake. Hints use [jupyter-ai-lite](https://github.com/jupyterlite/ai), so players connect their own AI provider or sign in with OpenRouter from **Set up AI**. By default the key is kept in memory and cleared when the page reloads. Never put your own API key in a deployed site, because anyone can read it.
+
+Sudo Snake only sees the current level, the player's code and their last result, and has no tools. Its instructions keep it on the game and away from full solutions, but they run in the player's browser and are not a guarantee. The demo site turns off the general AI chat and code completion.
+
+## Install for development
+
+```bash
+micromamba create -n cgs -c conda-forge python=3.12 'jupyterlab=4.*' 'nodejs=22' xeus-python jupyterlite-core jupyterlite-xeus pip
+micromamba activate cgs
+pip install -e .
+jupyter labextension develop . --overwrite
+jlpm install
+jlpm build
+jupyter lab
+```
+
+Then click FoxSnakeCode in the launcher.
+
+The game logic is in `foxsnakecode/engine.py` and the levels are in `foxsnakecode/missions.json`. After editing the engine, press Stop or restart the kernel to load the new code. After editing the levels, close and reopen the game.
+
+## JupyterLite demo site
+
+The `demo` folder holds a JupyterLite site with xeus-python running in the browser. Build the site with the extension installed:
+
+```bash
+pip install build hatchling hatch-nodejs-version hatch-jupyter-builder
+jlpm build:demo
+```
+
+This builds the `foxsnakecode` wheel and installs it into the site's kernel. The site is written to `demo/_output`, which you can host on any static web server.
+
+After changing the extension, the Python package or the missions, `jlpm update:demo` copies them into an existing `demo/_output` without a full rebuild.
+
+A local demo build keeps files in memory only, so nothing is saved in the browser and reloading the page loses any game you started.
+
+The site deployed to GitHub Pages saves games in the player's browser instead.
+
+Stop restarts the kernel, so the next Run can take a few seconds in JupyterLite.
+
+## Commands players can use
+
+| Command | What it does |
+| --- | --- |
+| `step(distance)` | Walk forward. A negative number walks backward. |
+| `turn(degrees)` | Turn right. A negative number turns left. |
+| `turn_to(target)` | Face a chip, a guard or an `(x, y)` position. |
+| `distance_to(target)` | Get the distance to a chip, a guard or an `(x, y)` position. |
+| `wait(seconds)` | Stay still for a number of seconds. |
+| `chips` | The list of chips. Each has `x`, `y`, `trapped` and `collected`. |
+| `guards` | The list of guards. Each has `x`, `y` and `angle`, and they update as time passes. |
+
+A level is solved when every chip that isn't trapped has been collected. Searchlights, lasers, trapped chips and being spotted by a guard end the attempt, while crates and walls just block the way.
+
+## Adding levels
+
+Levels are in `foxsnakecode/missions.json`, and their order in the list is their order on the map. The world is 800 by 500 steps, with `x` increasing to the right and `y` increasing downward. An `angle` of 0 faces right.
+
+```json
+{
+  "title": "FoxSnakeCode",
+  "levels": [
+    {
+      "id": "first-steps",
+      "title": "First Steps",
+      "instructions": "Reach the chip with `step`.",
+      "starterCode": "step(100)\n",
+      "scene": {
+        "start": { "x": 100, "y": 250, "angle": 0 },
+        "chips": [{ "x": 400, "y": 250 }, { "x": 600, "y": 250, "trapped": true }],
+        "obstacles": [{ "x": 300, "y": 50, "w": 100, "h": 100 }],
+        "hazards": [
+          { "x": 600, "y": 100, "r": 50 },
+          { "x": 200, "y": 400, "w": 300, "h": 6 }
+        ],
+        "guards": [
+          { "route": [{ "x": 200, "y": 300 }, { "x": 600, "y": 300 }], "speed": 80 }
+        ]
+      }
+    }
+  ]
+}
+```
+
+Each level needs a unique `id`. Saved games refer to levels by `id`, so never change one after release; new levels can go anywhere in the list without breaking saves. Add `"boss": true` to mark a boss level.
+
+In `hazards`, an item with `r` is a searchlight and an item with `w` and `h` is a laser. Text between backticks in `instructions` is shown as code.
+
+In `guards`, each guard walks its `route` at `speed` steps per second, then returns to the first point and starts again. Grep Fox is spotted inside a guard's vision cone or by touching the guard, and crates block the cone. Put guard routes where they don't pass through crates.
+
+## The `.fsc` file
+
+A `.fsc` file holds only the player's save and starts empty, so each file is a separate playthrough. Work is saved automatically so players can close it and continue later:
+
+```json
+{
+  "progress": {
+    "currentLevel": "first-steps",
+    "solved": ["first-steps"],
+    "code": { "first-steps": "step(300)\n" }
+  }
+}
+```
+
+Sharing a file also shares the player's answers.

foxsnakecode-1.0.0/demo/environment.yml

@@ -0,0 +1,8 @@
+name: xeus-kernels
+channels:
+  - https://repo.prefix.dev/emscripten-forge-dev
+  - https://repo.prefix.dev/conda-forge
+dependencies:
+  - xeus-python
+  - pip:
+    - ../dist/foxsnakecode-0.0.0-py3-none-any.whl

foxsnakecode-1.0.0/demo/jupyter-lite.json

@@ -0,0 +1,16 @@
+{
+  "jupyter-config-data": {
+    "enableMemoryStorage": true,
+    "contentsStorageDrivers": ["memoryStorageDriver"],
+    "disabledExtensions": [
+      "jupyterlab-chat-extension",
+      "@jupyter-ai/jupyternaut-lite:plugin",
+      "@jupyter-ai/jupyternaut-lite:mention",
+      "@jupyter-ai/jupyternaut-lite:skills-command",
+      "@jupyter-ai/jupyternaut-lite:stop-button",
+      "@jupyter-ai/jupyternaut-lite:chat-components-callbacks",
+      "@jupyter-ai/jupyternaut-lite:completion-status",
+      "@jupyterlab/completer-extension:inline-completer"
+    ]
+  }
+}

foxsnakecode-1.0.0/demo/jupyter_lite_config.json

@@ -0,0 +1,12 @@
+{
+  "LiteBuildConfig": {
+    "extra_file_types": {
+      "fsc": {
+        "name": "fsc",
+        "extensions": [".fsc"],
+        "mimeTypes": ["application/json"],
+        "fileFormat": "text"
+      }
+    }
+  }
+}

foxsnakecode-1.0.0/docs/sudo-snake.svg

@@ -0,0 +1,41 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="480" height="480" viewBox="140 40 320 320" role="img" aria-label="Sudo Snake avatar: the snake's head in its hoodie on a yellow circle">
+<defs>
+<clipPath id="avatarClip"><circle cx="300" cy="200" r="158"></circle></clipPath>
+</defs>
+<circle cx="300" cy="200" r="158" fill="#FFC93C"></circle>
+<g clip-path="url(#avatarClip)">
+<path d="M 380 505 C 470 470 450 360 360 340 C 280 320 260 280 300 250" fill="none" stroke="#0F2E33" stroke-width="82" stroke-linecap="round"></path>
+<path d="M 380 505 C 470 470 450 360 360 340 C 280 320 260 280 300 250" fill="none" stroke="#34C58F" stroke-width="66" stroke-linecap="round"></path>
+<path d="M 380 505 C 470 470 450 360 360 340" fill="none" stroke="#C9F5DC" stroke-width="22" stroke-linecap="round"></path>
+<path d="M 360 340 C 280 320 260 280 300 250" fill="none" stroke="#0F2E33" stroke-width="96" stroke-linecap="round"></path>
+<path d="M 360 340 C 280 320 260 280 300 250" fill="none" stroke="#3D4A6B" stroke-width="82" stroke-linecap="round"></path>
+<rect x="352" y="290" width="20" height="100" rx="10" fill="#3D4A6B" stroke="#0F2E33" stroke-width="5" transform="rotate(14 362 340)"></rect>
+<rect x="352" y="290" width="20" height="100" rx="10" fill="#FFFFFF" opacity="0.14" transform="rotate(14 362 340)"></rect>
+<ellipse cx="300" cy="178" rx="132" ry="118" fill="#3D4A6B" stroke="#0F2E33" stroke-width="6"></ellipse>
+<ellipse cx="300" cy="188" rx="112" ry="96" fill="#141A26"></ellipse>
+<circle cx="311" cy="322" r="19" fill="#FFFFFF" stroke="#0F2E33" stroke-width="5"></circle>
+<text x="311" y="331" text-anchor="middle" font-family="JetBrains Mono, monospace" font-size="24" font-weight="500" fill="#0F2E33">#</text>
+<ellipse cx="300" cy="202" rx="100" ry="78" fill="#34C58F" stroke="#0F2E33" stroke-width="6"></ellipse>
+<circle cx="276" cy="140" r="8" fill="#0F2E33" opacity="0.16"></circle>
+<circle cx="322" cy="137" r="6" fill="#0F2E33" opacity="0.16"></circle>
+<circle cx="300" cy="131" r="4" fill="#0F2E33" opacity="0.16"></circle>
+<path d="M 205 222 Q 212 268 258 266" fill="none" stroke="#0F2E33" stroke-width="6" stroke-linecap="round"></path>
+<circle cx="263" cy="266" r="8" fill="#0F2E33"></circle>
+<circle cx="200" cy="205" r="17" fill="#FFC93C" stroke="#0F2E33" stroke-width="5"></circle>
+<ellipse cx="262" cy="192" rx="25" ry="29" fill="#FFFFFF" stroke="#0F2E33" stroke-width="4"></ellipse>
+<ellipse cx="338" cy="192" rx="25" ry="29" fill="#FFFFFF" stroke="#0F2E33" stroke-width="4"></ellipse>
+<circle cx="269" cy="197" r="13" fill="#0F2E33"></circle>
+<circle cx="345" cy="197" r="13" fill="#0F2E33"></circle>
+<circle cx="274" cy="190" r="5" fill="#FFFFFF"></circle>
+<circle cx="350" cy="190" r="5" fill="#FFFFFF"></circle>
+<path d="M 236 152 Q 260 146 286 160" fill="none" stroke="#0F2E33" stroke-width="7" stroke-linecap="round"></path>
+<path d="M 364 152 Q 340 146 314 160" fill="none" stroke="#0F2E33" stroke-width="7" stroke-linecap="round"></path>
+<ellipse cx="232" cy="232" rx="13" ry="8" fill="#FF8FA3" opacity="0.6"></ellipse>
+<ellipse cx="368" cy="232" rx="13" ry="8" fill="#FF8FA3" opacity="0.6"></ellipse>
+<circle cx="292" cy="226" r="2.5" fill="#0F2E33"></circle>
+<circle cx="308" cy="226" r="2.5" fill="#0F2E33"></circle>
+<path d="M 280 240 Q 302 256 326 238" fill="none" stroke="#0F2E33" stroke-width="5" stroke-linecap="round"></path>
+<path d="M 306 249 L 309 266 L 302 274 M 309 266 L 316 274" fill="none" stroke="#E5484D" stroke-width="4" stroke-linecap="round" stroke-linejoin="round"></path>
+</g>
+<circle cx="300" cy="200" r="158" fill="none" stroke="#0F2E33" stroke-width="6"></circle>
+</svg>

foxsnakecode-1.0.0/foxsnakecode/__init__.py

@@ -0,0 +1,8 @@
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "dev"
+
+
+def _jupyter_labextension_paths():
+    return [{"src": "labextension", "dest": "foxsnakecode"}]

foxsnakecode-1.0.0/foxsnakecode/_version.py

@@ -0,0 +1,4 @@
+# This file is auto-generated by Hatchling. As such, do not:
+#   - modify
+#   - track in version control e.g. be sure to add to .gitignore
+__version__ = VERSION = '1.0.0'