Merge develop

.dockerignore

@@ -0,0 +1 @@
+.github/

.gitattributes

@@ -1,3 +1,5 @@
+/gradlew        text eol=lf
+
 # These are explicitly windows files and should use crlf
 *.bat           text eol=crlf
 

.github/workflows/build.yml

@@ -16,11 +16,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3.3.0
+    - uses: actions/checkout@v4.1.4
     - name: Checkout submodules
       run: git submodule update --init --recursive
     - name: Set up JDK 8
-      uses: actions/setup-java@v3.6.0
+      uses: actions/setup-java@v4.2.1
       with:
         java-version: '8'
         distribution: 'adopt'
@@ -29,8 +29,8 @@ jobs:
     - name: Build with Gradle
       run: ./gradlew dist
     - name: Upload artifact
-      uses: actions/upload-artifact@v3.1.1
+      uses: actions/upload-artifact@v4.3.3
       with:
         name: brainwine
-        path: build/libs/brainwine.jar
+        path: build/dist/brainwine.jar
         retention-days: 7

.gitignore

@@ -1,6 +1,7 @@
 # Gradle
 .gradle
 build
+!**/src/**/build
 
 # Eclipse
 *.launch
@@ -11,4 +12,4 @@ build
 bin
 
 # Misc
-run
+run

Dockerfile

@@ -0,0 +1,27 @@
+#? Builder
+FROM --platform=$BUILDPLATFORM debian:bookworm-slim AS builder
+RUN apt update -y && apt upgrade -y && apt autoremove -y
+RUN apt install -y git gradle
+WORKDIR /src
+COPY . /src
+RUN git submodule init && git submodule update
+RUN chmod +x gradlew && ./gradlew dist
+
+#? Runner
+FROM --platform=$BUILDPLATFORM amazoncorretto:22-alpine-jdk AS runner
+RUN apk update && apk upgrade
+VOLUME ["/data"]
+WORKDIR /data
+COPY --from=builder /src/build/dist /app
+ARG GATEWAY_PORT=5001
+ARG SERVER_PORT=5002
+ARG PORTAL_PORT=5003
+EXPOSE $GATEWAY_PORT $SERVER_PORT $PORTAL_PORT
+CMD ["sh", "-c", "java -jar /app/brainwine.jar disablegui"]
+
+LABEL org.opencontainers.image.title="Brainwine"
+LABEL org.opencontainers.image.description=" A portable private server for Deepworld."
+LABEL org.opencontainers.image.source="https://github.com/kuroppoi/brainwine"
+LABEL org.opencontainers.image.licenses="MIT"
+LABEL org.opencontainers.image.documentation="https://github.com/kuroppoi/brainwine"
+LABEL org.opencontainers.image.vendor=""

README.md

