Skip to content

Dev7ex/FacilisCommon

Repository files navigation

Icon-Bild

Latest Release SpigotMC Downloads Spiget Rating Java Spigot CodeFactor Last Commit GitHub Discord Modrinth Followers


Contents

  1. Overview
  2. Features
  3. Installation
  4. Requirements
  5. Configuration
  6. Contributing
  7. License
  8. Contact

Overview

  • Facilis comes from Latin and stands for ‘simple’. And that's exactly what this library is supposed to be.
  • FacilisCommon should add as many things as possible that are missing in the BukkitAPI. The focus is on clean code and logical structure.
  • Everyone is free to add things. But that doesn't mean that I accept everything blindly. I usually edit small things and then accept them.

Features

  • Own command system with annotations
  • An extension of JavaPlugin.class called BukkitPlugin.class is available which adds useful methods
  • Utility Classes like Worlds.java or Inventorys.java

Installation

  1. Download the latest version of FacilisCommon from GitHub Releases.
  2. Copy the downloaded .jar file into the plugins directory of your Spigot server.
  3. Restart the server to activate the plugin.

Requirements

  • Minecraft Version: 1.16 - 1.20
  • Java Version: 17 or higher
  • Spigot Server

Configuration

  • After installation, a configuration file will be created in the plugins/FacilisCommon directory. Here, you can make various settings.
config.yml
#  ______         _ _ _      _____
# |  ____|       (_) (_)    / ____|
# | |__ __ _  ___ _| |_ ___| |     ___  _ __ ___  _ __ ___   ___  _ __
# |  __/ _` |/ __| | | / __| |    / _ \| '_ ` _ \| '_ ` _ \ / _ \| '_ \
# | | | (_| | (__| | | \__ \ |___| (_) | | | | | | | | | | | (_) | | | |
# |_|  \__,_|\___|_|_|_|___/\_____\___/|_| |_| |_|_| |_| |_|\___/|_| |_|
#
# Copyright (c) 2023 by Dev7ex
# Version: ${project.version}
# Software: Your Software
config-version: ${project.version}
# General
prefix: '§8[§cFacilisCommon§8]§r'
no-permission: '§cIm sorry, but you do not have permission to perform this command. Please contact the server administrators if you believe that is in error.'

Contributing

We welcome contributions to FacilisCommon! If you'd like to contribute, please follow these guidelines:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure the code passes any existing tests.
  4. Commit your changes and push them to your fork.
  5. Submit a pull request, explaining the changes you've made and why they should be merged.
  6. Ensure your pull request adheres to the code style and guidelines of the project.

Thank you for contributing to FacilisCommon!

License

The FacilisCommon project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.

Contact

If you have any questions or need support, you can reach out to Dev7ex via: