Pickaria

Multi function plugin for the Pickaria Minecraft server.

Try it · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Compiling
3. Contributing
4. Contact

About The Project

This is the plugin of the Pickaria Minecraft server.

Getting Started

This is the instructions on setting up your project locally. To get a local copy up and running follow these steps.

Prerequisites

• Gradle
• JDK 17
• Either IntelliJ IDEA or VSCode

Working on the project

Recommended setup: IntelliJ IDEA

1. Clone the repository

   # Using HTTPS
   git clone https://github.com/Pickaria/plugin-collection.git
   
   # Using SSH (recommended)
   git clone git@github.com:Pickaria/plugin-collection.git

   If using SSH, remember to add an SSH key on your GitHub profile.

2. Open the project in IntelliJ IDEA and wait for it to load everything

3. Install JDK

   1. Go to File → Project Structure
   2. In the new window, open the SDK dropdown then select Add SDK → Download JDK...
   3. This should open the following window, select the version 17 and Temurin Vendor
      
   4. Let the IDE index the newly downloaded JDK, this can take a while depending on your computer
   5. Alternatively, you can install JDK manually

      # Debian/Ubuntu
      sudo apt install openjdk-17-jdk
      
      # Fedora
      sudo dnf install java-17-openjdk

      For Windows, download Temurin from Adoptium

4. Once the JDK is set-up, open the Gradle on the right of the IDE, and click on the Reload All Gradle Projects button, this will download and index all the dependencies required by the plugins
   

5. Run the setupServer Gradle task to create a test server.

6. Once everything is done, you can run the start-server task, this will run the shadow task first and start a test server on your computer.
   While the server is running, you can run the shadow task to compile the plugins, the jar files are automatically placed in the test server's plugins folder.

Using Visual Studio Code

1. Clone the repository

   # Using HTTPS
   git clone https://github.com/Pickaria/plugin-collection.git
   
   # Using SSH (recommended)
   git clone git@github.com:Pickaria/plugin-collection.git

   If using SSH, remember to add an SSH key on your GitHub profile.
2. Open Visual Studio Code and install the Java extension, Gradle and a Kotlin extension
3. Manually install JDK

   # Debian/Ubuntu
   sudo apt install openjdk-17-jdk
   
   # Fedora
   sudo dnf install java-17-openjdk

   For Windows, download Temurin from Adoptium
4. Once JDK is set-up and Gradle extension is installed, open the Gradle tab on the left and click the Reload All Gradle Projects button, this will download and index all the dependencies required by the plugins
   
5. Run the setupServer Gradle task to create a test server.
6. Once everything is done, you can run the start-server task to start the test server and run the shadow task to compile the plugins, the jar files are automatically placed in the test server's plugins folder.

Manual setup

1. Clone the repository

   # Using HTTPS
   git clone https://github.com/Pickaria/plugin-collection.git
   
   # Using SSH (recommended)
   git clone git@github.com:Pickaria/plugin-collection.git

   If using SSH, remember to add an SSH key on your GitHub profile.
2. Run the setupServer Gradle task to create a test server.
3. Set the DESTINATION_DIRECTORY environment variable to "build" or "plugins" (optional, defaults to "plugins")
   This tells Gradle to put your plugins into the $rootDir/build directory or $rootDir/server/plugins If you set it to "build", you'll have to manually copy the files into the server's plugins directory
4. Compile using Gradle

   # Linux
   ./gradlew shadowJar
   
   # Windows
   gradlew.bat shadowJar

5. Start the test server

   cd server
   java -jar -Xmx2G paper.jar nogui

   You can also add a run shortcut in your favourite IDE.

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Check the issues page to find something you want to work on.
2. Fork the Project or create your a new branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

@pickaria - contact@pickaria.fr

Project Link: https://github.com/Pickaria/plugin-collection