summaryrefslogtreecommitdiff
path: root/README.md
blob: de9f48a4c68c583022b712c808fd61dcdbc15889 (plain)
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
# Transparent Zen

Transparent Zen is a browser extension specifically designed for Zen Browser. This extension injects styles into supported websites to make them transparent, providing a new experience.

<a href="https://addons.mozilla.org/de/firefox/addon/transparent-zen">
    <img alt="Firefox Add-Ons" src="https://blog.mozilla.org/addons/files/2015/11/get-the-addon.png" height="40">
</a>

## Table of Contents

- [Transparent Zen](#transparent-zen)
- [Supported Websites](#supported-websites)
- [Prerequisites](#prerequisites)
    - [Windows 11](#windows-11)
- [Installation](#installation)
    - [Dark Reader](#dark-reader)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Supported Websites
🔴 = Not working / Broken
<br>
🟠 = Work in Progress
<br>
🟢 = Working

The following websites are currently supported by Transparent Zen:

- 🟠 amazon.de
- 🟠 bing.com
- 🟢 ddl-warez.cc
- 🔴 epicgames.com
- 🔴 github.com
- 🔴 gog.com
- 🔴 kinguin.net
- 🟠 kryptex.com
- 🟠 lieferando.at
- 🟢 mail.proton.me
- 🟠 nexusmods.com
- 🟢 reddit.com
- 🟢 store.steamworks.com
- 🟢 steamcommunity.com
- 🟢 wuwatracker.com
- 🟢 youtube.com

## Prerequisites
#### Windows 11
1. Install [MicaForEveryone](https://github.com/MicaForEveryone/MicaForEveryone)
2. In MicaForEveryone add a new process rule and select "zen"
3. Activate **Blur Behind** and set the Backdrop Type to **Acrylic**
4. Open Zen Browser and go to `about:config`
5. Make sure that `browser.tabs.allow_transparent_browser` is set to **true**
6. Also make sure that `browser.tabs.allow_transparent_browser` is set to **true**

##### TODO: Add other OS prerequisites

## Installation

To install Transparent Zen, you can either download it from the [Firefox Add-Ons Store](https://addons.mozilla.org/de/firefox/addon/transparent-zen) or grab the latest release from github and manually install it through the Zen Browser settings.

#### Dark Reader
If you are using Dark Reader, ensure that it is disabled for the websites you want to view as transparent.

## Usage

Once installed, Transparent Zen will automatically apply transparent styles to the supported websites listed above. No further configuration is required.

## Contributing

The main idea behind this project is for the community to contribute and add styles for their favorite websites, so that everyone can enjoy a fully transparent experience.
<br>
If you would like to contribute to Transparent Zen, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with a descriptive message.
4. Push your changes to your fork and create a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

Enjoy your transparent browsing experience with Transparent Zen!