Loading repository data…
Loading repository data…
Aethersailor / repository
A comprehensive OpenClash subscription conversion template and a well-designed OpenClash configuration example that deliver precise traffic routing, DNS with no poisoning or leaks, and fast access to both domestic and international websites—without relying on additional plugins. Includes an automated domain rule submission bot.
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
Custom_OpenClash_Rules is a resource repository built around OpenClash.
It provides OpenClash configuration guidance, subscription-conversion templates, YAML examples, rule fragments, utility scripts, override resources, and related documentation to make OpenClash easier to deploy, maintain, and adjust.
The root README serves only as the project homepage and resource navigator. For individual files, their purposes, differences, and usage instructions, refer to the README in the corresponding directory or the project Wiki.
[!NOTE] The project Wiki is currently available in Chinese only.
| Need | Recommended entry |
|---|---|
| Configure or understand OpenClash for the first time | Project Wiki |
| Use subscription-conversion templates or YAML examples | cfg/ |
| Add rules to an existing configuration | rule/ |
| Use OpenClash-related utility scripts | shell/ |
| Use remote override resources | overwrite/ |
| Troubleshoot common problems | Troubleshooting |
The project Wiki is one of the repository's two core components. It provides a complete configuration approach for OpenWrt and OpenClash rather than merely listing individual settings. The documentation explains how related options interact, why they are configured, and what effects they may have, helping users deploy and maintain OpenClash with an understanding of the underlying design.
The guide follows the practical OpenClash workflow and focuses on:
Fake-IPThe overall approach is designed to rely primarily on OpenClash's own capabilities and avoid unnecessary stacks of DNS plugins. Most operations can be completed through the OpenClash LuCI interface. The Wiki can therefore serve both as a first-time setup guide and as a reference for later troubleshooting and configuration optimization.
[!TIP] New users should read the Wiki before selecting a configuration resource below. The Wiki explains why the settings are designed this way, while the configuration resources provide reusable implementations.
Entry: Project Wiki
The cfg/ directory is the repository's other core component. It converts the configuration approach described in the Wiki into reusable resources. The directory contains subscription-conversion templates, YAML configuration examples, and supporting documentation for users who want to generate an OpenClash configuration quickly or adapt an existing configuration.
These resources focus on:
Fake-IP, DNS strategy, direct access, and rule-based routing so they can be used together with the project Wiki.The root README does not enumerate individual templates or configuration files. Refer to the README in cfg/ for each configuration's purpose, differences, usage links, and precautions.
Entry: cfg/
Rule fragments that can be added selectively to an existing configuration. General and game-related rules are treated as a single resource category; consult the directory documentation for their classification and usage.
Entry: rule/
Scripts related to OpenClash installation, updates, detection, and maintenance.
Entry: shell/
Resources and documentation for OpenClash remote overrides. This directory references an externally maintained project; consult its directory documentation and upstream repository for details.
Entry: overwrite/
This repository primarily targets OpenWrt and OpenClash environments. It does not provide general-purpose configuration support for other clients or operating systems.
The project is a collection of the maintainer's personal experience and technical materials. It does not provide customized configurations, bespoke development, or one-to-one technical support.
For a small number of direct-access domains, using OpenClash custom rules is recommended first.
Domains suitable for inclusion in this project may be submitted through GitHub Issues, Pull Requests, or COCR RULE BOT.
[!NOTE] Where appropriate, the maintainer may submit collected entries to relevant upstream rule projects.
[!WARNING] Usage Notice:
- This project is intended solely for technical study and research concerning the OpenWrt operating system and its OpenClash plugin. Its content consists of neutral technical implementation examples and experimental materials and is not directed toward any specific use case or purpose.
- Before accessing, using, or copying any content from this project, users must independently confirm that doing so is permitted by the laws and regulations of their location and all relevant jurisdictions. The relevant content must be deleted within 24 hours after study and research.
- This project's content must not be used for any purpose that violates applicable laws or regulations. Users must independently comply with the laws and regulations of their location and all relevant jurisdictions, including those of the People's Republic of China. Within the territory of the People's Republic of China, this project's content must not be used to obtain or disseminate unlawful information from outside the country whose access or distribution is legally restricted or blocked, or to engage in similar conduct.
- This project neither provides nor concerns any equipment, software, tools, network connections, or services. The project maintainer does not produce, sell, or provide related equipment, software, tools, or technical services, nor does the maintainer provide technical support, assistance, or any other form of help to any individual or organization for obtaining or disseminating information whose access or distribution is legally restricted or blocked, or for circumventing regulatory systems.
- Any individual or organization is solely responsible for conduct arising from its direct or indirect use of this project's content and bears all corresponding legal liability. The project maintainer does not participate in users' specific conduct and assumes no responsibility for their purposes, methods, or resulting consequences, including joint and several liability of any kind.
- Any modification, secondary development, integration, distribution, or other derivative activity based on this project's content is the independent act of the relevant individual or organization and is unrelated to this project or its maintainer. Any resulting legal liability is borne solely by the party performing such activity.
- This project discourages any form of reproduction, republication, or secondary dissemination. Reproducing, republishing, or redistributing this project's content on any platform within mainland China is strictly prohibited.
- No reproduction, republication, or secondary dissemination may imply endorsement of the reproduced content by this project or its maintainer. Any legal risk arising from the reproduction, dissemination, or use of this project's content is borne solely by the party performing the relevant act and is unrelated to this project or its maintainer.
- The project maintainer reserves the right to revise or supplement this disclaimer at any time. Any individual or organization that uses, copies, or accesses this project's content is deemed to have read and accepted this disclaimer.
[!NOTE]
- This project was created in April 2024 as a non-profit collection of technical research and practical experience.
- The content reflects only the maintainer's personal experience. It is intended for technical exchange, is not authoritative, and does not represent the only or officially recommended way to use OpenClash.
- This project does not operate any YouTube channel and has not published tutorials or instructional videos on YouTube or any other video platform.
- This project's content was not compiled or adapted from third-party tutorials or videos. Problems caused by tutorials, templates, or configuration files fr