Adopt Ghostwire name and approved ghost mascot
This commit is contained in:
1 parent
5aaa31dc1a
commit
626ec88a88
10 files changed
+43
-8
No files matched your search
@@ -1,4 +1,8 @@
|
||||
# Project instructions
|
||||
# Ghostwire project instructions
|
||||
|
||||
The project name is Ghostwire. Keep the existing `whatsapp.py` launcher, `whatsapp_suite` package and configured repository URL unless explicitly migrating them.
|
||||
|
||||
For clickable local Windows file links, use the actual absolute path starting with `C:/`, never `/C:/`. Wrap Markdown targets containing spaces in angle brackets. This format was confirmed to work in Karl's chat on 2026-10-11.
|
||||
|
||||
Use `whatsapp_suite/` as canonical source. `whatsapp.py` is generated; rebuild it after changing Python, assets or tests. Documentation-only changes do not require rebuilding.
|
||||
|
||||
|
||||
@@ -1,5 +1,11 @@
|
||||
# Changelog
|
||||
|
||||
## Ghostwire identity — 2026-10-11
|
||||
|
||||
- Adopt the Ghostwire name and the approved monochrome ghost mascot.
|
||||
- Add editable SVG and PNG logo assets and usage guidance.
|
||||
- Preserve the existing launcher, package and repository URL.
|
||||
|
||||
## Documentation and development guide — 2026-10-11
|
||||
|
||||
- Rewrite the user entry point and CLI guide around practical tasks.
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# Develop and extend the suite
|
||||
# Develop and extend Ghostwire
|
||||
|
||||
The editable implementation is `whatsapp_suite/`. The single-file `whatsapp.py` is a generated distribution. Changes to the encoded payload will be overwritten by the builder.
|
||||
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
# WhatsApp Desktop Suite
|
||||
<p align="center">
|
||||
<img src="assets/ghostwire-icon.svg" width="128" height="128" alt="Ghostwire ghost mascot">
|
||||
</p>
|
||||
|
||||
# Ghostwire
|
||||
|
||||
**Inside the process. Across the wire.**
|
||||
|
||||
Read, search and export local WhatsApp Desktop messages and contacts. Install a message listener that delivers events to an HTTPS webhook.
|
||||
|
||||
The main commands run JavaScript inside the signed-in Windows Desktop app through a bundled native bridge. They use neither CDP nor UI automation. This is an independent, reverse-engineered toolkit; it is not an official WhatsApp API.
|
||||
The main commands run JavaScript inside the signed-in Windows Desktop app through a bundled native bridge. They use neither CDP nor UI automation. Ghostwire is an independent, reverse-engineered toolkit; it is not an official WhatsApp API.
|
||||
|
||||
## Start here
|
||||
|
||||
@@ -89,6 +95,7 @@ Edit `whatsapp_suite/`; `whatsapp.py` is generated. The portable file is about 2
|
||||
| [Architecture](docs/ARCHITECTURE.md) | Understand the bridge and choose the right extension point |
|
||||
| [Contributing](CONTRIBUTING.md) | Add a command, change JavaScript, rebuild native helpers |
|
||||
| [Agent skill](skills/whatsapp-suite-development/SKILL.md) | Repository-specific guidance for coding agents |
|
||||
| [Brand assets](assets/README.md) | Logo files and usage |
|
||||
| [Troubleshooting](docs/TROUBLESHOOTING.md) | Resolve common setup and runtime problems |
|
||||
| [Validation](docs/VALIDATION.md) | Distinguish tested behavior from assumptions |
|
||||
| [Security](SECURITY.md) | Handle private data and credentials |
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# Ghostwire brand assets
|
||||
|
||||
Ghostwire's mascot is a minimal white ghost with a black outline, angry eyes and a mischievous smile. Use it with the project name **Ghostwire**. The optional tagline is **Inside the process. Across the wire.**
|
||||
|
||||
- [ghostwire-icon.svg](ghostwire-icon.svg): editable vector master, white ghost on a transparent background.
|
||||
- [ghostwire-icon.png](ghostwire-icon.png): 512 × 512 PNG on white, suitable for repository avatars and previews.
|
||||
|
||||
Prefer the SVG for resizing. Preserve the silhouette, facial expression and proportions. Use on a light background, with space around the icon. Avoid gradients, shadows or stretching. The icon is independent of WhatsApp's branding.
|
||||
|
||||
These are visual identity assets, not runtime dependencies. See [licensing status](../LICENSE.md) for the repository's current terms.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
@@ -0,0 +1,8 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 128 128" role="img" aria-labelledby="title desc">
|
||||
<title id="title">Ghostwire ghost mascot</title>
|
||||
<desc id="desc">A minimal white ghost with a black outline, angry eyes and a mischievous smile.</desc>
|
||||
<path d="M30 100V56C30 35 45 21 64 21S98 35 98 56V100C91 94 89 94 82 101S72 107 65 101S55 94 48 101S38 107 30 100Z"
|
||||
fill="#fff" stroke="#000" stroke-width="4.5" stroke-linecap="round" stroke-linejoin="round"/>
|
||||
<path d="M43 51L60 58C58 64 54 67 49 65S43 59 43 51ZM85 51L68 58C70 64 74 67 79 65S85 59 85 51Z" fill="#000"/>
|
||||
<path d="M52 77C60 83 69 83 77 75" fill="none" stroke="#000" stroke-width="4" stroke-linecap="round"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 729 B |
@@ -1,4 +1,4 @@
|
||||
# Architecture
|
||||
# Ghostwire architecture
|
||||
|
||||
## Two ways to run the same code
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# CLI reference
|
||||
# Ghostwire CLI reference
|
||||
|
||||
Use the portable file from a writable folder:
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
name: whatsapp-suite-development
|
||||
description: Maintain and extend this repository's WhatsApp Desktop Python suite, WebView bridge, message exports and webhook listener. Use for implementation, debugging, packaging or documentation in this project.
|
||||
description: Maintain and extend Ghostwire, this repository's WhatsApp Desktop Python suite, WebView bridge, message exports and webhook listener. Use for implementation, debugging, packaging or documentation in this project.
|
||||
---
|
||||
|
||||
# WhatsApp suite development
|
||||
# Ghostwire development
|
||||
|
||||
Use the repository containing this file. It has two distributions of the same code: editable `whatsapp_suite/` and generated portable `whatsapp.py`. The core path is Python ctypes → temporary Windows hook → bundled native DLL → existing WhatsApp WebView JavaScript. Core commands require no CDP or UI automation; separate research commands may use other transports.
|
||||
|
||||
|
||||
Reference in new issue
Block a user