Skip to content

SpoilerRules/server-list-explorer

Repository files navigation

Server List Explorer

Compose Desktop

Server List Explorer is the ultimate tool for effortlessly managing your Minecraft: Java Edition server list and, soon, your single-player world list. It has a sleek, utilitarian design that follows Material 3 Design principles. Discover all the features on our Feature List on the wiki, and check out the User Interface Preview to see the project up close.

User Interface Preview

Screenshot 1 Screenshot 2
Screenshot 3 Screenshot 4
Screenshot 5 Screenshot 6
Screenshot 7 Screenshot 8
Screenshot 9 Screenshot 10

Table of Contents

How to Run the Project

This project is built using Gradle and requires Java 17 or higher to run. Follow the steps below to build and execute the application:

1. Build the Project

From the root of the project, run the following Gradle task to generate the shadow JAR:

./gradlew :app:shadowJar

This task will produce a fat JAR (a JAR containing all dependencies) that can be run independently.

2. Locate the JAR

Once the build completes, the generated JAR files can be found in the app/build/libs/ directory:

  • Shadow JAR (includes all dependencies): ServerListExplorer-all.jar This is the recommended JAR to run for ease of use.

  • Normal JAR (without bundled dependencies): ServerListExplorer.jar Use this only if you plan to manage dependencies manually.

3. Run the Application

Run the shadow JAR using Java 17 or higher:

java -jar app/build/libs/ServerListExplorer-all.jar

If you prefer the normal JAR, make sure to provide all required dependencies on the classpath.

Wiki

For detailed usage instructions and troubleshooting tips, please refer to the GitHub Wiki.