Skip to content

Commit bac2884

Browse files
rom1504claude
andcommitted
Remove redundant proxy examples from API.md
- Keep documentation concise by referencing example folder - Avoid duplication with examples/client_builtin_proxy/ 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent ec077d4 commit bac2884

File tree

1 file changed

+1
-36
lines changed

1 file changed

+1
-36
lines changed

docs/API.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -161,42 +161,7 @@ Returns a `Client` instance and perform login.
161161

162162
### Proxy Support
163163

164-
The `proxy` option allows connecting to Minecraft servers through SOCKS4, SOCKS5, HTTP, or HTTPS proxies. This feature integrates seamlessly with authentication and supports SRV record resolution.
165-
166-
Example usage:
167-
168-
```javascript
169-
const mc = require('minecraft-protocol')
170-
171-
// SOCKS5 proxy with authentication
172-
const client = mc.createClient({
173-
host: 'play.hypixel.net',
174-
username: 'player',
175-
auth: 'microsoft',
176-
proxy: {
177-
type: 'socks5',
178-
host: '127.0.0.1',
179-
port: 1080,
180-
auth: {
181-
username: 'proxyuser',
182-
password: 'proxypass'
183-
}
184-
}
185-
})
186-
187-
// HTTP proxy without authentication
188-
const client2 = mc.createClient({
189-
host: 'localhost',
190-
port: 25565,
191-
username: 'player',
192-
auth: 'offline',
193-
proxy: {
194-
type: 'http',
195-
host: 'proxy.example.com',
196-
port: 8080
197-
}
198-
})
199-
```
164+
The `proxy` option allows connecting to Minecraft servers through SOCKS4, SOCKS5, HTTP, or HTTPS proxies. This feature integrates seamlessly with authentication and supports SRV record resolution. See the `examples/client_builtin_proxy/` folder for usage examples.
200165

201166
## mc.Client(isServer,version,[customPackets])
202167

0 commit comments

Comments
 (0)