16 KiB

Raw Blame History

Eaglercraft 1.6.4

Play Minecraft 1.6.4 in your browser, currently only supports multiplayer

What is Eaglercraft?

Eaglercraft is real Minecraft 1.6.4 that you can play in any regular web browser. That includes school chromebooks, it works on all chromebooks. It currently only supports multiplayer.

Singleplayer?

You can self host a server (see the "How to make a server" section below), and connect to ws://localhost:25565 in your client and play one there, it will be essentially an integrated server but with extra steps. You're pretty much Shit Outta Luck if you're on a chromebook though.

Issues?

I got tired of closing duplicate 'how to maek sever' issues almost every day so I disabled it because honestly I don't really care anymore, join discord if you've got an issue to report that you are confident can be backed up with source code

How to make a server

If Gitpod/Github Codespaces are acceptable, you can use this:

https://github.com/catfoolyou/Eagler-Server-1.6.4

Check if Java is installed. You can download it from https://www.java.com/en/download/
Download the mp-server.zip file from this repository
Extract the ZIP file you downloaded to a new folder
Open the new folder, go into the java/bungee_command folder
In Windows, double-click run.bat. It should open a new terminal window

Some computers may just say 'run' instead of 'run.bat', both are correct
On macOS or Linux, google how to open the terminal and use the cd command to navigate to java/bungee_command
Then, in that folder, run chmod +x run_unix.sh and then run ./run_unix.sh. It should start the same server
Go to the other java/bukkit_command folder that was also extracted from the ZIP
On Windows, open a second terminal window and run java -jar craftbukkit-1.6.4-R2.0.jar Keep both the first and second terminal window you opened, just minimize them don't close
On macOS or Linux, repeat step 7 and run the same command
Your server is now ready. Download and open stable-download/Offline_Download_Version.html
Go to 'Multiplayer' from the main menu. Select 'Direct Connect', type 127.0.0.1:25565 and press 'Join Server'
It should allow you to connect, if not, check the two terminal windows for errors
If you are okay with regularly checking for updates to Offline_Download_Version.html, you are now finished
If you are playing with friends and want a shared website that can be updated, see the stable-download/web folder
To install, create a website and upload the contents of stable-download/web to the URL you want to have Eaglercraft on
The 'web' folder will not work if you open it in your browser locally! If you see 'file:///' in the URL you are doing it wrong. You need to upload the folder to an HTTP or HTTPS server and access it over the internet via http:// or https://. The game will not load otherwise, this is not a bug
To modify the list of default servers, modify the window.eaglercraftOpts variable in index.html.
A full guide on how to configure eaglercraftOpts is coming soon, but it should be fairly intuitive to figure out how to set it up based on what the default values already are when you look in stable-download
To create a link to your site that automatically joins the server, add a ?server= variable to the URL, like (for example): https://g.deev.is/eaglercraft/?server=127.0.0.1:25565 will automatically join ws://127.0.0.1:25565/ as soon as the player finishes setting their username and skin
To change your server's MOTD and icon, edit the motd1: tag of the listener config in java/bungee_command/config.yml, and replace server-icon.png in the folder where the config file is. Use & to add color/formatting codes. The server list will downscale your icon to 64x64 pixels
You can give your MOTD multiple lines, add a motd2: to define a second line
For an animated MOTD and icon, install EaglerMOTD: https://github.com/lax1dude/eaglercraft-motd/
To add some bukkit plugins, download the plugin's JAR file for CraftBukkit 1.6.4 and place it in java/bukkit_command/plugins
To add some bungee plugins, download the plugin's JAR file and place it in java/bungee_command/plugins
See https://github.com/lax1dude/eaglercraft-plugins/ to download some supported plugins
To disable voice chat, set voice_enabled: false in the bungeecord config.yml
To add /login and /register, install AuthMe and carefully read it's documentation to set it up correctly
To ban a username on Eaglercraftbungee, use: eag-ban <username>
To ban an IP on Eaglercraftbungee, use: eag-ban-ip <ip>, or eag-ban-ip <name> to ban the IP of a player automatically
To ban a range of IP addresses, use slash notation to define a subnet. Example: eag-ban-ip 192.168.0.0/8
To ban users by wildcard (*) use: eag-ban-wildcard <text>* or eag-ban-wildcard *<text> or eag-ban-wildcard *<text>*
You can edit bans.txt in your EaglercraftBungee folder, the server automatically reloads the file when it is saved
To ban users by regular expression, use: eag-ban-regex <regex> with a regular expression to match the username in lowercase
If you use /op on your server, keep in mind that if you "/op LAX1DUDE", a player joining as 'laX1DUDE' or 'LaX1dUdE' or 'lax1dude' will all have /op too. To solve this problem, force all operators to only be able to join with all lowercase ('lax1dude') letters in their usernames by moving 'BitchFilterPlugin.jar" into "java/bukkit_command/plugins" and then register every op username lowercase
To connect to your server through a ws:// or wss:// URL instead of ip:port, set up nginx as a reverse proxy to the ip:port of you EaglercraftBungee server you want the URL to connect to. Use a location URL template with the proxy_pass directive.
Eaglercraft uses port 80 for IP connections by default, typing 127.0.0.1 is the same as typing ws://127.0.0.1:80/
To forward a client's remote IP address from a request on nginx to EaglercraftBungee for enforcing IP bans, set the X-Real-IP header on the request to websocket when it is proxied
To make a custom resource pack for your site, clone this repository and edit the files in lwjgl-rundir/resources.
When you are done, navigate to epkcompiler/ and double-click run.bat. Wait for the window to say Press any key to continue... and close it. Then, go to ../javascript in the repository and copy javascript/assets.epk to the assets.epk on your website
If you're on mac or linux, run chmod +x CompileEPK.sh and then ./CompileEPK.sh to do this, then copy the same javascript/assets.epk to the assets.epk on your website

