vCompat

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation with Maven
   • Installation with Gradle
3. Plugins that use vCompat
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Built With

• Spigot
• SyntaxApi

Getting Started

To get a local copy up and running follow these simple steps.

Please notice that you need to authenticate with GitHub Packages (Maven / Gradle) for this to work

Installation with Maven

<depedencies>
  <depedency>
    <groupId>net.sourcewriters.minecraft</groupId>
    <artifactId>vcompat</artifactId>
    <version>3.0.0</version>
    <scope>provided</scope>
  <dependency>
<depedencies>

Installation with Gradle

plugins {
  id 'maven'
}

dependencies {
  compileOnly group: 'net.sourcewriters.minecraft', name: 'vcompat', version: '3.0.0'
}

Please use the vCompatUpdater to install vCompat for your plugin. Shading vCompat is not a good idea which is why we created that updater. To see how you can implement it for v2 / v3 of vCompat look at our vCompatExample or at one of the plugins mentioned in Plugins that use vCompat.

Plugins that use vCompat

• SkinsEvolved
• LoginPlus
• JumpLeaguePlus

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature 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

License

Distributed under the GPLv3 License. See LICENSE for more information.

Contact

@SyntaxPhoenix - [email protected]

Project Link: https://github.com/SourceWriters/vCompat