From b3923fb50ed439829d81cb3d02593da3a400c48d Mon Sep 17 00:00:00 2001 From: FlamedDogo99 <96555444+FlamedDogo99@users.noreply.github.com> Date: Sat, 8 Jun 2024 10:41:01 -0600 Subject: [PATCH] Update README.md Added more usage instructions and examples --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fde1f14..deb46d9 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ## About -Eagler Mobile brings new functionality and benefits for the EaglerCraft web client by providing mobile-friendly touch controls, keyboard access, and other settings configirable through the EaglerCraft client. +Eagler Mobile brings new functionality and benefits for the EaglerCraft web client by providing mobile-friendly touch controls, keyboard access, and other settings configurable through the EaglerCraft client.
@@ -19,6 +19,37 @@ Eagler Mobile brings new functionality and benefits for the EaglerCraft web clie The easiest way to use Eagler Mobile is to use a userscript application such as Greasemonkey, however since Eagler Mobile is plain JavaScript you can easily deploy it in other ways as well. As an example we've included `eaglermobile.ef.js` which can be run as a mod on [EaglerForge](https://github.com/eaglerforge/EaglerForge). +
+See more examples + +--- + +1. **Self hosted** + +If you are hosting the EaglerCraft client on your own server, you can include the mobile script in the `index.html` folder as a script. + +```js + + +``` + +2. **Other userscript applications** + +Non-mobile browsers: + - Chrome, FireFox, Safari, Edge, Opera Next, Microsoft Edge: [Tampermonkey](https://www.tampermonkey.net) + +iOS: +- Safari: [Userscripts](https://apps.apple.com/us/app/userscripts/id1463298887) +- Orion: [Tampermonkey](https://www.tampermonkey.net) + +Android: +- FireFox: [Tampermonkey](https://www.tampermonkey.net) +- Kiwi Browser: [Tampermonkey](https://www.tampermonkey.net) + +--- + +
+ If you want to download the source, no building is required. The best way to download the source is with Git: ```sh