Merge pull request #8 from EwyBoy/reformat

Refactored & reformatted repo

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'

.github/workflows/gradle.yml

@@ -14,15 +14,15 @@ jobs:
       contents: read
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up JDK 11
-      uses: actions/setup-java@v4
-      with:
-        java-version: '11'
-        distribution: 'temurin'
+      - uses: actions/checkout@v4
+      - name: Set up JDK 11
+        uses: actions/setup-java@v4
+        with:
+          java-version: '11'
+          distribution: 'temurin'
 
-    - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
 
-    - name: Build with Gradle Wrapper
-      run: ./gradlew build
+      - name: Build with Gradle Wrapper
+        run: ./gradlew build

CODE_OF_CONDUCT.md

@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

@@ -1,16 +1,22 @@
 # Friend's House #
 
-Friend's House is open-source distributed under the [BSD 2-Clause License](https://github.com/EwyBoy/Friends-House/blob/master/LICENSE).
+Friend's House is open-source distributed under
+the [BSD 2-Clause License](https://github.com/EwyBoy/Friends-House/blob/master/LICENSE).
 
 I encourage you to contribute your ideas, code and problems you may experience while using Friends-House.  
 There are several ways for you to contribute to the project.
 
-If you want to contribute have a look at the [Project Table](https://github.com/EwyBoy/Friends-House/projects/1?fullscreen=true) and look for the `Help Wanted` tag.
+If you want to contribute have a look at
+the [Project Table](https://github.com/EwyBoy/Friends-House/projects/1?fullscreen=true) and look for the `Help Wanted`
+tag.
 
-* Contribute by sharing your ideas as feature requests [here](https://github.com/EwyBoy/Friends-House/issues/new?assignees=EwyBoy&labels=Compatibility+Request&template=compatibility-request.md&title=%5BCompatibility%5D+MOD-NAME).
-* Contribute by reporting any issues or bugs you may encounter [here](https://github.com/EwyBoy/Friends-House/issues/new?assignees=EwyBoy&labels=bug&template=bug_report.md&title=%5BBug%5D+Relevant+title+here)
-* Contribute by developing for Friends-House by making a pull-request [here](https://github.com/EwyBoy/Friends-House/pulls)
+* Contribute by sharing your ideas as feature
+  requests [here](https://github.com/EwyBoy/Friends-House/issues/new?assignees=EwyBoy&labels=Compatibility+Request&template=compatibility-request.md&title=%5BCompatibility%5D+MOD-NAME).
+* Contribute by reporting any issues or bugs you may
+  encounter [here](https://github.com/EwyBoy/Friends-House/issues/new?assignees=EwyBoy&labels=bug&template=bug_report.md&title=%5BBug%5D+Relevant+title+here)
+* Contribute by developing for Friends-House by making a
+  pull-request [here](https://github.com/EwyBoy/Friends-House/pulls)
 
-All help is very much appreciated.  
+All help is very much appreciated.
 
 -Ewy

README.md

@@ -1,12 +1,18 @@
 # Friend's House
+
 ## Description
-A simple and lightweight RuneLite plugin that lets you save a friend's name, so you can easily access their house without needing to remember the exact spelling and re-enter it every session.
+
+A simple and lightweight RuneLite plugin that lets you save a friend's name, so you can easily access their house
+without needing to remember the exact spelling and re-enter it every session.
 
 ## Who is this for?
-The plugin is for players who frequently borrows that one friend's house, can't spell usernames correct or have an alt using your mains POH all the time. 
+
+The plugin is for players who frequently borrows that one friend's house, can't spell usernames correct or have an alt
+using your mains POH all the time.
 It helps you autofill in the name in the user-interface.
 
 ## How to use
+
 1. Open the plugin's configuration panel
 2. Enter the name of the friend whose house you want to save.
 3. Go to the house portal and right-click it.
@@ -15,18 +21,21 @@ It helps you autofill in the name in the user-interface.
 6. Enjoy!
 
 ## Images
+
 ![image](https://github.com/user-attachments/assets/1a566bfe-1130-4153-b12f-a51409e9f0bf)
 ![image](https://github.com/user-attachments/assets/c98292a6-cb47-46d4-ad54-f6e49ef507a9)
 
-
 ## Features
+
 - Save a friend's name to easily access their house
 - Autofill the name in the house portal interface
 
 ## Planned features
+
 - Multiple friend support
 - Auto-submit the name in the house portal interface
 - Customizable hotkey to autofill the name
 
 ## Credits
+
 - Destructoid for the plugin idea

SECURITY.md

@@ -2,7 +2,9 @@
 
 ## Overview
 
-Thank you for using and contributing to the "Friend's House" RuneLite plugin. I take security seriously and appreciate your efforts to responsibly disclose vulnerabilities. This document outlines my policies and procedures for handling security-related issues.
+Thank you for using and contributing to the "Friend's House" RuneLite plugin. I take security seriously and appreciate
+your efforts to responsibly disclose vulnerabilities. This document outlines my policies and procedures for handling
+security-related issues.
 
 ## Supported Versions
 
@@ -16,16 +18,19 @@ If you discover a security vulnerability in the "Friend's House" plugin, please
 2. Email the details of the vulnerability to me at [email](mailto:[email protected]).
 
 Please include the following information in your report:
+
 - A description of the vulnerability and its potential impact.
 - Steps to reproduce the vulnerability.
 - Any proof-of-concept code or screenshots.
 - Your contact information.
 
-I will acknowledge receipt of your report within 48 hours and will strive to provide a detailed response within 5 business days. 
+I will acknowledge receipt of your report within 48 hours and will strive to provide a detailed response within 5
+business days.
 
 ## Handling Security Issues
 
 I will:
+
 1. Investigate the reported vulnerability.
 2. Confirm the vulnerability.
 3. Develop a fix or mitigation.
@@ -35,6 +40,7 @@ I will:
 ## Security Best Practices
 
 To ensure the security of your own use of the "Friend's House" plugin, please:
+
 - Always use the latest version of the plugin.
 - Regularly check for updates and apply them promptly.
 - Report any suspected vulnerabilities immediately.
@@ -45,4 +51,6 @@ If you have any questions or need further information, please contact me at [ema
 
 ## Disclaimer
 
-While I make every effort to ensure the security of the "Friend's House" plugin, security vulnerabilities are a reality of software development. Users are encouraged to take their own precautions and stay informed about best security practices.
+While I make every effort to ensure the security of the "Friend's House" plugin, security vulnerabilities are a reality
+of software development. Users are encouraged to take their own precautions and stay informed about best security
+practices.

build.gradle

@@ -1,32 +1,32 @@
 plugins {
-	id 'java'
+    id 'java'
 }
 
 repositories {
-	mavenLocal()
-	maven {
-		url = 'https://repo.runelite.net'
-	}
-	mavenCentral()
+    mavenLocal()
+    maven {
+        url = 'https://repo.runelite.net'
+    }
+    mavenCentral()
 }
 
 def runeLiteVersion = 'latest.release'
 
 dependencies {
-	compileOnly group: 'net.runelite', name:'client', version: runeLiteVersion
+    compileOnly group: 'net.runelite', name: 'client', version: runeLiteVersion
 
-	compileOnly 'org.projectlombok:lombok:1.18.30'
-	annotationProcessor 'org.projectlombok:lombok:1.18.30'
+    compileOnly 'org.projectlombok:lombok:1.18.30'
+    annotationProcessor 'org.projectlombok:lombok:1.18.30'
 
-	testImplementation 'junit:junit:4.12'
-	testImplementation group: 'net.runelite', name:'client', version: runeLiteVersion
-	testImplementation group: 'net.runelite', name:'jshell', version: runeLiteVersion
+    testImplementation 'junit:junit:4.12'
+    testImplementation group: 'net.runelite', name: 'client', version: runeLiteVersion
+    testImplementation group: 'net.runelite', name: 'jshell', version: runeLiteVersion
 }
 
 group = 'com.ewyboy'
 version = '1.0.0'
 
 tasks.withType(JavaCompile) {
-	options.encoding = 'UTF-8'
-	options.release.set(11)
+    options.encoding = 'UTF-8'
+    options.release.set(11)
 }

src/main/java/com/ewyboy/FriendsHouse.java

@@ -1,11 +1,9 @@
 package com.ewyboy;
 
-import net.runelite.api.*;
-import net.runelite.api.widgets.*;
-
 import net.runelite.api.Client;
-import net.runelite.api.widgets.Widget;
-import net.runelite.api.widgets.WidgetType;
+import net.runelite.api.FontID;
+import net.runelite.api.VarClientStr;
+import net.runelite.api.widgets.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

src/main/java/com/ewyboy/FriendsHouseConfig.java

@@ -5,17 +5,15 @@
 import net.runelite.client.config.ConfigItem;
 
 @ConfigGroup("Friends House")
-public interface FriendsHouseConfig extends Config
-{
-	@ConfigItem(
-		keyName = "name",
-		name = "Name",
-		description = "Name of the players house to enter"
-	)
+public interface FriendsHouseConfig extends Config {
+    @ConfigItem(
+            keyName = "name",
+            name = "Name",
+            description = "Name of the players house to enter"
+    )
 
-	default String name()
-	{
-		return null;
-	}
+    default String name() {
+        return null;
+    }
 
-}
+}