EaglercraftBungee

EaglercraftBungee translates WebSockets to a raw Minecraft 1.6.4 TCP connection. It is just regular BungeeCord with more config.yml options, and a built in plugin for syncing people's custom skins between clients so people can see each other's skins

If voice chat causes moderation problems, set `voice_enabled: false` in config.yml

To enable the /login and /register commands in EaglercraftBungee, you can edit this portion of config.yml

authservice:
  enabled: false
  register_enabled: true
  authfile: auths.db
  ip_limit: 0
  join_messages:
  - '&3Welcome to my &aEaglercraftBungee &3server!'
  login_timeout: 30

enable Turns login commands on and off
register_enabled Turns register command on and off
authfile Sets the authentication database file, which is compatible with AuthMe
ip_limit Sets the max number of registrations per IP, 0 = unlimited
join_messages List of messages to show the player when they join
login_timeout Sets how many seconds players have to log in before they are kicked

EaglercraftBungee has a built in domain blacklist that updates automatically, you can disable it by setting this in config.yml:

enable_web_origin_blacklist: false

To block all clients on replit from joining, set this to true in config.yml:

origin_blacklist_block_replit_clients: true

To block all offline-download clients, set this to true in config.yml:

origin_blacklist_block_offline_download: true

To block the debug runtime (or other desktop clients), set this to true in config.yml:

origin_blacklist_block_missing_origin_header: true