@@ -1,53 +1,71 @@
-# Brainwine
-[![build](https://github.com/kuroppoi/brainwine/actions/workflows/build.yml/badge.svg)](https://github.com/kuroppoi/brainwine/actions)
-
-Brainwine is a Deepworld private server written in Java, made with user-friendliness and portability in mind.
-Due to the time it will take for this project to be complete (and my inconsistent working on it), brainwine has been prematurely open-sourced
-and is free for all to use.\
-Keep in mind, though, that this server is not finished yet. Expect to encounter bad code, bugs and missing features!\
-Brainwine is currently compatible with the following versions of Deepworld:
-- Steam: `v3.13.1`
+<h1 align="center">Brainwine</h1>
+<p align="center">
+  <a href="https://github.com/kuroppoi/brainwine/actions"><img src="https://github.com/kuroppoi/brainwine/actions/workflows/build.yml/badge.svg" alt="build"/></a>
+  <a href="https://github.com/kuroppoi/brainwine/releases/latest"><img src="https://img.shields.io/github/v/release/kuroppoi/brainwine?labelColor=30373D&label=Release&logoColor=959DA5&logo=github" alt="release"/></a>
+</p>
+
+Brainwine is a Deepworld private server written in Java, designed to be portable and easy to use.\
+It's still a work in progress, so keep in mind that it's not yet feature-complete. (A to-do list can be found [here](https://github.com/kuroppoi/brainwine/projects/1).)\
+Brainwine currently supports the following versions of Deepworld:
+
+- Windows: `v3.13.1`
 - iOS: `v2.11.0.1`
 - MacOS: `v2.11.1`
 
-## Features
-A list of all planned, in-progress and finished features can be found [here.](https://github.com/kuroppoi/brainwine/projects/1)
+## Quick Local Setup
+
+- Install [Java 8](https://adoptium.net/temurin/releases/?package=jdk&version=8).
+- Download the [latest Brainwine release](https://github.com/kuroppoi/brainwine/releases/latest).
+- Start Brainwine by running the jar file.
+- In the window that appears, press "Start Server" to start the server.
+- Press "Start Deepworld" to launch the game.
+  - If you want to play on iOS, download a patching kit for it [here](https://github.com/kuroppoi/brainwine/releases/tag/patching-kits-1.0).
+- Register a new account and play the game.
+
+## Building
+
+### Prerequisites
 
-## Setup
+- Java 8 Development Kit
 
-### Setting up the client
+Run the following to build the program:
 
-Before you can connect to a server, a few modifications need to be made to the Deepworld game client.\
-The exact process of this differs per platform.\
-You may download an installation package for your desired platform [here.](https://github.com/kuroppoi/brainwine/releases/tag/patching-kits-1.0)
+```sh
+git clone --recurse-submodules https://github.com/kuroppoi/brainwine.git
+cd brainwine
+./gradlew dist
+```
 
-### Setting up the server
+The output executable jar `brainwine.jar` will be located in the `/build/dist` directory.\
+To start the server without a user interface, run the following:
 
-#### Prerequisites
+```sh
+# This behavior is the default on platforms that do not support Java's Desktop API.
+java -jar brainwine.jar disablegui
+```
 
-- Java 8 or newer
+## Docker
 
-You can download the latest release [here.](https://github.com/kuroppoi/brainwine/releases/latest)\
-Alternatively, if you wish to build from source, clone this repository with the `--recurse-submodules` flag\
-and run `gradlew dist` in the root directory of the repository.\
-After the build has finished, the output jar will be located in `build/libs`.\
-You may then start the server through the gui, or start it directly by running the jar with the `disablegui` flag.
+Run the following to build the image:
 
-#### Configurations
+```sh
+git clone https://github.com/kuroppoi/brainwine
+cd brainwine
+docker buildx build -t brainwine:latest .
+```
 
-On first-time startup, configuration files will be generated which you may modify however you like:
-- `api.json` Configuration file for news & API connectivity information.
-- `loottables.json` Configuration file for which loot may be obtained from containers.
-- `spawning.json` Configuration file for entity spawns per biome.
-- `generators` Folder containing configuration files for zone generators.
+To then run the image in a container, run the following:
 
-## Contributions
+```sh
+# Replace ${PWD} with %cd% if you're using a Windows Command Prompt.
+docker run -p 5001-5003:5001-5003 --volume ${PWD}/run:/data brainwine:latest
+```
 
-Disagree with how I did something? Found a potential error? See some room for improvement? Or just want to add a feature?
-Glad to hear it! Feel free to make a pull request anytime. Just make sure you follow the code style!
-And, apologies in advance for the lack of documentation. Haven't gotten around to do it yet. Sorry!
+Or alternatively, if you wish to use docker compose:
 
-## Issues
+```sh
+docker compose up
+```
 
-Found a bug? Before posting an issue, make sure your build is up-to-date and your issue has not already been posted before.
-Provide a detailed explanation of the issue, and how to reproduce it. I'll get to it ASAP!
+The server files will be stored in a docker volume and can be accessed from `/data` in the container.\
+Feel free to play around with the configuration by editing `docker-compose.yml`.

api/build.gradle

@@ -8,9 +8,5 @@ repositories {
 
 dependencies {
     implementation 'io.javalin:javalin:4.6.8'
-    implementation project(':shared')
-}
-
-jar {
-    archiveBaseName = 'brainwine-api'
+    implementation project(':brainwine-shared')
 }

api/src/main/java/brainwine/api/DataFetcher.java

@@ -9,7 +9,11 @@ public interface DataFetcher {
     public boolean isPlayerNameTaken(String name);
     public String registerPlayer(String name);
     public String login(String name, String password);
+    public String fetchPlayerName(String name);
+    public String fetchPlayerId(String apiToken);
     public boolean verifyAuthToken(String name, String token);
-    public boolean verifyApiToken(String apiToken);
+    public ZoneInfo getZoneInfo(String nameOrId);
     public Collection<ZoneInfo> fetchZoneInfo();
+    public Collection<ZoneInfo> fetchRecentZoneInfo(String apiToken);
+    public Collection<ZoneInfo> fetchBookmarkedZoneInfo(String apiToken);
 }

api/src/main/java/brainwine/api/DefaultDataFetcher.java

@@ -23,18 +23,38 @@ public String login(String name, String password) {
         throw exception;
     }
 
+    @Override
+    public String fetchPlayerName(String name) {
+        throw exception;
+    }
+
+    @Override
+    public String fetchPlayerId(String apiToken) {
+        throw exception;
+    }
+
     @Override
     public boolean verifyAuthToken(String name, String token) {
         throw exception;
     }
-
+    
     @Override
-    public boolean verifyApiToken(String apiToken) {
+    public ZoneInfo getZoneInfo(String nameOrId) {
         throw exception;
     }
 
     @Override
     public Collection<ZoneInfo> fetchZoneInfo() {
         throw exception;
     }
+
+    @Override
+    public Collection<ZoneInfo> fetchRecentZoneInfo(String apiToken) {
+        throw exception;
+    }
+
+    @Override
+    public Collection<ZoneInfo> fetchBookmarkedZoneInfo(String apiToken) {
+        throw exception;
+    }
 }

api/src/main/java/brainwine/api/GatewayService.java

@@ -111,7 +111,7 @@ private void handlePlayerLogin(Context ctx) {
             return;
         }
 
-        ctx.json(new ServerConnectInfo(api.getGameServerHost(), name, token));
+        ctx.json(new ServerConnectInfo(api.getGameServerHost(), dataFetcher.fetchPlayerName(name), token));
     }
 
     /**

api/src/main/java/brainwine/api/MapRenderer.java

@@ -0,0 +1,118 @@
+package brainwine.api;
+
+import java.awt.Color;
+import java.awt.Graphics2D;
+import java.awt.image.BufferedImage;
+import java.awt.image.DataBufferInt;
+import java.io.InputStream;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.imageio.ImageIO;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+import brainwine.api.models.ZoneInfo;
+import brainwine.api.util.ImageUtils;
+
+/**
+ * Functions for rendering zone maps.
+ */
+public class MapRenderer {
+
+    private static final Logger logger = LogManager.getLogger();
+    private static final double[] depths = { 0.03, 0.05, 0.08, 0.12, 0.17, 0.26, 0.3 };
+    private static final Map<String, int[]> colorMap = new HashMap<>();
+    private static final BufferedImage mapCrossImage;
+
+    static {
+        // Set color map data
+        colorMap.put("plain", new int[] { 0xFFFFFF, 0x5DB830, 0x417431, 0x414E1C, 0x4E441C, 0x2A240C, 0x18150B });
+        colorMap.put("arctic", new int[] { 0xFFFFFF, 0x75A49E, 0x456B74, 0x33535F, 0x2D4F5D, 0x142E3F, 0x0B1A25 });
+        colorMap.put("hell", new int[] { 0xFFFFFF, 0xBE8D6F, 0x905548, 0x7F3C32, 0x6F3932, 0x5F1814, 0x380E0D });
+        colorMap.put("brain", new int[] { 0xFFFFFF, 0xA19599, 0x705C6E, 0x5D4257, 0x4E3E55, 0x3B1C36, 0x2A0B28 });
+        colorMap.put("desert", new int[] { 0xECDE93, 0xB18E58, 0x7B5822, 0x614312, 0x4E350C, 0x322209, 0x1E1506 });
+        colorMap.put("space", new int[] { 0xFFFFFF, 0xEEEEEE, 0xDDDDDD, 0xCCCCCC, 0xBBBBBB, 0xAAAAAA, 0x999999 });
+
+        // Load image resources
+        mapCrossImage = loadImageResource("/map/crossMark.png");
+    }
+
+    private static BufferedImage loadImageResource(String name) {
+        try(InputStream inputStream = MapRenderer.class.getResourceAsStream(name)) {
+            return ImageIO.read(inputStream);
+        } catch(Exception e) {
+            logger.error("Failed to load image resource '{}'", name, e);
+        }
+
+        return null;
+    }
+
+    public static BufferedImage drawSurfaceMap(ZoneInfo zone) {
+        return drawSurfaceMap(zone.getWidth(), zone.getHeight(), zone.getBiome(), zone.getSurface());
+    }
+
+    /**
+     * Creates a surface map render that is visually almost identical to V2 client map renders.
+     */
+    public static BufferedImage drawSurfaceMap(int width, int height, String biome, int[] surfaceArray) {
+        BufferedImage image = ImageUtils.createImage(300000, width, height);
+        Graphics2D g2d = image.createGraphics();
+        int[] colors = colorMap.getOrDefault(biome.toLowerCase(), colorMap.get("plain"));
+        int[] raster = ((DataBufferInt)image.getRaster().getDataBuffer()).getData();
+        int surfaceMin = height;
+        int surfaceMax = 0;
+
+        // Find highest & lowest surface points
+        for(int surface : surfaceArray) {
+            surfaceMin = Math.min(surfaceMin, surface);
+            surfaceMax = Math.max(surfaceMax, surface);
+        }
+
+        int surfaceCenter = (int)Math.floor((surfaceMax - surfaceMin) * 0.5 + surfaceMin);
+        double scaleX = (double)image.getWidth() / width;
+        double scaleY = (double)image.getHeight() / height;
+
+        // Fill raster with background color fast
+        int length = (int)(surfaceMax * scaleY) * image.getWidth();
+        raster[0] = 0x80808080;
+
+        for(int i = 1; i < length; i += i) {
+            System.arraycopy(raster, 0, raster, i, length - i < i ? length - i : i);
+        }
+
+        // Draw zone surface
+        // TODO potentially slow (largely because of Java2D) and can probably be optimized further
+        for(int i = 0; i < image.getWidth(); i++) {            
+            int surface = surfaceArray[(int)(i / scaleX)];
+            int distanceToPeak = surface - surfaceMin;
+            double y = (height - surface) * scaleY;
+            double layerHeight = 1.0;
+            int start = image.getHeight() - (int)(y * layerHeight);
+
+            for(int j = 0; j < depths.length; j++) {
+                double scale = (double)distanceToPeak / height / depths.length * (j < 2 ? 2.0 : 0.5);
+                layerHeight -= (depths[j] - scale);
+                int end = j + 1 >= depths.length ? image.getHeight() : image.getHeight() - (int)(y * layerHeight);
+                g2d.setColor(new Color(colors[j > 0 || surface < surfaceCenter ? j : 1])); // Only use snow color if surface is above surface center
+                g2d.fillRect(i, start, 1, end - start);
+                start = end;
+            }    
+        }
+
+        g2d.dispose();
+        return image;
+    }
+
+    /**
+     * Draws a red cross mark on an image at the given zone coordinates.
+     */
+    public static void drawCrossMark(ZoneInfo zone, int x, int y, BufferedImage mapImage) {
+        double scaleX = (double)mapImage.getWidth() / zone.getWidth();
+        double scaleY = (double)mapImage.getHeight() / zone.getHeight();
+        Graphics2D g2d = mapImage.createGraphics();
+        g2d.drawImage(mapCrossImage, (int)(x * scaleX) - 24, (int)(y * scaleY) - 25, 50, 60, null);
+        g2d.dispose();
+    }
+}