Installation (FR)

Si vous utilisez Maven, QuartzLib est très simple à mettre en place dans votre projet.

Actuellement, zLib requiert au minimum Java 8 et Bukkit 1.15. Ce document vous explique comment intégrer QuartzLib dans votre projet en utilisant Maven mais cela fonctionne aussi avec d'autres systèmes incluant le shading.

Intégration de la librairie dans votre plugin

1. Ajoutez notre dépôt Maven dans votre pom.xml.

        <repository>
            <id>zdevelopers-quartzlib</id>
            <url>http://maven.carrade.eu/artifactory/snapshots</url>
        </repository>

2. Ajoutez zLib en tant que dépendance.

       <dependency>
           <groupId>fr.zcraft</groupId>
           <artifactId>quartzlib</artifactId>
           <version>0.0.1-SNAPSHOT</version>
       </dependency>

3. Ajoutez le plugin Maven maven-shade-plugin au build de votre projet. Remplacez VOTRE.PACKAGE.ICI par votre package.

        <build>
            ...
            <plugins>
                ...
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-shade-plugin</artifactId>
                    <version>2.4</version>
                    <configuration>
                        <artifactSet>
                            <includes>
                                <include>fr.zcraft:quartzlib</include>
                            </includes>
                        </artifactSet>
                        <relocations>
                            <relocation>
                                <pattern>fr.zcraft.quartzlib</pattern>
                                <shadedPattern>YOUR.OWN.PACKAGE</shadedPattern>
                            </relocation>
                        </relocations>
                    </configuration>
                    <executions>
                        <execution>
                            <phase>package</phase>
                            <goals>
                                <goal>shade</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
                ...
            </plugins>
            ...
        </build>

4. Compilez votre projet comme d'habitude en utilisant la commande suivante depuis votre répertoire de travail, ou en utilisant un outil intégré dans votre IDE.

   mvn clean install

Chargement automatique de la librairie et des composants

Actuellement, il n'y a qu'un moyen simple d'intégrer cette librairie. QuartzLib fournis sa propre version de l'habituelle classe principale JavaPlugin. Cela permet de charger et décharger semi-automatiquement les composants et le noyau de QuartzLib.

1. Dans votre classe principale, remplacez extends JavaPlugin par extends QuartzPlugin (en important QuartzPlugin depuis fr.zcraft.quartzlib.core.QuartzPlugin).

    import fr.zcraft.quartzlib.core.QuartzPlugin;
    
    public class Toaster extends QuartzPlugin
    {
        // ...
    }

2. Dans votre onEnable(), utilisez la méthode loadComponents() pour charger les composants que vous voulez utiliser.

    @Override
    public void onEnable()
    {
        loadComponents(Gui.class, Commands.class, SidebarScoreboard.class);
    }

La méthode loadComponents est le moyen standard de charger les classes (composants) utilisées dans votre plugin. C'est un outil générique pour charger des composants apportés par QuartzLib (GUI, sidebars ...), mais aussi les votres. Dans la documentation des composants de QuartzLib, la classe à charger via cette méthode sera toujours donnée.

À propos des méthodes remplacées (override)

QuartzLib surcharge la méthode onLoad.
Si vous l'utilisez, vous devez obligatoirement appeler super.onLoad() comme ci-dessous.

    @Override
    public void onLoad()
    {
        super.onLoad();
        // Votre code, placé après.
    }