Skip to content
Francisco Solis edited this page Nov 29, 2021 · 5 revisions

Welcome

Welcome to the SuperCoreAPI wiki!

Plugins Using SuperCoreAPI:

Installation

Repository

Feel free to change the comment and the id of the repo.

<!-- TheProgramSrc -->
<repository>
    <id>theprogramsrc</id>
    <url>https://repo.theprogramsrc.xyz/repository/maven-public/</url>
</repository>

Latest Version

Dependency:

Replace $VERSION with the latest version

<!-- SuperCoreAPI -->
<dependency>
    <groupId>xyz.theprogramsrc</groupId>
    <artifactId>supercoreapi</artifactId>
    <version>$VERSION</version>
    <scope>compile</scope>
</dependency>

Avoiding Bugs:

To avoid bugs with other plugins using SuperCoreAPI is recommended to use this maven shade plugin (using relocation settings):

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>3.1.0</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
            <configuration>
                <createDependencyReducedPom>false</createDependencyReducedPom>
                <relocations>
                    <relocation>
                        <pattern>xyz.theprogramsrc.supercoreapi</pattern>
                        <shadedPattern>com.example.myplugin.supercoreapi</shadedPattern>
                    </relocation>
                </relocations>
            </configuration>
        </execution>
    </executions>
</plugin>

Make sure to replace com.example.myplugin with your own package.

Reporting Issues

Feel free to open a ticket or ask to the community in our discord server, you may also create a new issue.

Contributions

We're happy to see that you wanna contribute to the repo! Feel free to fork it and open a new pull request anytime! If you want to you can also donate using the Sponsor button :)

Common Problems

Having issues similar to 'X resource is missing and couldn't download it' or 'The dependency required by supercoreapi is missing'? Try adding the exact same repositories that we use with SuperCoreAPI to your project. For some unknown reason this is happening and by adding the repos we use it'll fix the issue.