To add your own blacklisted domains, create a file called origin_blacklist.txt in your bungeecord directory and put the regular expressions inside, one on each line. There 's also a domain command in the console to view a player's domain, and a block-domain and block-domain-name and unblock-domain command to manage the local origin_blacklist.txt from the bungee console (if you don't know how to edit a file on your own). The list reloads automatically when changes to the file are detected.

To configure bungee to block connections from all clients except your own, set this option:

origin_blacklist_use_simple_whitelist: true

Then, add your domain to `origin_blacklist_simple_whitelist` like this:

origin_blacklist_simple_whitelist:
- type the name of your client's domain here

Then, unless still you want it as an option for your players, disable the offline download so hackers don't use it to bypass the whitelist, as it is not blocked in whitelist mode by default:

origin_blacklist_block_offline_download: true

To stop people from using bookmarklets to load a client from a different URL onto your official URL via XXS, add these headers to NGINX:

add_header X-Frame-Options "SAMEORIGIN";
add_header Referrer-Policy "strict-origin";
add_header X-XSS-Protection "1; mode=block";
add_header Content-Security-Policy "default-src 'self' 'unsafe-inline'; img-src 'self' 'unsafe-inline' data: blob:; connect-src 'self' ws: wss:; upgrade-insecure-requests";

(not fully tested, excuse the scroll bar)

To use IP bans and rate limiting, enable `forward_ip` and pass a X-Real-IP header from your proxy to the bungeecord's websocket port

Nginx example: add proxy_set_header X-Real-IP $remote_addr to your proxy configuration

The server has built in DoS protection, reset it via typing 'eag-ratelimit reset' in the bungee console

ratelimit:
  ip:
    enable: true
    period: 90
    limit: 60
    limit_lockout: 80
    lockout_duration: 1200
    exceptions: []

enable enable rate limiting
period and limit set the number of requests (limit) can be made in (period) number of seconds
limit_lockout and lockout_duration set the number of requests (limit_lockout) that can be made in (period) seconds before the IP is blocked for lockout_duration number of seconds
exceptions a list of IP addresses that should never get rate limited. Local IPs like 127.0.0.1 and 192.168.*.* and such are set as exceptions by default

you need forward_ip configured to use rate limiting, otherwise it will be disabled by default

Redirecting the client to a new WebSocket

If you would like to signal the client to disconnect from your bungeecord and reconnect to a different bungeecord, configure an entry in the servers part of config.yml like this:

test:
  redirect: wss://ServerHere/
  restricted: false

In this example, sending a player to the server test, such as when they enter a portal or type /server test, will trigger their client to disconnect from your bungeecord and then automatically reconnect to wss://ServerHere/ as if it was entered via "Direct Connect"

Plugin Development

To develop a plugin, download stable-download/java/bungee_command/bungee_dist.jar and add it to the Build Path of your Java IDE. Develop the plugin just like a regular BungeeCord plugin, see EaglerMOTD for an example.

Test your plugin by exporting it as a jar and putting it in the '/plugins' directory of EaglercraftBungee and then clicking 'run.bat'

New Events:

net.md_5.bungee.api.event.WebsocketMOTDEvent: Triggered when a client or website requests the MOTD
net.md_5.bungee.api.event.WebsocketQueryEvent: Triggered when a client or website requests a query. This happens when a site opens a text WebSocket to a listener and sends a single string Accept: <query> packet. Can be used to provide additional custom statistics to server list sites supporting integrated WebSocket queries

Register event handlers using the standard BungeeCord @EventHandler annotation in your Listener class

Hosting a LAN server relay

Simply download stable-download/sp-relay.jar and run `java -jar sp-relay.jar`

Run java -jar sp-relay.jar --debug to view debug info like all the IPs of incoming connections, as it is not shown by default because logging all that info will reduce performance when the relay is being pinged many times a second depending on it's popularity.

Edit the relayConfig.ini file generated on first launch to change the port and configure ratelimiting and such, and relays.txt to change the list of STUN and TURN relays reported to clients connecting to the relay, which are required to correctly establish a P2P LAN world connection in browsers

The origin-whitelist config variable is a semicolon (;) seperated list of domains used to restrict what sites are to be allowed to use your relay. When left blank it allows all sites. Add offline to allow offline download clients to use your relay as well, and null to allow connections that do not specify an Origin: header. Use * as a wildcard, for example: *.deev.is allows all domains ending with "deev.is" to use the relay.

Compiling

To compile for the web, run the gradle 'generateJavascript' compile target to generate the classes.js file.

The LWJGL runtime is supported, you will need to uncomment the lines //sourceSets.main.resources.srcDirs += 'src/lwjgl/java/javazoom/jl/decoder' and //implementation fileTree(dir: './lwjgl-rundir/', include: '*.jar') in build.gradle as well as changing "src/teavm/java" to "src/lwjgl/java" You will then need to run BuildUnpackDebugJar.sh (You're pretty much SOL on windows unless you want to compile it manually)

Contributing

All I really have to say is, tabs not spaces, and format the code to be like the eclipse auto format tool on factory settings, but also run-on lines of code long enough to go off the screen and single line if statements and other format violations in that category are welcome if it helps enhance the contrast between the less important code and the more important code in a file. Don't commit changes to javascript/classes.js or javascript/classes_server.js or javascript/assets.epk or anything in stable-download/. I'll recompile those myself when I merge the pull request.

16 KiB Raw Blame History