3rdparty/flameddogo99-eaglermobile
1
0
Fork 0
mirror of https://github.com/FlamedDogo99/EaglerMobile.git synced 2024-11-09 14:06:05 -08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Added more usage instructions and examples
This commit is contained in:
FlamedDogo99 2024-06-08 10:41:01 -06:00 committed by GitHub
parent c7dcb89a6a
commit b3923fb50e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -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.
<div align="center">
@ -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).
<details>
<summary>See more examples</summary>
---
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
<script type="text/javascript" src="yourDirectory/eaglermobile.user.js"></script>
```
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)
---
</details>
If you want to download the source, no building is required. The best way to download the source is with Git:
```sh