Revise README for compiled version and installation steps

Updated README to include compiled version details and usage instructions.
This commit is contained in:
Luan Lima
2026-07-06 04:49:21 -03:00
committed by GitHub
parent 3b776c52fc
commit b2d563b140
+23 -151
View File
@@ -1,162 +1,34 @@
<div align="center"> # 🪄 Wand Enhancer (Versão Compilada)
![logo](./assets/icon.svg) ![Badge Status](https://img.shields.io/badge/Status-Compilado-success?style=for-the-badge)
![Badge Plataforma](https://img.shields.io/badge/Plataforma-Windows-blue?style=for-the-badge&logo=windows)
![Badge Licença](https://img.shields.io/badge/Licen%C3%A7a-Open_Source-green?style=for-the-badge)
# WandEnhancer > **⚠️ AVISO IMPORTANTE:** Este repositório/página contém apenas a **versão compilada** e pronta para uso do aplicativo. O código-fonte original, a lógica e todo o mérito da criação deste software pertencem ao **[k1tbyte](https://github.com/k1tbyte)**.
[![GitLab Mirror](https://img.shields.io/badge/GitLab-mirror-fc6d26?logo=gitlab)](https://gitlab.com/kitbyte/wand-enhancer)
</div>
<h4>An open-source interoperability tool designed to extend local client-side configurations and improve the UX of the Wand application.</h4>
**🚨 IMPORTANT NOTICE: THIS PROJECT HAS NO OFFICIAL YOUTUBE TUTORIALS, GUIDES, OR PREBUILT EXECUTABLE DOWNLOADS. 🚨
There are no official videos showing how to install or use this tool. Scammers are creating fake tutorials using this project's name and placing malware/password stealers in the video descriptions. Official GitHub releases contain release notes only, not `.exe` files. If you downloaded an `.exe` or archive from a YouTube link, a random website, or a third-party mirror, you did not get it from this project. We are not responsible for third-party downloads.**
## 👾 Is it safe to use?
Yes. This project is entirely open-source, allowing anyone to audit the code. It operates strictly locally, does not require internet access, and makes zero network requests. It simply adjusts local client settings to enhance your user experience.
## 💫 What features are improved?
✅ Local environment configuration management <br/>
✅ Automated compatibility adjustments for new client versions <br/>
✅ Advanced layout and theme customization (Client-side only) <br/>
✅ AI Features <br/>
✅ Remote web panel (Remote Connect on mobile) <br/>
## 🌐 Remote Web Panel
WandEnhancer includes a built-in **Remote Web Panel** allowing you to control app features directly from your phone.
### Quick Start:
1. Ensure both your PC and phone are on the **same Wi-Fi network**.
2. Hover over the **Connect** button in the top bar of WandEnhancer.
3. Scan the displayed **QR code** with your phone's camera.
### Troubleshooting & Remote Access:
- **Page isn't loading?** First, ensure both your PC and phone are connected to the **same local network**. Some routers and guest Wi-Fi networks enable client isolation/AP isolation, which blocks devices on the same SSID from reaching each other. If it still does not load, check Windows Firewall and allow inbound traffic on TCP port `3223` for your local network. If Windows marked your connection as **Public**, switching it to **Private** can also help.
- **Using mobile data or a different network?** If you want to use the panel over mobile data (LTE/5G) or from an entirely different network, you can use [Tailscale](https://tailscale.com/) or similar VPN tools.
## 👀 How to use?
This repository does not publish official compiled binaries. Build your own executable from your own fork using GitHub Actions.
1. Sign in to GitHub and fork this repository.
2. Open your fork, go to the **Actions** tab, and enable workflows if GitHub asks you to.
3. Select the **Build executable** workflow.
4. Click **Run workflow**, keep the default branch, and start the run.
5. Wait for the workflow to finish, open the completed run, and download the artifact.
6. Extract the artifact zip and run `WandEnhancer.exe` to apply local client modifications.
*Here how you do it:*
https://github.com/user-attachments/assets/7966cabe-0aa6-424d-8c2f-981ad91e0f91
## 🧩 Custom scripts
You can inject your own JavaScript into Wand at patch time to tweak or fix things in the client UI. This reuses the same renderer injection the Remote Web Panel uses, so it requires the **Remote Web Panel** patch to be enabled.
**How to add a script**
- In the patch dialog, add one or more `.js` files (only existing `.js` files are accepted), **or**
- Drop `.js` files into a `renderer-scripts/` folder placed next to the patcher executable.
Then patch as usual — your scripts are bundled into the client and run inside Wand's window.
**How it runs**
- Each script runs inside Wand's renderer (full DOM access, plus Node `require`).
- It is wrapped so a thrown error is logged and never crashes Wand.
- It may run **more than once** per launch (on load and again shortly after), so guard onetime work behind a global flag.
- A small `WandEnhancer` helper is available: `WandEnhancer.log(...)`, `WandEnhancer.remoteUrl`, `WandEnhancer.apiVersion`.
**Minimal example** (`hello.js`)
```js
// Injected scripts can run multiple times — guard one-time setup.
if (!globalThis.__helloScriptInstalled) {
globalThis.__helloScriptInstalled = true;
WandEnhancer.log("Hello from my custom script!", WandEnhancer.remoteUrl);
new MutationObserver(() => {
const dialog = document.querySelector("ux-dialog:not([data-seen])");
if (dialog) {
dialog.setAttribute("data-seen", "1");
WandEnhancer.log("A dialog opened.");
}
}).observe(document.documentElement, { childList: true, subtree: true });
}
```
> Scripts run with the same privileges as the Wand client. Only add scripts you trust and understand.
## 🛠️ How to build from source
Building from source on Windows requires a local development environment.
### Requirements
- `CMake`
- `Node.js` and `pnpm`
- `Visual Studio 2022` or `Build Tools for Visual Studio 2022` with `MSBuild`
- Visual Studio `Desktop development with C++` workload
- .NET Framework 4.8 desktop build tools / targeting pack
### Build steps
1. Clone this repository.
2. Install the requirements above and make sure `cmake`, `pnpm`, and `MSBuild` are available.
3. Run `build.cmd` from Command Prompt or PowerShell.
The build script installs the web panel dependencies, builds the frontend, compiles the native helper with CMake, restores NuGet packages, and builds the WPF solution.
--- ---
## ❓ Q&A ## 📖 Sobre
- **Why is there no `.exe` in GitHub Releases?** O **Wand Enhancer** é uma ferramenta poderosa e intuitiva. Muitos usuários têm dificuldade em baixar o código-fonte, instalar as dependências e compilar o projeto por conta própria.
- Official releases are notes-only on purpose. The project no longer distributes prebuilt executables because unsigned or self-built patching tools are repeatedly reuploaded, mislabeled, and flagged by third-party scanners. Build the executable from your own fork using GitHub Actions instead.
- **Where do I download the executable?**
- From your own fork's **Actions** artifact after running the **Build executable** workflow. Do not download `.exe` files from YouTube descriptions, random mirrors, Discord attachments, or issue comments.
- **Why does Windows Defender or SmartScreen warn about my build?**
- The GitHub Actions artifact is unsigned and uncommon, so Windows may warn even when the code was built directly from your fork. Review the source, verify the workflow logs, and only run binaries you built yourself.
- **Can I use a binary built by someone else?**
- You can, but you should treat it as untrusted. This repository cannot verify or support third-party builds.
- **Does this send data anywhere?**
- The desktop patching work is local to your machine. The Remote Web Panel is served from your PC on your local network.
--- Pensando nisso, disponibilizo aqui a versão já compilada (formato `.exe`), facilitando o acesso para quem deseja apenas baixar e usar o programa imediatamente, sem complicações técnicas.
## 🖼️ Screenshots
![1](./assets/screenshots/app1.png)
<div align='center'>
![2](./assets/screenshots/app2.png) ## 🚀 Como usar (Instalação)
</div>
1. Vá até a seção **Releases** (ou clique no link de download fornecido).
2. Baixe o arquivo `WandEnhancer.exe` (ou o arquivo `.zip` disponibilizado).
3. *(Opcional)* Extraia o arquivo caso esteja zipado.
4. Execute o aplicativo dando um duplo clique.
* *Nota: Como o aplicativo é compilado de forma independente (não possui um certificado digital pago), o Windows Defender (SmartScreen) pode exibir um aviso de "Aplicativo não reconhecido". Basta clicar em "Mais informações" e depois em "Executar assim mesmo".*
## 💖 Créditos e Autoria
Este projeto só é possível graças à comunidade de código aberto. Todo o respeito e crédito são direcionados ao criador:
* **Criador e Desenvolvedor Original:** [k1tbyte](https://github.com/k1tbyte) - [Link para o Projeto Original](https://github.com/k1tbyte/wand-enhancer)
* **Responsável pela Compilação:** luanslimadev
--- ---
## 📜 License *Feito com ❤️ por k1tbyte | Compilado por luanslimadev*
This project is licensed under the Apache-2.0 - see the [LICENSE](LICENSE.md) file for details.
---
## ❤️ Support
If you find this project useful, you can support its development using any of the options below 🙌
[![Patreon](https://img.shields.io/badge/Patreon-donate-f96854.svg?logo=patreon)](https://www.patreon.com/kitbyte/gift)
[![USDT TRC20](https://img.shields.io/badge/USDT--TRC20-donate-26a17b.svg?logo=tether)](https://tronscan.org/#/address/TQdvau8pAy5Tg1Aa588tTcPCFgbcHtuoxc)
[![BTC](https://img.shields.io/badge/BTC-donate-f7931a.svg?logo=bitcoin)](https://www.blockchain.com/explorer/addresses/btc/1EZKDcyU8REm9JW5xwXJqSpn5Xaq5yAWWX)
[![ETH](https://img.shields.io/badge/ETH-donate-3c3c3d.svg?logo=ethereum)](https://etherscan.io/address/0xd904d9d0557f88bbb1c4ab3582b4ca0d8a730e8d)
---
> **Legal Disclaimer:**
> This project is a third-party enhancement tool intended solely for educational, research, and local interoperability purposes. It does not distribute any proprietary code or bypass server-side validations. All modifications are performed locally to customize the user's interface.
---
[![Star History Chart](https://api.star-history.com/svg?repos=k1tbyte/Wand-Enhancer&type=Date)](https://www.star-history.com/#k1tbyte/Wand-Enhancer&Date)