Merge pull request #9 from radovanmoncek/development

Development

Author: radovanmoncek

README.md

@@ -1,26 +1,42 @@
-## TODO: title
+### example nettgame server game
 
-is an example game for my example nettgame server.
+is an example game to showcase my example nettgame server.
 
-### Synopsis
+#### In action
 
-TODO: title is a top-down shooter inspired by the game "Bulánci".
-The game is built using the popular libGDX game engine.
+![showcase](https://github.com/radovanmoncek/nettgame-client/blob/development/showcase.gif)
 
-### Controls
+#### Synopsis
 
-- You can move with the W A S D keys 
-- Shooting is controlled by pressing the SPACEBAR key.
+This example is supposed to resemble a top-down shooter inspired by the game "Bulánci".
+The game is built using the popular libGDX framework.
+
+#### Controls
+
+- You can move with the W A S D keys
 
 #### How to build & run
 
+- Make sure your device runs a recent version of JRE or JDK (optimally > 21)
+- Download the .jar artifact from releases
+- Run the .jar artifact
+
+#### Dependencies
 
+- libGDX
+- JUnit
+- FlatBuffers
+- <https://www.github.com/radovanmoncek/nettgame-tables>
 
 *!!!! none of the assets used in this project are my own work,
 below is a list of their respective authors; 
-all assets allow free noncommercial use; I highly encourage everyone to 
+all assets allow free non-commercial use; I highly encourage everyone to 
 visit the website of each author !!!!*
 
-## Attributions:
-- character assets: TODO
+#### Attributions:
+- character assets: <https://rgsdev.itch.io/free-cc0-modular-animated-vector-characters-2d>
 - UI: <https://andelrodis.itch.io/1-bit-game-ui-pack>
+
+#### Legal
+
+The licence is **MIT**.

desktop/build.gradle

@@ -17,6 +17,8 @@ tasks.register('run', JavaExec) {
 
     args += "--winmode"
     args += "true"
+    args += "--server-address"
+    args += "localhost"
 
     if (OperatingSystem.current() == OperatingSystem.MAC_OS) {
         // Required to run on macOS

desktop/src/cz/radovanmoncek/nettgame/client/GameStateApplicationListener.java

@@ -72,10 +72,10 @@ public class GameStateApplicationListener implements ApplicationListener {
     /**
      * Source: <a href = https://gamefromscratch.com/libgdx-tutorial-10-basic-networking/>gfs</a>
      */
-    private GameStateApplicationListener() throws UnknownHostException {
+    private GameStateApplicationListener(final String address) throws UnknownHostException {
 
         gameServerPort = 4321;
-        gameServerAddress = InetAddress.getByName("192.168.100.46")/*InetAddress.getLoopbackAddress()*/;
+        gameServerAddress = InetAddress.getByName(address);
         gameStates = new ConcurrentLinkedQueue<>();
         disposables = new LinkedList<>();
         clientState = new AtomicReference<>();
@@ -333,8 +333,8 @@ public void resume() {
 
     //https://stackoverflow.com/questions/6307648/change-global-setting-for-logger-instances
 
-    public static GameStateApplicationListener returnNewInstance() throws UnknownHostException {
+    public static GameStateApplicationListener returnNewInstance(final String address) throws UnknownHostException {
 
-        return Objects.requireNonNullElse(instance, instance = new GameStateApplicationListener());
+        return Objects.requireNonNullElse(instance, instance = new GameStateApplicationListener(address));
     }
 }

desktop/src/cz/radovanmoncek/nettgame/client/NettgameClientLauncher.java

@@ -14,9 +14,7 @@ public static void main(String[] args) throws UnknownHostException {
 
             System.err.println("Window mode must be specified with the --winmode option");
 
-            Gdx
-                    .app
-                    .exit();
+            System.exit(1);
 
             return;
         }
@@ -25,13 +23,29 @@ public static void main(String[] args) throws UnknownHostException {
 
             System.err.println("Invalid argument");
 
-            Gdx
-                    .app
-                    .exit();
+            System.exit(1);
 
             return;
         }
 
+        if (args.length > 2 && !args[2].equals("--server-address")) {
+
+            System.err.println("Server address must be specified using the --server-address option");
+
+            System.exit(1);
+
+            return;
+        }
+
+        if (args.length < 4 || args[3] == null) {
+
+            System.err.println("Please specify a valid IP address or hostname");
+
+	    System.exit(1);
+	    
+            return;
+        }
+	
         final var config = new Lwjgl3ApplicationConfiguration();
 
         config.setForegroundFPS(60);
@@ -41,6 +55,6 @@ public static void main(String[] args) throws UnknownHostException {
         if (!Boolean.parseBoolean(args[1]))
             config.setFullscreenMode(Lwjgl3ApplicationConfiguration.getDisplayMode());
 
-        new Lwjgl3Application(GameStateApplicationListener.returnNewInstance(), config);
+        new Lwjgl3Application(GameStateApplicationListener.returnNewInstance(args[3]), config);
     }
 }

showcase.gif

@@ -12,7 +12,7 @@
 
 //todo: use position attributes in ALL tests !!!! !!!!
 /**
- * An integration test written, in part, to test containerized vs .jar performance of the Nettgame server.
+ * A system test written, in part, to test containerized vs .jar performance of the Nettgame server.
  *
  * @author Radovan Monček
  * @since 1.0
@@ -28,13 +28,18 @@ static void setup() throws AWTException {
 
         Executors
                 .defaultThreadFactory()
-	    .newThread(() -> {
-		    try {
-			NettgameClientLauncher.main(new String[]{"--winmode", "true"});
-		       }
-		catch(UnknownHostException exception){
-		    Gdx.app.error("setup", "Unknown Host Exception", exception);
-		}
+	        .newThread(() -> {
+
+			try {
+
+			    NettgameClientLauncher.main(new String[]{"--winmode", "true", "--server-address", "localhost"});
+			}
+			catch(UnknownHostException exception){
+
+			    Gdx
+				.app
+				.error("setup", "Unknown Host Exception", exception);
+			}
 		})
                 .start();