Working on the UI component, and bashing my head against the wall with input

Author: CaptainSly

build.gradle.kts

@@ -16,7 +16,7 @@ repositories {
 }
 
 dependencies {
-	api("com.googlecode.lanterna:lanterna:3.1.2")
+	implementation("com.googlecode.lanterna:lanterna:3.1.2")
 }
 
 // Apply a specific Java toolchain to ease working on different environments.

readme.md

@@ -7,47 +7,77 @@ Uses Lanterna to emulate a terminal, also comes with a Pair class that is a basi
 
 Requires Java 17+
 
+## What does it provide? 
+
+If you decide to use Console Java Engine to make your game with, first off thank you for using my project to make yours, secondly you might want to know what it provides. 
+
+As of version 0.1.20-Jyggalag the following is provided:
+
+A Scene system
+A Pair class that emulates the C++ Standard Library's. (I thought it'd be nice to have when I first wrote this, this might be removed later)
+A Colors class that holds RGB colors. These colors were sourced from the [website](html-color.codes) 
+A very basic Camera class. It's really basic camera.
+An Immediate Mode UI - I emulated how DearImGui works and currently adding features to the it as I go. 
+An Input class - It handles keyboard input. I've been trying to implement a `justPressed` feature, but Lanterna only let's you know a key was pressed and not when it was released, held or pressed. So I might have to dig deeper and develop a separate input system from Lanterna. 
+
 ## How to use
 
