Merge pull request #60 from runejs/feature/whitelabel

Promises · web-flow · commit 9502c2f64e1b · 2021-04-21T14:47:14.000+02:00
Whitelabel update
diff --git a/.gitignore b/.gitignore
@@ -29,6 +29,8 @@ data/models/
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 /config/client-config.yaml
+/config/runejs-client.yaml
+/config/client-435.conf.yaml
 
 # Gradle
 .gradle
diff --git a/README.md b/README.md
@@ -1,12 +1,8 @@
 # RuneScape Java Client #435
 
-A RuneScape game client from October of 2006 - the client has been modified specifically for use with RuneJS, a RuneScape game server emulator written in ES6 and TypeScript. **This client is not for OldSchool RuneScape** - it actually pre-dates the very first OSRS client by quite some time. 
+A RuneScape game client from October of 2006 which has been modified to work with RuneJS, a RuneScape game server emulator written in NodeJS and TypeScript. **This client is not for OldSchool RuneScape** - client #435 pre-dates the very first OSRS client by quite some time. 
 
-The game client is written in Java, as the original was in 2006. As RuneJS is meant to be a learning experience for game content development, there are no plans to create a JavaScript based RuneJS client at this time.
-
-The purpose of this project being open source is to better understand how the game works under the hood, allowing for a better RuneJS game server. Obfuscation cleanup is always welcome! :)
-
-We've no interest in OSRS client hacking, this client exists solely to log into RuneJS and has been modified accordingly.
+We've no interest in OSRS client hacking, this client exists as a means to develop on RuneJS game servers and will not work with other server emulators.
 
 ## Usage
 
@@ -16,28 +12,30 @@ Running the client can be done either with the pre-built client JAR file or by b
 
 Running the pre-built client requires having Java installed: https://www.java.com/en/
 
-Once installed, go into the `/prebuilt/` and simply double-click the JAR file to run it. Alternatively, if double clicking the JAR does not work, you can use the command `java -jar RuneJS_Client.jar` from the `/prebuilt/` directory.
+Once installed, go into the `/prebuilt/` and simply double-click the JAR file to run it. Alternatively, if double clicking the JAR does not work, you can use the command `java -jar client-435.jar` from the `/prebuilt/` directory.
 
 The client will use a set of default configurations if no file is provided. The default client configuration matches up to the default RuneJS server configuration for quick and easy initial setup. It's highly advised that you generate your own RSA public and private keys for long term use.
 
-To provide your own configurations, create a file named `runejs-client.yaml` in your User Home directory with the following content:
+To provide your own configurations, create a file named `client-435.conf.yaml` in your User Home directory with the following content:
 
 ```yaml
 net:
   address: 127.0.0.1
   game_port: 43594
 cache:
-  cacheDir: .runejs_cache
-  jaggrabEnabled: false
+  cacheDir: .filestore_435
 rsa:
-  rsaPub: YOUR_RSA_PUBLIC_KEY
-  rsaModulus: YOUR_RSA_PRIVATE_KEY
+  rsaPub: YOUR_RSA_PUBLIC_KEY (default dev pair provided in the example file)
+  rsaModulus: YOUR_RSA_PRIVATE_KEY (default dev pair provided in the example file)
 login:
-  useStaticCredentials: false
+  useStaticCredentials: true
+  username: a
+  password: a
 game:
   roofsEnabled: true
   freeTeleports: false
   debugContextMenu: true
+serverDisplayName: Build 435
 ```
 
 Make sure to modify the given configuration for your specific needs.
@@ -55,7 +53,7 @@ The `application` gradle plugin provides the `run` task, which starts up the Mai
 arguments can be provided via `--args`.
 
 ```
-./gradlew run --args="1 live live highmem members"
+./gradlew run
 ```
 
 **Building a Jar**
@@ -64,5 +62,5 @@ The `jar` task can be used to build a jar, which is generated in the `build/libs
 
 ```
 ./gradlew jar
