Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Simplify RSPSI build process with custom Gradle task and pre-configured output directory" #7

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Rims-Naps
Copy link

Pull Request Description: Simplifying the RSPSI Build Process with a Custom Gradle Task

Overview:
This pull request introduces a significant improvement to the Gradle build process for the blurite/RSPsi project. The primary goal is to simplify the user experience by consolidating multiple build steps into a single, streamlined task. This change is particularly beneficial for users who may not be familiar with the intricacies of setting up RSPSI and its plugins.

Key Changes:

  1. Custom Gradle Task:

    • A new custom Gradle task named RSPSIJarDist has been implemented. This task replaces the need to run two separate tasks (build and assemble) to generate the editor JAR and plugins.
    • The new task can be executed directly from the main project directory using the command ./gradlew RSPSIJarDist.
  2. Output Directory Structure:

    • Instead of placing the output JAR files in the default build/libs directory, the new task creates a dedicated output directory at D:/dev/RSPSi/RSPSI-Jar/.
    • The output directory is pre-configured with the necessary structure, including a plugins folder with active and inactive subdirectories. This setup ensures that the environment is ready to use immediately after the build process completes.
  3. Simplified User Experience:

    • Users no longer need to manually set up the plugins directory or move files around after the build. The new task handles all of this automatically, reducing the potential for errors and making the process more accessible to less experienced users.

Output Directory Example:

D:/dev/RSPSi/RSPSI-Jar/
├── Editor-1.16.1.jar
└── plugins/
    ├── active/
    └── inactive/
        └── OSRSPlugin-1.7.0-BETA.jar

Testing and Compatibility:

  • The changes have been thoroughly tested and confirmed to work correctly, provided that the user is using JDK 17, as required by the repository.
  • A screenshot of the console output when running the new task in PowerShell is available for reference: Console Output Screenshot.

Why This Change is Important:

  • User-Friendly: By reducing the number of steps required to build and set up RSPSI, this change makes the tool more accessible to a broader audience, including those who may not be familiar with Gradle or the specific setup requirements of RSPSI.
  • Efficiency: The new task automates several manual steps, saving time and reducing the likelihood of errors.
  • Consistency: The pre-configured output directory ensures that all users have a consistent starting point, which can help avoid issues related to incorrect setup.

Conclusion:
This pull request represents a meaningful improvement to the build process, making it easier and more efficient for users to get started with RSPSI. The new RSPSIJarDist task simplifies the workflow, reduces the potential for errors, and ensures that the output is ready to use right out of the box.

@Z-Kris
Copy link

Z-Kris commented Feb 12, 2025

Why are there 2 jars pushed with this PR?

@Rims-Naps
Copy link
Author

Why are there 2 jars pushed with this PR?

essentially just because I forgot to add the new output directory to the .gitnore suppose I should have done that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants