Contributions to Eaglercraft are welcome. The project was originally created by lax1dude and is currently maintained by ayunami2000. Follow these guidelines when submitting pull requests to ensure your changes can be merged smoothly.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/lDEVinux/eaglercraft/llms.txt
Use this file to discover all available pages before exploring further.
Code Style
Eaglercraft follows a deliberate formatting approach designed to make important logic stand out from boilerplate:- Use tabs for indentation — not spaces
- Format code as the Eclipse auto-format tool on factory settings would produce
- Run-on lines that extend off-screen are acceptable when they help de-emphasize less important code
- Single-line
ifstatements and similar compact forms are welcome when they enhance the visual contrast between routine scaffolding and meaningful logic - The goal of formatting is to make important code immediately visible — boilerplate should recede into the background
What to Include in PRs
DO include
Java source changes in
src/main/java, src/teavm/java, sp-server/src/, eaglercraftbungee/src/, or sp-relay/src/DO NOT include
Compiled output:
javascript/classes.js, javascript/classes_server.js, javascript/assets.epk, or anything inside stable-download/The maintainer recompiles all generated files after merging pull requests. Only submit source code changes — committing compiled artifacts will cause your PR to be rejected or require cleanup before merge.
Repository Structure
| Directory | Contents |
|---|---|
src/main/java/ | Shared game source (Minecraft client classes) |
src/teavm/java/ | TeaVM-specific adapter and entry point |
src/lwjgl/ | LWJGL desktop adapter (reference only, unsupported) |
sp-server/src/ | Integrated singleplayer server source |
eaglercraftbungee/src/ | EaglercraftBungee (WebSocket proxy) source |
sp-relay/src/ | LAN relay server source |
epkcompiler/ | EPK asset pack compiler |
lwjgl-rundir/resources/ | Game assets (textures, sounds) |
javascript/ | Compiled output (do not commit changes) |
stable-download/ | Pre-built release artifacts (do not commit changes) |
Verifying Repository Authenticity
The repository includes a PGP-signed checksum file to help you confirm you have a genuine, unmodified copy of the source. To verify:- Run
GetRepositorySignature.bat(Windows) orGetRepositorySignature.sh(Linux/macOS) from the repository root - Compare the SHA-256 hash it produces against the value recorded in
LAX1DUDE_SIGNATURE.txt - Optionally verify the PGP signature itself using lax1dude’s public key, available at https://deev.is/certs/LAX1DUDE_eagler_public.asc
LAX1DUDE_SIGNATURE.txt is not present in a copy of the repository, that copy should not be trusted.
Contact
Discord
Join the community Discord for questions, discussion, and development help.
GitHub
Submit issues and pull requests on GitHub.