-To use CJE, include it in your project, then create a class and extend the `ConsoleJavaEngine`. It provides a Skeleton for your project. After that all you need to do is create different `Scene` classes for you game. The `ConsoleRenderer` class holds methods to write to the screen. 
+Under the hood, Console Java Engine uses Lanterna to create a Swing based Terminal for drawing to. 
+
+To utilize the Console Java Engine in your project, create a class that extends the `ConsoleJavaEngine` class. The Console Java Engine uses scenes so you will also need to create a class that extends `AbstractScene` class. The `AbstractScene` class provides methods for you to override so you can update, render to the screen, render ui, and process input. You can draw to the screen using the provided `ConsoleRenderer` object, and draw UI using the `UIContext` object pass through. `UIContext` uses an Immediate Mode gui system so you're able to create UI kinda like DearIMGui does. 
+
+A Skeleton is provided below for both a class that extends the `ConsoleJavaEngine` and a class that extends `AbstractScene`
+
+The default font included is ascii-sector-16x16-tileset. This means that each cell will also be 16x16 "pixels", if you will, so when you specify you're width and height for creating your game, it'll be multiplied by the font's character width and height. 80, 48 is used here which would translate to a window size of 1280 by 768. This font was chosen because of it's ability to use Code Page 437. By utilizing '\u' then a number, you can use symbols from the code page. 
 
 ```Java
 
-import com.googlecode.lanterna.input.KeyStroke;
 import com.spireprod.cje.ConsoleJavaEngine;
 
 public class Adventure extends ConsoleJavaEngine {
 
 	public Adventure() {
-		super("Adventure", 80, 24);
+		super("Adventure", 80, 48);
 	}
 
 	@Override
 	protected void onGameCreate() {
-		setScene(new GameScreen());
+		setScene(new GameScene(this));
+	}
+
+	public static void main(String[] args) {
+		Adventure venture = new Adventure();
+		venture.run();
 	}
 
 }
 
-import com.googlecode.lanterna.input.KeyStroke;
+import com.spireprod.cje.ConsoleJavaEngine;
 import com.spireprod.cje.core.ConsoleRenderer;
-import com.spireprod.cje.core.scenes.Scene;
+import com.spireprod.cje.core.input.Input;
+import com.spireprod.cje.core.scenes.AbstractScene;
+import com.spireprod.cje.core.ui.UIContext;
 
-public class GameScene implements Scene {
+public class GameScene extends AbstractScene {
+
+	public GameScene(ConsoleJavaEngine cje) {
+		super(cje);
+	}
 
 	@Override
 	public void onSceneUpdate(float delta) {
-
 	}
 
 	@Override
 	public void onSceneRender(ConsoleRenderer renderer) {
-
 	}
 
 	@Override
-	public void onSceneInput(float delta, KeyStroke key) {
+	public void onSceneUIRender(UIContext ctx, ConsoleRenderer renderer, Input input) {
+	}
 
+	@Override
+	public void onSceneInput(float delta, Input input) {
 	}
 
 }

src/main/java/com/spireprod/cje/ConsoleJavaEngine.java

@@ -33,6 +33,7 @@ public abstract class ConsoleJavaEngine {
 	public static final String PIXEL_SHADE_FULL = "\u2593";
 	public static final String PIXEL_SHADE_HALF = "\u2592";
 	public static int termWidth, termHeight;
+	public static int screenWidth, screenHeight;
 
 	protected Terminal terminal;
 	protected SceneManager sceneManager;
@@ -66,7 +67,8 @@ public ConsoleJavaEngine(String title, int width, int height) {
 
 		DefaultTerminalFactory defaultTermFactory = new DefaultTerminalFactory();
 
-		// Setup Default Font 'Ubuntu Mono'
+		// Setup Default Font 'Ascii Sector 16x16 Tileset'
+		// License is in resources folder/base jar.
 		Font font = null;
 		try {
 			InputStream is = ConsoleJavaEngine.class.getResourceAsStream("/ascii-sector-16x16-tileset.ttf");
@@ -81,7 +83,7 @@ public ConsoleJavaEngine(String title, int width, int height) {
 
 		GraphicsEnvironment.getLocalGraphicsEnvironment().registerFont(font);
 
-		defaultTermFactory.setTerminalEmulatorTitle(title + " -" + CJE_VERSION)
+		defaultTermFactory.setTerminalEmulatorTitle(title + " - " + CJE_VERSION)
 				.setTerminalEmulatorFontConfiguration(
 						SwingTerminalFontConfiguration.newInstance(font.deriveFont(Font.PLAIN, 16)))
 				.setInitialTerminalSize(new TerminalSize(width, height)).setForceAWTOverSwing(false)
@@ -96,6 +98,9 @@ public ConsoleJavaEngine(String title, int width, int height) {
 			frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 			frame.setVisible(true);
 
+			screenWidth = frame.getWidth();
+			screenHeight = frame.getHeight();
+
 			ctx = new UIContext();
 			screen = new TerminalScreen(terminal);
 			termWidth = frame.getTerminalSize().getColumns();

src/main/java/com/spireprod/cje/core/Camera.java

@@ -1,7 +1,5 @@
 package com.spireprod.cje.core;
 
-import java.util.Random;
-
 public class Camera {
 	private float x, y; // top-left world coordinate of the view
 	private final int viewWidth, viewHeight;
@@ -11,11 +9,6 @@ public class Camera {
 	private float panSpeed = 0;
 	private boolean isPanning = false;
 
-	// Shake
-	private float shakeTimer = 0;
-	private float shakeMagnitude = 0;
-	private final Random rng = new Random();
-
 	public Camera(int viewWidth, int viewHeight) {
 		this.viewWidth = viewWidth;
 		this.viewHeight = viewHeight;
@@ -36,12 +29,6 @@ public void panTo(float worldX, float worldY, float speed) {
 		isPanning = true;
 	}
 
-	// Shake the camera for a short time
-	public void shake(float duration, float magnitude) {
-		shakeTimer = duration;
-		shakeMagnitude = magnitude;
-	}
-
 	public void update(float deltaSeconds) {
 		if (Float.isNaN(x) || Float.isNaN(y)) {
 			System.err.println("Warning: NaN in camera coordinates. Resetting.");
@@ -61,19 +48,14 @@ public void update(float deltaSeconds) {
 				isPanning = false;
 			}
 		}
-
-		// Shake logic
-		if (shakeTimer > 0) {
-			shakeTimer -= deltaSeconds;
-		}
 	}
 
 	public int getViewX() {
-		return (int) x + getShakeOffset();
+		return (int) x;
 	}
 
 	public int getViewY() {
-		return (int) y + getShakeOffset();
+		return (int) y;
 	}
 
 	public int worldToScreenX(int worldX) {
@@ -84,10 +66,6 @@ public int worldToScreenY(int worldY) {
 		return worldY - getViewY();
 	}
 
-	private int getShakeOffset() {
-		return (shakeTimer > 0) ? rng.nextInt((int) (shakeMagnitude * 2 + 1)) - (int) shakeMagnitude : 0;
-	}
-
 	private float lerp(float a, float b, float t) {
 		return a + (b - a) * clamp(t, 0f, 1f);
 	}

src/main/java/com/spireprod/cje/core/Colors.java

@@ -14,6 +14,9 @@ public class Colors {
 	// Browns
 
 	public static RGB PULLMAN_BROWN = new RGB(100, 65, 23);
+	public static RGB BISQUE = new RGB(255, 228, 196);
+	public static RGB MOCCASIN = new RGB(255, 228, 181);
+	public static RGB NAVAJO_WHITE = new RGB(255, 222, 173);
 
 	// Tans
 
@@ -22,6 +25,8 @@ public class Colors {
 	// Peaches
 
 	// Golds
+	public static RGB GOLD = new RGB(255, 215, 0);
+	public static RGB BEIGE = new RGB(245, 245, 220);
 
 	// Yellows
 
@@ -30,10 +35,10 @@ public class Colors {
 	// Olives
 
 	// Greens
-
 	public static RGB GREEN = new RGB(0, 255, 0);
 	public static RGB LAWN_GREEN = new RGB(124, 252, 0);
 	public static RGB PHTHALO_GREEN = new RGB(18, 53, 36);
+	public static RGB MEDIUM_SPRING_GREEN = new RGB(0, 250, 154);
 
 	// Teals
 
@@ -42,6 +47,7 @@ public class Colors {
 	// Blues
 	public static RGB BLUE = new RGB(0, 0, 255);
 	public static RGB DODGER_BLUE = new RGB(30, 144, 255);
+	public static RGB MUNSELL_BLUE = new RGB(0, 147, 175);
 
 	// Navys
 

src/main/java/com/spireprod/cje/core/ui/UIContext.java

@@ -2,10 +2,12 @@
 
 import java.util.ArrayDeque;
 import java.util.Deque;
+import java.util.function.Function;
 
 import com.googlecode.lanterna.TextColor;
 import com.googlecode.lanterna.input.KeyType;
 import com.spireprod.cje.ConsoleJavaEngine;
+import com.spireprod.cje.core.Colors;
 import com.spireprod.cje.core.ConsoleRenderer;
 import com.spireprod.cje.core.input.Input;
 
@@ -16,7 +18,7 @@ public class UIContext {
 	// Panel Offset Stack
 	private int offsetX = 0;
 	private int offsetY = 0;
-	private final Deque<int[]> offsetStack = new ArrayDeque<>();
+	private final Deque<int[]> offsetStack = new ArrayDeque<>(); // Panel OffsetStack
 
 	private ConsoleRenderer renderer;
 	private Input input;
@@ -110,6 +112,34 @@ public boolean textInput(String label, int x, int y, StringBuilder buffer, TextC
 		return false;
 	}
 
+	public <T> boolean choiceBox(int x, int y, T[] boxObjs, int[] choiceIdx, Function<T, String> labelFunc,
+			TextColor backgroundColor, TextColor textColor) {
+		boolean fired = false;
+
+		for (int i = 0; i < boxObjs.length; i++) {
+			boolean isSelected = (selectedIndex == totalItems);
+			boolean choiceSelected = i == choiceIdx[0];
+
+			TextColor color = isSelected ? TextColor.ANSI.GREEN : textColor;
+			String prefix = isSelected ? "> " : "  ";
+
+			if (choiceSelected)
+				color = Colors.BLUE;
+
+			renderer.writeString(prefix + labelFunc.apply(boxObjs[i]), offsetX + x, offsetY + y + i, backgroundColor,
+					color);
+
+			if (isSelected && input.isKeyDown(KeyType.Enter)) {
+				fired = true;
+				choiceIdx[0] = i;
+			}
+
+			totalItems++;
+		}
+
+		return fired;
+	}
+
 	// region: Panel
 
 	public void beginPanel(int x, int y, int width, int height, TextColor backgroundColor) {
@@ -124,15 +154,18 @@ public void beginPanel(int x, int y, int width, int height, TextColor background
 		}
 
 		// Top/Bottom border
-		renderer.writeString("+" + "-".repeat(width - 2) + "+", offsetX, offsetY, backgroundColor,
+		renderer.writeString("+" + buildChainLine(width - 2) + "+", offsetX, offsetY, backgroundColor,
 				TextColor.ANSI.WHITE);
-		renderer.writeString("+" + "-".repeat(width - 2) + "+", offsetX, offsetY + height - 1, backgroundColor,
+		renderer.writeString("+" + buildChainLine(width - 2) + "+", offsetX, offsetY + height - 1, backgroundColor,
 				TextColor.ANSI.WHITE);
 
 		// Left/Right border
+		char[] sideChain = new char[] { '|', ':' };
+
 		for (int iy = 1; iy < height - 1; iy++) {
-			renderer.putChar('|', offsetX, offsetY + iy, TextColor.ANSI.WHITE, backgroundColor);
-			renderer.putChar('|', offsetX + width - 1, offsetY + iy, TextColor.ANSI.WHITE, backgroundColor);
+			char sideGlyph = sideChain[iy % sideChain.length];
+			renderer.putChar(sideGlyph, offsetX, offsetY + iy, TextColor.ANSI.WHITE, backgroundColor);
+			renderer.putChar(sideGlyph, offsetX + width - 1, offsetY + iy, TextColor.ANSI.WHITE, backgroundColor);
 		}
 
 	}
@@ -161,4 +194,16 @@ public void handleInput(Input input) {
 		selectedIndex = Math.floorMod(selectedIndex, totalItems);
 	}
 
+	private String buildChainLine(int length) {
+		String pattern = "-=";
+		StringBuilder sb = new StringBuilder();
+		while (sb.length() < length) {
+			sb.append(pattern);
+		}
+		return sb.substring(0, length);
+	}
+
+	public record Choice(Object choice, boolean fired) {
+	}
+
 }