|
1 |
| -<img src="shadowsocks-csharp/Resources/ssw128.png" alt="[logo]" width="48"/> Shadowsocks for Windows |
2 |
| -======================= |
3 |
| - |
4 |
| -[![Build Status]][Appveyor] |
5 |
| - |
6 |
| -[中文说明] |
7 |
| - |
8 |
| -#### Features |
9 |
| - |
10 |
| -1. System proxy configuration |
11 |
| -2. PAC mode and global mode |
12 |
| -3. [GFWList] and user rules |
13 |
| -4. Supports HTTP proxy |
14 |
| -5. Supports server auto switching |
15 |
| -6. Supports UDP relay (see Usage) |
16 |
| -7. Supports plugins |
17 |
| - |
18 |
| -#### Download |
19 |
| - |
20 |
| -Download the latest release from [release page]. |
21 |
| - |
22 |
| -#### Requirements |
23 |
| - |
24 |
| -Microsoft [.NET Framework 4.6.2] or higher, Microsoft [Visual C++ 2015 Redistributable] (x86) . |
25 |
| - |
26 |
| -#### Basic |
27 |
| - |
28 |
| -1. Find Shadowsocks icon in the notification tray |
29 |
| -2. You can add multiple servers in servers menu |
30 |
| -3. Select `Enable System Proxy` menu to enable system proxy. Please disable other |
31 |
| -proxy addons in your browser, or set them to use system proxy |
32 |
| -4. You can also configure your browser proxy manually if you don't want to enable |
33 |
| -system proxy. Set Socks5 or HTTP proxy to 127.0.0.1:1080. You can change this |
34 |
| -port in `Servers -> Edit Servers` |
35 |
| - |
36 |
| -#### PAC |
37 |
| - |
38 |
| -1. You can change PAC rules by editing the PAC file. When you save the PAC file |
39 |
| -with any editor, Shadowsocks will notify browsers about the change automatically |
40 |
| -2. You can also update PAC file from [GFWList] \(maintained by 3rd party) |
41 |
| -3. You can also use online PAC URL |
42 |
| - |
43 |
| -#### Server Auto Switching |
44 |
| - |
45 |
| -1. Load balance: choosing server randomly |
46 |
| -2. High availability: choosing the best server (low latency and packet loss) |
47 |
| -3. Choose By Total Package Loss: ping and choose. Please also enable |
48 |
| - `Availability Statistics` in the menu if you want to use this |
49 |
| -4. Write your own strategy by implement IStrategy interface and send us a pull request! |
50 |
| - |
51 |
| -#### UDP |
52 |
| - |
53 |
| -For UDP, you need to use SocksCap or ProxyCap to force programs you want |
54 |
| -to be proxied to tunnel over Shadowsocks |
55 |
| - |
56 |
| -#### Multiple Instances |
57 |
| - |
58 |
| -If you want to manage multiple servers using other tools like SwitchyOmega, |
59 |
| -you can start multiple Shadowsocks instances. To avoid configuration conflicts, |
60 |
| -copy Shadowsocks to a new directory and choose a different local port. |
61 |
| - |
62 |
| -#### Plugins |
63 |
| - |
64 |
| -If you would like to connect to server via a plugin, please set the plugin's |
65 |
| -path (relative or absolute) on Edit Servers form. |
66 |
| -_Note_: Forward Proxy will not be used while a plugin is enabled. |
67 |
| - |
68 |
| -#### Global hotkeys |
69 |
| - |
70 |
| -Hotkeys could be registered automatically on startup. |
71 |
| -If you are using multiple instances of Shadowsocks, |
72 |
| -you must set different key combination for each instance. |
73 |
| - |
74 |
| -##### How to input? |
75 |
| - |
76 |
| -1. Put focus in the corresponding textbox. |
77 |
| -2. Press the key combination that you want to use. |
78 |
| -3. Release all keys when you think it is ready. |
79 |
| -4. Your input appears in the textbox. |
80 |
| - |
81 |
| -##### How to change? |
82 |
| - |
83 |
| -1. Put focus in the corresponding textbox. |
84 |
| -2. Press BackSpace key to clear content. |
85 |
| -3. Re-input new key combination. |
86 |
| - |
87 |
| -##### How to deactivate? |
88 |
| - |
89 |
| -1. Clear content in the textbox that you want to deactivate, |
90 |
| -if you want to deactivate all, please clear all textboxes. |
91 |
| -2. Press OK button to confirm. |
92 |
| - |
93 |
| -##### Meaning of label color |
94 |
| - |
95 |
| -- Green: This key combination is not occupied by other programs and register successfully. |
96 |
| -- Yellow: This key combination is occupied by other programs and you have to change to another one. |
97 |
| -- Transparent without color: The initial status. |
98 |
| - |
99 |
| -#### Server Configuration |
100 |
| - |
101 |
| -Please visit [Servers] for more information. |
102 |
| - |
103 |
| -#### Development |
104 |
| - |
105 |
| -1. [Visual Studio 2015] & [.NET Framework 4.6.2 Developer Pack] are required. |
106 |
| -2. It is recommended to share your idea on the Issue Board before you start to work, |
107 |
| -especially for feature development. |
108 |
| - |
109 |
| -#### License |
110 |
| - |
111 |
| -[GPLv3] |
112 |
| - |
113 |
| -#### Open Source Components / Libraries |
114 |
| - |
115 |
| -``` |
116 |
| -Caseless.Fody (MIT) https://github.com/Fody/Caseless |
117 |
| -Costura.Fody (MIT) https://github.com/Fody/Costura |
118 |
| -Fody (MIT) https://github.com/Fody/Fody |
119 |
| -GlobalHotKey (GPLv3) https://github.com/kirmir/GlobalHotKey |
120 |
| -Newtonsoft.Json (MIT) https://www.newtonsoft.com/json |
121 |
| -StringEx.CS () https://github.com/LazyMode/StringEx |
122 |
| -ZXing.Net (Apache 2.0) https://github.com/micjahn/ZXing.Net |
123 |
| -
|
124 |
| -libsscrypto (GPLv2) https://github.com/shadowsocks/libsscrypto |
125 |
| -Privoxy (GPLv2) https://www.privoxy.org |
126 |
| -Sysproxy () https://github.com/Noisyfox/sysproxy |
127 |
| -``` |
128 |
| - |
129 |
| - |
130 |
| - |
131 |
| -[Appveyor]: https://ci.appveyor.com/project/celeron533/shadowsocks-windows |
132 |
| -[Build Status]: https://ci.appveyor.com/api/projects/status/tfw57q6eecippsl5/branch/master?svg=true |
133 |
| -[release page]: https://github.com/shadowsocks/shadowsocks-csharp/releases |
134 |
| -[GFWList]: https://github.com/gfwlist/gfwlist |
135 |
| -[Servers]: https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#linux--server-side |
136 |
| -[中文说明]: https://github.com/shadowsocks/shadowsocks-windows/wiki/Shadowsocks-Windows-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E |
137 |
| -[Visual Studio 2015]: https://www.visualstudio.com/downloads/ |
138 |
| -[.NET Framework 4.6.2]: https://www.microsoft.com/en-US/download/details.aspx?id=53344 |
139 |
| -[.NET Framework 4.6.2 Developer Pack]: https://www.microsoft.com/download/details.aspx?id=53321 |
140 |
| -[Visual C++ 2015 Redistributable]: https://www.microsoft.com/en-us/download/details.aspx?id=53840 |
141 |
| -[GPLv3]: https://github.com/shadowsocks/shadowsocks-windows/blob/master/LICENSE.txt |
| 1 | +<img src="shadowsocks-csharp/Resources/ssw128.png" alt="[logo]" width="48"/> Shadowsocks for Windows |
| 2 | +======================= |
| 3 | + |
| 4 | +[![Build Status]][Appveyor] |
| 5 | + |
| 6 | +[中文说明] |
| 7 | + |
| 8 | +#### Features |
| 9 | + |
| 10 | +1. System proxy configuration |
| 11 | +2. PAC mode and global mode |
| 12 | +3. [GFWList] and user rules |
| 13 | +4. Supports HTTP proxy |
| 14 | +5. Supports server auto switching |
| 15 | +6. Supports UDP relay (see Usage) |
| 16 | +7. Supports plugins |
| 17 | + |
| 18 | +#### Download |
| 19 | + |
| 20 | +Download the latest release from [release page]. |
| 21 | + |
| 22 | +#### Requirements |
| 23 | + |
| 24 | +Microsoft [.NET Framework 4.6.2] or higher, Microsoft [Visual C++ 2015 Redistributable] (x86) . |
| 25 | + |
| 26 | +#### Basic |
| 27 | + |
| 28 | +1. Find Shadowsocks icon in the notification tray |
| 29 | +2. You can add multiple servers in servers menu |
| 30 | +3. Select `Enable System Proxy` menu to enable system proxy. Please disable other |
| 31 | +proxy addons in your browser, or set them to use system proxy |
| 32 | +4. You can also configure your browser proxy manually if you don't want to enable |
| 33 | +system proxy. Set Socks5 or HTTP proxy to 127.0.0.1:1080. You can change this |
| 34 | +port in `Servers -> Edit Servers` |
| 35 | + |
| 36 | +#### PAC |
| 37 | + |
| 38 | +1. You can change PAC rules by editing the PAC file. When you save the PAC file |
| 39 | +with any editor, Shadowsocks will notify browsers about the change automatically |
| 40 | +2. You can also update PAC file from [GFWList] \(maintained by 3rd party) |
| 41 | +3. You can also use online PAC URL |
| 42 | + |
| 43 | +#### Server Auto Switching |
| 44 | + |
| 45 | +1. Load balance: choosing server randomly |
| 46 | +2. High availability: choosing the best server (low latency and packet loss) |
| 47 | +3. Choose By Total Package Loss: ping and choose. Please also enable |
| 48 | + `Availability Statistics` in the menu if you want to use this |
| 49 | +4. Write your own strategy by implement IStrategy interface and send us a pull request! |
| 50 | + |
| 51 | +#### UDP |
| 52 | + |
| 53 | +For UDP, you need to use SocksCap or ProxyCap to force programs you want |
| 54 | +to be proxied to tunnel over Shadowsocks |
| 55 | + |
| 56 | +#### Multiple Instances |
| 57 | + |
| 58 | +If you want to manage multiple servers using other tools like SwitchyOmega, |
| 59 | +you can start multiple Shadowsocks instances. To avoid configuration conflicts, |
| 60 | +copy Shadowsocks to a new directory and choose a different local port. |
| 61 | + |
| 62 | +#### Plugins |
| 63 | + |
| 64 | +If you would like to connect to server via a plugin, please set the plugin's |
| 65 | +path (relative or absolute) on Edit Servers form. |
| 66 | +_Note_: Forward Proxy will not be used while a plugin is enabled. |
| 67 | + |
| 68 | +Details: |
| 69 | +[Working with non SIP003 standard Plugin]. |
| 70 | + |
| 71 | +#### Global hotkeys |
| 72 | + |
| 73 | +Hotkeys could be registered automatically on startup. |
| 74 | +If you are using multiple instances of Shadowsocks, |
| 75 | +you must set different key combination for each instance. |
| 76 | + |
| 77 | +##### How to input? |
| 78 | + |
| 79 | +1. Put focus in the corresponding textbox. |
| 80 | +2. Press the key combination that you want to use. |
| 81 | +3. Release all keys when you think it is ready. |
| 82 | +4. Your input appears in the textbox. |
| 83 | + |
| 84 | +##### How to change? |
| 85 | + |
| 86 | +1. Put focus in the corresponding textbox. |
| 87 | +2. Press BackSpace key to clear content. |
| 88 | +3. Re-input new key combination. |
| 89 | + |
| 90 | +##### How to deactivate? |
| 91 | + |
| 92 | +1. Clear content in the textbox that you want to deactivate, |
| 93 | +if you want to deactivate all, please clear all textboxes. |
| 94 | +2. Press OK button to confirm. |
| 95 | + |
| 96 | +##### Meaning of label color |
| 97 | + |
| 98 | +- Green: This key combination is not occupied by other programs and register successfully. |
| 99 | +- Yellow: This key combination is occupied by other programs and you have to change to another one. |
| 100 | +- Transparent without color: The initial status. |
| 101 | + |
| 102 | +#### Server Configuration |
| 103 | + |
| 104 | +Please visit [Servers] for more information. |
| 105 | + |
| 106 | +#### Development |
| 107 | + |
| 108 | +1. [Visual Studio 2015] & [.NET Framework 4.6.2 Developer Pack] are required. |
| 109 | +2. It is recommended to share your idea on the Issue Board before you start to work, |
| 110 | +especially for feature development. |
| 111 | + |
| 112 | +#### License |
| 113 | + |
| 114 | +[GPLv3] |
| 115 | + |
| 116 | +#### Open Source Components / Libraries |
| 117 | + |
| 118 | +``` |
| 119 | +Caseless.Fody (MIT) https://github.com/Fody/Caseless |
| 120 | +Costura.Fody (MIT) https://github.com/Fody/Costura |
| 121 | +Fody (MIT) https://github.com/Fody/Fody |
| 122 | +GlobalHotKey (GPLv3) https://github.com/kirmir/GlobalHotKey |
| 123 | +Newtonsoft.Json (MIT) https://www.newtonsoft.com/json |
| 124 | +StringEx.CS () https://github.com/LazyMode/StringEx |
| 125 | +ZXing.Net (Apache 2.0) https://github.com/micjahn/ZXing.Net |
| 126 | +
|
| 127 | +libsscrypto (GPLv2) https://github.com/shadowsocks/libsscrypto |
| 128 | +Privoxy (GPLv2) https://www.privoxy.org |
| 129 | +Sysproxy () https://github.com/Noisyfox/sysproxy |
| 130 | +``` |
| 131 | + |
| 132 | + |
| 133 | + |
| 134 | +[Appveyor]: https://ci.appveyor.com/project/celeron533/shadowsocks-windows |
| 135 | +[Build Status]: https://ci.appveyor.com/api/projects/status/tfw57q6eecippsl5/branch/master?svg=true |
| 136 | +[release page]: https://github.com/shadowsocks/shadowsocks-csharp/releases |
| 137 | +[GFWList]: https://github.com/gfwlist/gfwlist |
| 138 | +[Servers]: https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#linux--server-side |
| 139 | +[中文说明]: https://github.com/shadowsocks/shadowsocks-windows/wiki/Shadowsocks-Windows-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E |
| 140 | +[Visual Studio 2015]: https://www.visualstudio.com/downloads/ |
| 141 | +[.NET Framework 4.6.2]: https://www.microsoft.com/en-US/download/details.aspx?id=53344 |
| 142 | +[.NET Framework 4.6.2 Developer Pack]: https://www.microsoft.com/download/details.aspx?id=53321 |
| 143 | +[Visual C++ 2015 Redistributable]: https://www.microsoft.com/en-us/download/details.aspx?id=53840 |
| 144 | +[GPLv3]: https://github.com/shadowsocks/shadowsocks-windows/blob/master/LICENSE.txt |
| 145 | +[Working with non SIP003 standard Plugin]: https://github.com/shadowsocks/shadowsocks-windows/wiki/Working-with-non-SIP003-standard-Plugin |
0 commit comments