Update README.md

This commit is contained in:
q13x 2024-03-27 20:11:06 -07:00 committed by GitHub
parent db141cc206
commit 64b731f18c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -44,8 +44,6 @@ Remove all the folders in `src/plugins`.
#### IMPORTANT: READ ME BEFORE USING #### IMPORTANT: READ ME BEFORE USING
**IMPORTANT:** Although the vanilla Eaglercraft client is a safe, modified copy of Minecraft AOT-compiled to JavaScript, I cannot guarantee that you **will not get flagged by all anticheats.** While gameplay and testing has shown to be relatively stable and free of anticheat flags, more testing is needed to derive a conclusion on whether or not using EaglerProxy with EagProxyAAS is safe.
EaglerProxy and EagProxyAAS: EaglerProxy and EagProxyAAS:
- is compatible with EaglercraftX and uses its handshake system, - is compatible with EaglercraftX and uses its handshake system,
@ -60,10 +58,6 @@ EaglerProxy and EagProxyAAS does NOT:
- Unmodified versions will not maliciously handle your login data, although a modified version has the ability to do so. Only use trusted and unmodified versions of both this plugin and proxy. - Unmodified versions will not maliciously handle your login data, although a modified version has the ability to do so. Only use trusted and unmodified versions of both this plugin and proxy.
- and intentionally put your account at risk. - and intentionally put your account at risk.
Remember, open source software is never 100% safe. Read what you run on your computer.
### Plugin Development
### Disclaimer ### Disclaimer
The proxy's software utilizes its own plugin API written in JavaScript, rather than BungeeCord's plugin API. For this reason, plugins written for the official BungeeCord plugin will **not** work on this proxy. Below are some instructions for making your very own EaglerProxy plugin. The proxy's software utilizes its own plugin API written in JavaScript, rather than BungeeCord's plugin API. For this reason, plugins written for the official BungeeCord plugin will **not** work on this proxy. Below are some instructions for making your very own EaglerProxy plugin.
@ -91,7 +85,7 @@ As of right now, there exists no API reference. Please refer to the preinstalled
## Reporting Issues ## Reporting Issues
**NOTE:** Issues asking for help will be converted into discussions. You are expected to have **thoroughly** read all documentation prior to asking for help. **NOTE:** Issues asking for help will be converted into discussions. You are expected to have **thoroughly** read all documentation prior to asking for help, and expect no help if you have not done so.
- Security-related bugs/issues: Directly contact me on Discord (check my profile). - Security-related bugs/issues: Directly contact me on Discord (check my profile).
- Non-security-related bugs/issues: Open a new issue, with the following: - Non-security-related bugs/issues: Open a new issue, with the following: