Merge pull request #2 from 2004sp/254-SD

Updates from SD

Author: gradwahl

.gitignore

@@ -0,0 +1 @@
+target/Progressive-Java-Client.jar

README.md

@@ -1,43 +1,41 @@
-# Java 254 Client
+# Progressive Java Client
 
-Full RS2 build-254 client With Native OpenGL-lwjgl
+Early Java desktop client for a LostCityRS / 2004SP revision 254+ servers.
 
-## Build
-
-```bat
-build.bat
-```
-
-Or with PowerShell:
-
-```powershell
-.\build.ps1
-```
+## Current status
 
-Requires JDK 17+.
+Implemented so far:
 
-The generated `target/Progressive-Java-Client.jar` is standalone: it contains the
-required libraries and native binaries, and can be copied elsewhere by itself.
+- Revision `254` configuration
+- Swing desktop window
+- 765x503 game canvas
+- 50 TPS game loop
+- WebSocket connection to the game server
+- `/crc` cache checksum loading
+- 254 login handshake using opcodes `14`, `16`, and `18`
+- ISAAC cipher setup
+- Client/server protocol constants
+- Test login UI
 
-You can also build with Maven:
+Not implemented yet:
 
-```powershell
-mvn clean package
-```
+- 117HD-style rendering port
+- HD terrain lighting and shading
+- HD textures and normal maps
+- Water, lava, and animated surface effects
+- Improved skybox/fog/atmosphere rendering
+- Modern GPU-based scene rendering
+- 60 FPS animation/camera support while keeping server TPS compatible
+- True resizable and fullscreen client modes
+- Original 765x503 fixed-mode compatibility
 
-The standalone JAR is written to `target/`.
+## Requirements
 
-## Run
+- Java 17+
+- Maven
+- A compatible LostCity/2004Scape revision 254 server running locally or remotely (Progressive strongly advised)
 
-```bat
-run.bat
-```
-
-Using `run.bat` is recommended because it supplies the Java options used by
-LWJGL and starts the client with the default server settings.
-
-You can also launch the generated JAR or a GitHub Release JAR directly:
+## Build
 
-```powershell
-java -jar Progressive-Java-Client.jar
-```
+```bash
+mvn package