Skip to content

Berehum/TeacupsPro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TeacupsPro

Initially this plugin's name was 'TeacupsPro', but it was renamed to avoid confusion with another plugin. That is why ' Teacups' might be referenced in the wiki.

Quick Navigation

📖 Documentation / Wiki

TeacupsPro has a wiki that contains the most important aspects of the plugin. Including the layout of the config files and developer API.

🌟 Highlighted Articles

💡 Support

For support, please open a GitHub issue. Please follow the layout in CONTRIBUTING.md.

💾 Downloads / Building

The latest release version of TeacupsPro can be found on Spigot. The latest build of TeacupsPro (development version) can be found on GitHub.

Alternatively, you can build TeacupsPro via Maven. Release versions of TeacupsPro are built using Java 8, you can change the target version in pom.xml.

  • ensure Java 8 is installed on your machine
  • clone this repository
  • run mvn clean install in the base directory

The final jar will be in the target/ directory.

Dependencies

TeacupsPro has ProtocolLib as a dependency. You must install ProtocolLib version 4.7.0 or higher.

🧰 Developer API

Unfortunately, there is not a fancy developer API yet. However, you are able to do some things with the current code, such as creating new show actions.

This project currently doesn't have a repository, so you'll have to download a copy of the plugin and add it to your package managing software yourself. Sorry :(

👫 Contributors

Click here to see a list of contributors.

🤝 Do you want to contribute?

Please read CONTRIBUTING.md for more information.

🙌 Credits

Cloud command framework

Credits to @Incendo for the Cloud command framework that is used in this project.

ProtocolLib (wrappers)

Credits to @dmulloy2 and @aandk for ProtocolLib, the library that simplifies working with packets a lot. Also a big thanks to them for the wrappers of the packets.

📜 License

The source code for TeacupsPro is licensed under the GNU General Public License v3.0, to view the license click here.

The artwork for TeacupsPro is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License , to learn more click here.