refactor: rename project to MCServerFinder

AkramLZ · AkramLZ · commit d900a1cf2da8 · 2025-08-05T12:32:53.000+01:00
diff --git a/README.md b/README.md
@@ -1,24 +1,25 @@
-![banner](assets/noteblock-logo.svg)
+![banner](assets/mcsf-logo.png)
 
-# NoteblockAPI (In development)
+# MCServerFinder Java API (In development)
 
-The official API implementation in Java for the Noteblock platform. This API allows server owners and developers to retrieve and update information about Minecraft servers on Noteblock.
+The official API implementation in Java for the MCServerFinder platform. This API allows server owners and developers to 
+etrieve and update information about Minecraft servers on MCServerFinder.
 
-## What is Noteblock?
+## What is MCServerFinder?
 
-Noteblock is a platform, launched in April 2025, for discovering Minecraft servers. It features curated server
+MCServerFinder is a platform, launched in April 2025, for discovering Minecraft servers. It features curated server
 listings across categories such as PvP, Creative, Adventure, Minigames, etc. Including real-time server leaderboards, community feedback,
-and trending picks. Noteblock makes it easy for players to find their next favorite server.
+and trending picks. MCServerFinder makes it easy for players to find their next favorite server.
 
 ## Documentation
 
-Click [here](https://noteblock.gg/api/documentation) to check out the API documentation. (Heavily subject to change)
+Click [here](https://mcserverfinder.com/api/documentation) to check out the API documentation. (Heavily subject to change)
 
 ## Usage
 
 You may use the [Ultimis repository](https://repo.ultimismc.com/) to download one or more of the following as a dependency artifact:
-- [noteblock-api](noteblock-api/)
-- [noteblock-api-transport-core](noteblock-api-transport-core/)
+- [mcsf-api](mcsf-api/)
+- [mcsf-api-transport-core](mcsf-api-transport-core/)
 
 ### Maven
 ```xml
@@ -32,7 +33,7 @@ You may use the [Ultimis repository](https://repo.ultimismc.com/) to download on
 <dependencies>
     <dependency>
         <groupId>gg.makera</groupId>
-        <artifactId>noteblock-api</artifactId>
+        <artifactId>mcsf-api</artifactId>
         <version>0.1.0-SNAPSHOT</version>
     </dependency>
 </dependencies>
@@ -45,7 +46,7 @@ repositories {
 }
 
 dependencies {
-    implementation("gg.makera:noteblock-api:0.1.0-SNAPSHOT")
+    implementation("gg.makera:mcsf-api:0.1.0-SNAPSHOT")
 }
 ```
 
@@ -56,13 +57,13 @@ public final class Example {
 
     public static void main(String[] args) {
         // Note: Given that CompletableFuture#join is a blocking operation, we'll be using it to prevent the
-        // NoteblockAPI instance from closing before we've received a response. Use #thenAccept instead.
+        // MCSFAPI instance from closing before we've received a response. Use #thenAccept instead.
 
-        // Create a new NoteblockAPI instance with an API key
+        // Create a new MCSFAPI instance with an API key
 
-        try (NoteblockAPI noteblockAPI = NoteblockAPIFactory.create("your-api-key-here")) {
+        try (MCSFAPI mcsfAPI = MCSFAPIFactory.create("your-api-key-here")) {
             // Fetch server information by server id, then wait for a response.
-            ServerInfoResponse serverInfoResponse = noteblockAPI.getServerInfo(22).join();
+            ServerInfoResponse serverInfoResponse = mcsfAPI.getServerInfo(22).join();
 
             // Get the server object from the response.
             Server server = serverInfoResponse.getServer();
@@ -74,7 +75,7 @@ public final class Example {
 
             // Leaderboards
             // Fetch server leaderboard by server id and leaderboard id, then wait for a response.
-            LeaderboardInfoResponse leaderboardInfoResponse = noteblockAPI.getLeaderboardInfo(22, "kills").join();
+            LeaderboardInfoResponse leaderboardInfoResponse = mcsfAPI.getLeaderboardInfo(22, "kills").join();
 
             // Get the leaderboard object from the response
             LeaderboardInfoResponse.Leaderboard leaderboard = leaderboardInfoResponse.getLeaderboard();
diff --git a/assets/mcsf-logo.png b/assets/mcsf-logo.png
diff --git a/assets/noteblock-logo.svg b/assets/noteblock-logo.svg
diff --git a/mcsf-api-transport-core/build.gradle.kts b/mcsf-api-transport-core/build.gradle.kts
diff --git a/mcsf-api-transport-core/src/main/java/gg/makera/mcsf/api/transport/DefaultMCSFTransport.java b/mcsf-api-transport-core/src/main/java/gg/makera/mcsf/api/transport/DefaultMCSFTransport.java
@@ -1,4 +1,4 @@
-package gg.makera.noteblock.api.transport;
+package gg.makera.mcsf.api.transport;
 
 import org.jetbrains.annotations.NotNull;
 
@@ -8,7 +8,7 @@
 import java.net.http.HttpResponse;
 import java.util.concurrent.CompletableFuture;
 
-public final class DefaultNoteblockTransport implements NoteblockTransport {
+public final class DefaultMCSFTransport implements MCSFTransport {
 
     private final HttpClient httpClient = HttpClient.newHttpClient();
 
diff --git a/mcsf-api-transport-core/src/main/java/gg/makera/mcsf/api/transport/MCSFTransport.java b/mcsf-api-transport-core/src/main/java/gg/makera/mcsf/api/transport/MCSFTransport.java
@@ -1,10 +1,10 @@
-package gg.makera.noteblock.api.transport;
+package gg.makera.mcsf.api.transport;
 
 import org.jetbrains.annotations.NotNull;
 
 import java.util.concurrent.CompletableFuture;
 
-public interface NoteblockTransport {
+public interface MCSFTransport {
 
     CompletableFuture<ResponseData> sendRequest(@NotNull Request request);
 
diff --git a/mcsf-api-transport-core/src/main/java/gg/makera/mcsf/api/transport/Request.java b/mcsf-api-transport-core/src/main/java/gg/makera/mcsf/api/transport/Request.java
@@ -1,4 +1,4 @@
-package gg.makera.noteblock.api.transport;
+package gg.makera.mcsf.api.transport;
 
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
diff --git a/mcsf-api-transport-core/src/main/java/gg/makera/mcsf/api/transport/ResponseData.java b/mcsf-api-transport-core/src/main/java/gg/makera/mcsf/api/transport/ResponseData.java
@@ -1,4 +1,4 @@
-package gg.makera.noteblock.api.transport;
+package gg.makera.mcsf.api.transport;
 
 import org.jetbrains.annotations.NotNull;
 
diff --git a/mcsf-api/build.gradle.kts b/mcsf-api/build.gradle.kts
@@ -1,4 +1,4 @@
 dependencies {
-    implementation(project(":noteblock-api-transport-core"))
+    implementation(project(":mcsf-api-transport-core"))
     implementation("com.google.code.gson:gson:2.13.1")
 }
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/MCSFAPI.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/MCSFAPI.java
@@ -1,18 +1,18 @@
-package gg.makera.noteblock.api;
+package gg.makera.mcsf.api;
 
-import gg.makera.noteblock.api.response.LeaderboardInfoResponse;
-import gg.makera.noteblock.api.response.LeaderboardUpdateResponse;
-import gg.makera.noteblock.api.response.ServerInfoResponse;
-import gg.makera.noteblock.api.response.UserInfoResponse;
+import gg.makera.mcsf.api.response.LeaderboardInfoResponse;
+import gg.makera.mcsf.api.response.LeaderboardUpdateResponse;
+import gg.makera.mcsf.api.response.ServerInfoResponse;
+import gg.makera.mcsf.api.response.UserInfoResponse;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 
-public interface NoteblockAPI extends AutoCloseable {
+public interface MCSFAPI extends AutoCloseable {
 
-    String API_URL = "https://noteblock.gg/api/v1/";
-    String USER_AGENT = "NoteblockAPI/0.1.0";
+    String API_URL = "https://mcserverfinder.com/api/v1/";
+    String USER_AGENT = "MCServerFinderAPI/0.1.0";
 
     CompletableFuture<ServerInfoResponse> getServerInfo(int serverId);
 
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/MCSFAPIFactory.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/MCSFAPIFactory.java
@@ -0,0 +1,24 @@
+package gg.makera.mcsf.api;
+
+import gg.makera.mcsf.api.transport.DefaultMCSFTransport;
+import gg.makera.mcsf.api.transport.MCSFTransport;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.function.Supplier;
+
+public final class MCSFAPIFactory {
+
+    private static final Supplier<MCSFTransport> DEFAULT_TRANSPORT_SUPPLIER = DefaultMCSFTransport::new;
+
+    private MCSFAPIFactory() {}
+
+    @NotNull
+    public static MCSFAPI create(@NotNull MCSFTransport transport, @NotNull String apiKey) {
+        return new MCSFAPIImpl(transport, apiKey);
+    }
+
+    @NotNull
+    public static MCSFAPI create(@NotNull String apiKey) {
+        return create(DEFAULT_TRANSPORT_SUPPLIER.get(), apiKey);
+    }
+}
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/MCSFAPIImpl.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/MCSFAPIImpl.java
@@ -1,32 +1,32 @@
-package gg.makera.noteblock.api;
+package gg.makera.mcsf.api;
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonObject;
-import gg.makera.noteblock.api.exception.BadResponseCodeException;
-import gg.makera.noteblock.api.exception.InconsistentResponseFormatException;
-import gg.makera.noteblock.api.request.*;
-import gg.makera.noteblock.api.response.*;
-import gg.makera.noteblock.api.transport.NoteblockTransport;
-import gg.makera.noteblock.api.transport.Request;
-import gg.makera.noteblock.api.transport.ResponseData;
+import gg.makera.mcsf.api.exception.BadResponseCodeException;
+import gg.makera.mcsf.api.exception.InconsistentResponseFormatException;
+import gg.makera.mcsf.api.request.*;
+import gg.makera.mcsf.api.response.*;
+import gg.makera.mcsf.api.transport.MCSFTransport;
+import gg.makera.mcsf.api.transport.Request;
+import gg.makera.mcsf.api.transport.ResponseData;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Map;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 
-public final class NoteblockAPIImpl implements NoteblockAPI {
+public final class MCSFAPIImpl implements MCSFAPI {
 
     private static final Gson GSON = new GsonBuilder().create();
 
     private static final String API_KEY_HEADER_NAME = "X-API-Key";
     private static final String USER_AGENT_HEADER_NAME = "User-Agent";
 
-    private final NoteblockTransport transport;
+    private final MCSFTransport transport;
     private final String apiKey;
 
-    NoteblockAPIImpl(@NotNull NoteblockTransport transport, @NotNull String apiKey) {
+    MCSFAPIImpl(@NotNull MCSFTransport transport, @NotNull String apiKey) {
         this.transport = transport;
         this.apiKey = apiKey;
     }
@@ -55,8 +55,8 @@ public CompletableFuture<UserInfoResponse> getUserInfo() {
         return request(UserInfoResponse.class, new UserInfoRequest());
     }
 
-    private <T extends NoteblockResponse> CompletableFuture<T> request(Class<T> expectedResponseClass,
-                                                                       NoteblockRequest request) {
+    private <T extends MCSFResponse> CompletableFuture<T> request(Class<T> expectedResponseClass,
+                                                                  MCSFRequest request) {
         Request.Builder requestDataBuilder = Request.builder()
                 .header("Content-Type", "application/json")
                 .header(API_KEY_HEADER_NAME, apiKey)
@@ -72,7 +72,7 @@ private <T extends NoteblockResponse> CompletableFuture<T> request(Class<T> expe
                 .thenApply(responseData -> processResponse(responseData, expectedResponseClass));
     }
 
-    private <T extends NoteblockResponse> T processResponse(ResponseData responseData, Class<T> responseClass) {
+    private <T extends MCSFResponse> T processResponse(ResponseData responseData, Class<T> responseClass) {
         int code = responseData.getCode();
         String body = responseData.getBody();
 
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/exception/BadResponseCodeException.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/exception/BadResponseCodeException.java
@@ -1,4 +1,4 @@
-package gg.makera.noteblock.api.exception;
+package gg.makera.mcsf.api.exception;
 
 public class BadResponseCodeException extends RuntimeException {
 
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/exception/InconsistentResponseFormatException.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/exception/InconsistentResponseFormatException.java
@@ -1,4 +1,4 @@
-package gg.makera.noteblock.api.exception;
+package gg.makera.mcsf.api.exception;
 
 public class InconsistentResponseFormatException extends RuntimeException {
 
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/request/LeaderboardInfoRequest.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/request/LeaderboardInfoRequest.java
@@ -1,8 +1,8 @@
-package gg.makera.noteblock.api.request;
+package gg.makera.mcsf.api.request;
 
 import org.jetbrains.annotations.NotNull;
 
-public final class LeaderboardInfoRequest implements NoteblockRequest {
+public final class LeaderboardInfoRequest implements MCSFRequest {
 
     private static final String RESOURCE = "leaderboard/%s/%s";
 
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/request/LeaderboardUpdateRequest.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/request/LeaderboardUpdateRequest.java
@@ -1,11 +1,11 @@
-package gg.makera.noteblock.api.request;
+package gg.makera.mcsf.api.request;
 
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Map;
 import java.util.UUID;
 
-public final class LeaderboardUpdateRequest implements NoteblockRequest {
+public final class LeaderboardUpdateRequest implements MCSFRequest {
 
     private static final String RESOURCE = "leaderboard/update/%s/%s";
 
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/request/MCSFRequest.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/request/MCSFRequest.java
@@ -1,4 +1,4 @@
-package gg.makera.noteblock.api.request;
+package gg.makera.mcsf.api.request;
 
 import org.jetbrains.annotations.NotNull;
 
@@ -8,7 +8,7 @@
 /**
  * Represents an API request
  */
-public interface NoteblockRequest {
+public interface MCSFRequest {
 
     @NotNull
     String getResource();
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/request/ServerInfoRequest.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/request/ServerInfoRequest.java
@@ -1,8 +1,8 @@
-package gg.makera.noteblock.api.request;
+package gg.makera.mcsf.api.request;
 
 import org.jetbrains.annotations.NotNull;
 
-public final class ServerInfoRequest implements NoteblockRequest {
+public final class ServerInfoRequest implements MCSFRequest {
 
     private static final String RESOURCE = "server/%s";
 
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/request/UserInfoRequest.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/request/UserInfoRequest.java
@@ -1,8 +1,8 @@
-package gg.makera.noteblock.api.request;
+package gg.makera.mcsf.api.request;
 
 import org.jetbrains.annotations.NotNull;
 
-public class UserInfoRequest implements NoteblockRequest {
+public class UserInfoRequest implements MCSFRequest {
 
     @Override
     public @NotNull String getResource() {
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/response/LeaderboardInfoResponse.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/response/LeaderboardInfoResponse.java
@@ -1,12 +1,12 @@
-package gg.makera.noteblock.api.response;
+package gg.makera.mcsf.api.response;
 
 import com.google.gson.annotations.SerializedName;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Date;
 import java.util.List;
 
-public final class LeaderboardInfoResponse implements NoteblockResponse {
+public final class LeaderboardInfoResponse implements MCSFResponse {
 
     private Leaderboard leaderboard;
 
@@ -35,7 +35,7 @@ public String getName() {
         }
 
         /**
-         * Gets the legend of this leaderboard as displayed on the Noteblock platform.
+         * Gets the legend of this leaderboard as displayed on the MCServerFinder platform.
          * For instance: {@code Top Kills} {@code Top Deaths}.
          *
          * @return the legend of this leaderboard
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/response/LeaderboardUpdateResponse.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/response/LeaderboardUpdateResponse.java
@@ -1,9 +1,9 @@
-package gg.makera.noteblock.api.response;
+package gg.makera.mcsf.api.response;
 
 import com.google.gson.annotations.SerializedName;
 import org.jetbrains.annotations.NotNull;
 
-public final class LeaderboardUpdateResponse implements NoteblockResponse {
+public final class LeaderboardUpdateResponse implements MCSFResponse {
 
     private String message;
 
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/response/MCSFResponse.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/response/MCSFResponse.java
@@ -1,7 +1,7 @@
-package gg.makera.noteblock.api.response;
+package gg.makera.mcsf.api.response;
 
 /**
  * Represents an API response. This interface is only used as a generic marker for API requests to indicate
  * that a class represents an API response.
  */
-public interface NoteblockResponse {}
+public interface MCSFResponse {}
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/response/Server.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/response/Server.java
@@ -1,12 +1,12 @@
-package gg.makera.noteblock.api.response;
+package gg.makera.mcsf.api.response;
 
 import com.google.gson.annotations.SerializedName;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Date;
 
 /**
- * Represents a Noteblock server
+ * Represents a MCServerFinder server
  */
 public final class Server {
 
@@ -49,7 +49,7 @@ public final class Server {
 
     /**
      * Gets the id that references this server
-     * in the Noteblock database.
+     * in the MCServerFinder database.
      *
      * @return id of the server
      */
@@ -211,7 +211,7 @@ public String getName() {
         }
 
         /**
-         * Gets the sort priority of this category on the Noteblock platform.
+         * Gets the sort priority of this category on the MCServerFinder platform.
          *
          * @return sort priority of this category
          */
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/response/ServerInfoResponse.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/response/ServerInfoResponse.java
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/response/User.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/response/User.java
diff --git a/mcsf-api/src/main/java/gg/makera/mcsf/api/response/UserInfoResponse.java b/mcsf-api/src/main/java/gg/makera/mcsf/api/response/UserInfoResponse.java
diff --git a/noteblock-api/src/main/java/gg/makera/noteblock/api/NoteblockAPIFactory.java b/noteblock-api/src/main/java/gg/makera/noteblock/api/NoteblockAPIFactory.java
diff --git a/settings.gradle.kts b/settings.gradle.kts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package gg.makera.noteblock.api.transport;`
	`1`	`+package gg.makera.mcsf.api.transport;`
`2`	`2`
`3`	`3`	`import org.jetbrains.annotations.Contract;`
`4`	`4`	`import org.jetbrains.annotations.NotNull;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`dependencies {`
`2`		`- implementation(project(":noteblock-api-transport-core"))`
	`2`	`+ implementation(project(":mcsf-api-transport-core"))`
`3`	`3`	`implementation("com.google.code.gson:gson:2.13.1")`
`4`	`4`	`}`