-java -jar ./build/libs/435-client-0.1.jar 1 live live highmem members
+java -jar ./build/libs/client-435-0.1.jar
 ```
diff --git a/config/client-435.conf.example.yaml b/config/client-435.conf.example.yaml
@@ -2,7 +2,7 @@ net:
   address: 127.0.0.1
   game_port: 43594
 cache:
-  cacheDir: .runejs_cache
+  cacheDir: .filestore_435
 rsa:
   rsaPub: 65537
   rsaModulus: 119568088839203297999728368933573315070738693395974011872885408638642676871679245723887367232256427712869170521351089799352546294030059890127723509653145359924771433131004387212857375068629466435244653901851504845054452735390701003613803443469723435116497545687393297329052988014281948392136928774011011998343
@@ -14,3 +14,4 @@ game:
   roofsEnabled: true
   freeTeleports: false
   debugContextMenu: true
+serverDisplayName: Build 435
diff --git a/prebuilt/RuneJS_Client.jar b/prebuilt/RuneJS_Client.jar
diff --git a/prebuilt/client-435-0.1.jar b/prebuilt/client-435-0.1.jar
diff --git a/settings.gradle b/settings.gradle
@@ -1 +1 @@
-rootProject.name = 'runejs-client'
+rootProject.name = 'client-435'
diff --git a/src/main/java/com/jagex/runescape/GameShell.java b/src/main/java/com/jagex/runescape/GameShell.java
@@ -425,7 +425,7 @@ public void openClientApplet(String cacheFolder, int cacheIndexes, int fileStore
             IdentityKit.height = height;
             MovedStatics.anApplet_Sub1_179 = this;
             Class35.aFrame1732 = new Frame();
-            Class35.aFrame1732.setTitle("Jagex");
+            Class35.aFrame1732.setTitle(Configuration.SERVER_DISPLAY_NAME);
 //            Class35.aFrame1732.setResizable(false);
             ScreenController.frameMode(ScreenMode.FIXED);
             Class35.aFrame1732.setPreferredSize(new Dimension(width, height));
diff --git a/src/main/java/com/jagex/runescape/Main.java b/src/main/java/com/jagex/runescape/Main.java
@@ -657,7 +657,7 @@ else if (params[3].equals("highmem"))
             } else
                 Class22.membersWorld = false;
             Main main = new Main();
-            main.openClientApplet("runescape", 13, 32 + Class44.modewhat, InetAddress.getByName(Configuration.SERVER_ADDRESS), 435);
+            main.openClientApplet("client435", 13, 32 + Class44.modewhat, InetAddress.getByName(Configuration.SERVER_ADDRESS), 435);
 
         } catch (Exception exception) {
             exception.printStackTrace();
diff --git a/src/main/java/com/jagex/runescape/frame/console/Console.java b/src/main/java/com/jagex/runescape/frame/console/Console.java
@@ -12,6 +12,7 @@
 import com.jagex.runescape.media.renderable.actor.Player;
 import com.jagex.runescape.scene.SceneCluster;
 import com.jagex.runescape.scene.tile.WallDecoration;
+import tech.henning.fourthreefive.Configuration;
 
 import java.awt.*;
 import java.awt.datatransfer.Clipboard;
@@ -22,7 +23,7 @@
 import java.util.List;
 
 public class Console {
-    private static final String CONSOLE_VERSION = "RuneJS #435";
+    private static final String CONSOLE_VERSION = Configuration.SERVER_DISPLAY_NAME;
     public static Console console; // TODO: Temp until finding a better spot to store this
     private String[] consoleMessages;
     private int messageCount;
@@ -50,7 +51,7 @@ public Console() {
         this.previousCommandCount = 1;
         this.previousCommandIndex = 1;
         this.commands = new CommandList();
-        this.log("Welcome to the RuneJS console, type help for help.");
+        this.log("Welcome to the " + Configuration.SERVER_DISPLAY_NAME + " console, type help for help.");
         this.initialiseCommands();
     }
 
diff --git a/src/main/java/com/jagex/runescape/language/English.java b/src/main/java/com/jagex/runescape/language/English.java
@@ -1,6 +1,8 @@
 package com.jagex.runescape.language;
 
 
+import tech.henning.fourthreefive.Configuration;
+
 public class English {
     public static String suffixFromYourIgnoreListFirst = " from your ignore list first";
     public static String suffixHasLoggedIn = " has logged in.";
@@ -75,8 +77,8 @@ public class English {
     public static String effectRed = "red:";
     public static String remove = "Remove";
     public static String reportAbuse = "Report abuse";
-    public static String runeScapeHasBeenUpdated = "RuneScape has been updated!";
-    public static String runeScapeIsLoadingPleaseWait = "RuneScape is loading - please wait...";
+    public static String runeScapeHasBeenUpdated = Configuration.SERVER_DISPLAY_NAME + " has been updated!";
+    public static String runeScapeIsLoadingPleaseWait = Configuration.SERVER_DISPLAY_NAME + " is loading - please wait...";
     public static String sidePanelRedrawn = "Side panel redrawn";
     public static String prefixSkill = "skill-";
     public static String effectSlide = "slide:";
@@ -122,7 +124,7 @@ public class English {
     public static String malformedLoginPacket = "Malformed login packet.";
     public static String pleaseTryAgain = "Please try again.";
     public static String pleaseWait1MinuteAndTryAgain = "Please wait 1 minute and try again.";
-    public static String welcomeToRunescape = "Welcome to RuneScape";
+    public static String welcomeToRunescape = "Welcome to " + Configuration.SERVER_DISPLAY_NAME;
     public static String use = "Use";
     public static String accountLockedAsWeSuspectItHasBeenStolen = "Account locked as we suspect it has been stolen.";
     public static String loadedWordpack = "Loaded wordpack";
@@ -169,7 +171,7 @@ public class English {
     public static String connectingToUpdateServer = "Connecting to update server";
     public static String addFriend = "Add friend";
     public static String andChooseTheCreateAccount = "and choose the 'create account'";
-    public static String goBackToTheMainRunescapeWebPage = "go back to the main RuneScape webpage";
+    public static String goBackToTheMainRunescapeWebPage = "go back to the main " + Configuration.SERVER_DISPLAY_NAME + " webpage";
     public static String sContinue = "Continue";
     public static String ok = "Ok";
     public static String commandFpson = "::fpson";
diff --git a/src/main/java/tech/henning/fourthreefive/Configuration.java b/src/main/java/tech/henning/fourthreefive/Configuration.java
@@ -15,7 +15,7 @@ public class Configuration {
     public static void read() {
         try {
             final Yaml yaml = new Yaml();
-            final String packagedPath = System.getProperty("user.home") + File.separator + "runejs-client.yaml";
+            final String packagedPath = System.getProperty("user.home") + File.separator + "client-435.conf.yaml";
             final FileInputStream inputStream = new FileInputStream(new File(packagedPath));
             final Map<String, Object> obj = yaml.load(inputStream);
 
@@ -36,6 +36,7 @@ public static void read() {
             ROOFS_ENABLED = (boolean) game.get("roofsEnabled");
             FREE_TELEPORTS = (boolean) game.get("freeTeleports");
             DEBUG_CONTEXT = (boolean) game.get("debugContextMenu");
+            SERVER_DISPLAY_NAME = (String) obj.get("serverDisplayName");
 
             if (USERNAME == null) {
                 USERNAME = "";
@@ -58,7 +59,7 @@ public static void read() {
     /**
      * Name of the cache folder located in the users home directory.
      */
-    public static String CACHE_NAME = ".runejs";
+    public static String CACHE_NAME = ".filestore_435";
 
     /**
      * Port for establishing a connection to the game server.
@@ -128,6 +129,11 @@ public static void read() {
      */
     public static boolean DEBUG_CONTEXT = true;
 
+    /**
+     * The display name of the game server to use within the client
+     */
+    public static String SERVER_DISPLAY_NAME = "Build 435";
+
 
     public static RSString getUsername() {
         if(USE_STATIC_DETAILS) {

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-rootProject.name = 'runejs-client'`
	`1`	`+rootProject.name = 'client-435'`