diff --git a/CODE_OF_CONDUCT.MD b/CODE_OF_CONDUCT.MD index 31b3d81b5..06e831d4a 100644 --- a/CODE_OF_CONDUCT.MD +++ b/CODE_OF_CONDUCT.MD @@ -2,17 +2,14 @@ ## Our Pledge -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making +participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, +disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, +socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards -Examples of behavior that contributes to creating a positive environment -include: +Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences @@ -22,53 +19,42 @@ include: Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances +* The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take +appropriate and fair corrective action in response to any instances of unacceptable behavior. -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, +issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the +project or its community. Examples of representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed representative at an online or offline +event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at blobmansrealm@gmail.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at +blobmansrealm@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed +necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to +the reporter of an incident. Further details of specific enforcement policies may be posted separately. -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent +repercussions as determined by other members of the project's leadership. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available +at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html [homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 6406bf4a4..fcf748624 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -1,6 +1,8 @@ # CombatLogX Contribution Guide + 1) Try to keep the code style the same, do not use Eclipse/IntelliJ auto-formatters. -2) If you are going to be a adding a feature, you might as well create an expansion instead. Expansions have access to the Bukkit API as well as the CombatLogX API. +2) If you are going to be a adding a feature, you might as well create an expansion instead. Expansions have access to + the Bukkit API as well as the CombatLogX API. 3) If you make a lot of changes, please create a detailed summary. 4) Follow the GitHub rules, project license, and all guidelines. 5) Good Luck and have fun! diff --git a/README.MD b/README.MD index 61a64f955..0a9138648 100644 --- a/README.MD +++ b/README.MD @@ -1,55 +1,68 @@ # CombatLogX + [![Code Size](https://img.shields.io/github/languages/code-size/SirBlobman/CombatLogX)](https://github.com/SirBlobman/CombatLogX/) [![Build Status](https://jenkins.sirblobman.xyz/job/SirBlobman/job/CombatLogX/badge/icon)](https://jenkins.sirblobman.xyz/job/SirBlobman/job/CombatLogX/) [![Crowdin Localization](https://badges.crowdin.net/combatlogx-spigot-plugin/localized.svg)](https://crowdin.com/project/combatlogx-spigot-plugin) # Description + CombatLogX is a plugin made for the Spigot server software. It has many combat-related features to add to your server. -One of the main features of this plugin are the Expansions, which are like modules that allow you to add different things and change how the plugin works. +One of the main features of this plugin are the Expansions, which are like modules that allow you to add different +things and change how the plugin works. # Dependencies + - [Spigot 1.8.8 - 1.17.1](https://spigotmc.org/) - [SirBlobmanCore 2.3.1 or higher](https://jenkins.sirblobman.xyz/job/SirBlobman/job/SirBlobmanAPI/) ## Main Features + - Custom expansions that change how the plugin works - Tag players when they attack other players - Punish players that log out during combat ## Installation Guide + 1. Download the CombatLogX.zip file from Jenkins or SpigotMC -2. Stop your server. (Click the stop button on the panel or type `stop` into the console if your server doesn't use a panel.) +2. Stop your server. (Click the stop button on the panel or type `stop` into the console if your server doesn't use a + panel.) 3. Upload the contents of CombatLogX.zip to your server. 4. Delete the CombatLogX.zip file. 5. If the files were uploaded and extracted correctly, your server should have the following files: - - File: `/plugins/CombatLogX.jar` - - File `/plugins/SirBlobmanCore.jar` - - Folder: `/plugins/CombatLogX/` - - Folder: `/plugins/CombatLogX/expansions/` - - Multiple Files: `/plugins/CombatLogX/expansions/*.jar` + - File: `/plugins/CombatLogX.jar` + - File `/plugins/SirBlobmanCore.jar` + - Folder: `/plugins/CombatLogX/` + - Folder: `/plugins/CombatLogX/expansions/` + - Multiple Files: `/plugins/CombatLogX/expansions/*.jar` 6. Start your server. (Click the start button on the panel or execute the script if your server doesn't use a panel.) 7. Edit the configuration files for the main plugin, languages, and expansions. 8. Type the command `/clx reload` to reload the configuration files. ## Localization + A translation project for CombatLogX V11 is in progress. If you wish to help out, please visit the Crowdin page below: https://crowdin.com/project/combatlogx-spigot-plugin ### Localization Credits + https://crowdin.com/project/combatlogx-spigot-plugin/reports/top-members ## Expansions + If you want to find out more about the expansions, please visit this page: You can also open the README files in each expansion folder. ## Developer API -If you are looking for the source for the current version on Spigot (10.3.8.3), please check the "old/10.0.0.0" branch. + +If you are looking for the source for the current version on Spigot (10.3.8.3), please check the "old/10.0.0.0" +branch. If you want to create expansions or learn how to use the CombatLogX API for V11/Beta, please visit this page: [API README](api/README.MD) ## Support + Support is provided by creating a new issue, or by chatting with the Support Team on my discord. **Discord Link:** diff --git a/api/README.MD b/api/README.MD index d02f00080..d42555515 100644 --- a/api/README.MD +++ b/api/README.MD @@ -1,11 +1,14 @@ # CombatLogX API + This is the API module for CombatLogX. You can use it to create new expansions or to check stuff with your own plugin. ## Maven Repository + A lot of developers use maven to build projects more easily. **Repository: SirBlobman Public** + ```xml @@ -17,6 +20,7 @@ A lot of developers use maven to build projects more easily. ``` **Dependency: CombatLogX API** + ```xml @@ -30,8 +34,10 @@ A lot of developers use maven to build projects more easily. ``` ## Events + A list of events and their uses can be found in the `com.github.sirblobman.combatlogx.api.event` package. You can see more information about them below: + - **PlayerPreTagEvent:** Triggered before a player gets tagged. (cancellable) - **PlayerTagEvent:** Triggered when a player gets tagged into combat (not cancellable). - **PlayerReTagEvent:** Triggered when a player already has a timer, but they are tagged again. (cancellable) @@ -39,10 +45,12 @@ You can see more information about them below: - **PlayerPunishEvent:** Triggered when a player is going to be punished for logging out (cancellable). ## Other API Uses + CombatLogX has many uses, but some common examples are provided below. Good luck with your coding! **Example 01: Check if a player is in combat.** + ```java public boolean isInCombat(Player player) { // You need to ensure that CombatLogX is enabled before using it for anything. diff --git a/api/src/main/java/com/github/sirblobman/combatlogx/api/expansion/Expansion.java b/api/src/main/java/com/github/sirblobman/combatlogx/api/expansion/Expansion.java index abe4bf865..58653d346 100644 --- a/api/src/main/java/com/github/sirblobman/combatlogx/api/expansion/Expansion.java +++ b/api/src/main/java/com/github/sirblobman/combatlogx/api/expansion/Expansion.java @@ -31,6 +31,7 @@ public abstract class Expansion implements IResourceHolder { private ExpansionLogger logger; private ExpansionDescription description; private ConfigurationManager configurationManager; + public Expansion(ICombatLogX plugin) { this.plugin = Validate.notNull(plugin, "plugin must not be null!"); this.listenerList = new ArrayList<>(); diff --git a/expansion/action-bar/README.MD b/expansion/action-bar/README.MD index 5c2087e17..ed74e8b22 100644 --- a/expansion/action-bar/README.MD +++ b/expansion/action-bar/README.MD @@ -1,10 +1,13 @@ # CombatLogX Expansion: Action Bar + The action bar expansion shows an action bar to every player that is in combat. ## Features + - Customizable action bar message and progress bar. - Progress bar changes as timer goes down. ## Commands + - **/combatlogx toggle:** - **/combatlogx toggle actionbar:** Enable or disable your action bar display. diff --git a/expansion/boss-bar/README.MD b/expansion/boss-bar/README.MD index d3aa4a314..e0f06df33 100644 --- a/expansion/boss-bar/README.MD +++ b/expansion/boss-bar/README.MD @@ -1,11 +1,14 @@ # CombatLogX Expansion: Boss Bar + The boss bar expansion shows a boss bar to every player that is in combat. ## Features + - Customizable bar color and style. - Customizable boss bar message. - Boss Bar health changes as timer goes down. ## Commands + - **/combatlogx toggle:** - - **/combatlogx toggle bossbar:** Enable or disable your boss bar display. + - **/combatlogx toggle bossbar:** Enable or disable your boss bar display. diff --git a/expansion/cheat-prevention/expansion/src/main/java/combatlogx/expansion/cheat/prevention/listener/ListenerBlocks.java b/expansion/cheat-prevention/expansion/src/main/java/combatlogx/expansion/cheat/prevention/listener/ListenerBlocks.java index aa94458cd..fe6cc0c3f 100644 --- a/expansion/cheat-prevention/expansion/src/main/java/combatlogx/expansion/cheat/prevention/listener/ListenerBlocks.java +++ b/expansion/cheat-prevention/expansion/src/main/java/combatlogx/expansion/cheat/prevention/listener/ListenerBlocks.java @@ -28,7 +28,7 @@ public void onInteract(PlayerInteractEvent e) { if(action != Action.RIGHT_CLICK_BLOCK && action != Action.LEFT_CLICK_BLOCK) { return; } - + Block block = e.getClickedBlock(); if(block == null) { return; diff --git a/expansion/compatibility/Citizens/src/main/java/combatlogx/expansion/compatibility/citizens/object/StoredInventory.java b/expansion/compatibility/Citizens/src/main/java/combatlogx/expansion/compatibility/citizens/object/StoredInventory.java index 318c142fe..054a5a9d4 100644 --- a/expansion/compatibility/Citizens/src/main/java/combatlogx/expansion/compatibility/citizens/object/StoredInventory.java +++ b/expansion/compatibility/Citizens/src/main/java/combatlogx/expansion/compatibility/citizens/object/StoredInventory.java @@ -83,19 +83,19 @@ public static StoredInventory createFrom(CitizensExpansion expansion, Configurat return storedInventory; } - + @SuppressWarnings("deprecation") private static void setHandLegacy(StoredInventory stored, PlayerInventory playerInventory) { ItemStack item = playerInventory.getItemInHand(); stored.setMainHand(item); stored.setOffHand(null); } - + private static void setHandModern(StoredInventory stored, PlayerInventory playerInventory) { stored.setMainHand(playerInventory.getItemInMainHand()); stored.setOffHand(playerInventory.getItemInOffHand()); } - + @Nullable private static ItemStack loadItemStack(CitizensExpansion expansion, ConfigurationSection section, String path) { Validate.notNull(section, "section must not be null!"); diff --git a/expansion/compatibility/MVdWPlaceholderAPI/README.MD b/expansion/compatibility/MVdWPlaceholderAPI/README.MD index 24f1df500..6c0113a5b 100644 --- a/expansion/compatibility/MVdWPlaceholderAPI/README.MD +++ b/expansion/compatibility/MVdWPlaceholderAPI/README.MD @@ -1,12 +1,15 @@ # CombatLogX Expansion: MVdWPlaceholderAPI Compatibility + The MVdWPlaceholderAPI Compatibility expansion for CombatLogX adds placeholders to plugins that use MVdWPlaceholderAPI. ## Valid Placeholders + | Placeholder | Description | | ----------- | ----------- | | `{combatlogx_time_left}` | This is the amount of time (in seconds) that a player has left in combat. The zero value can be customized in the language files. | | `{combatlogx_in_combat}` | This displays different configurable values when a player is in combat and when they are not. | -| `{combatlogx_status}` | This displays different configurable values when a player is in combat and when they are not. *Different than in_combat* | +| `{combatlogx_status}` | This displays different configurable values when a player is in combat and when they are not. * +Different than in_combat* | | `{combatlogx_punishment_count}` | This displays the amount of times a player has been punished for logging out during combat. | | `{combatlogx_enemy_name}` | This shows the name of the current enemy entity (or unknown). | | `{combatlogx_enemy_diplay_name}` | This shows the display name of the current enemy entity (or unknown). | diff --git a/expansion/compatibility/PlaceholderAPI/README.MD b/expansion/compatibility/PlaceholderAPI/README.MD index 8121d01cf..9d5784a01 100644 --- a/expansion/compatibility/PlaceholderAPI/README.MD +++ b/expansion/compatibility/PlaceholderAPI/README.MD @@ -1,12 +1,15 @@ # CombatLogX Expansion: PlaceholderAPI Compatibility + The PlaceholderAPI Compatibility expansion for CombatLogX adds placeholders to plugins that use PlaceholderAPI. ## Valid Placeholders + | Placeholder | Description | | ----------- | ----------- | | `%combatlogx_time_left%` | This is the amount of time (in seconds) that a player has left in combat. The zero value can be customized in the language files. | | `%combatlogx_in_combat%` | This displays different configurable values when a player is in combat and when they are not. | -| `%combatlogx_status%` | This displays different configurable values when a player is in combat and when they are not. *Different than in_combat* | +| `%combatlogx_status%` | This displays different configurable values when a player is in combat and when they are not. * +Different than in_combat* | | `%combatlogx_punishment_count%` | This displays the amount of times a player has been punished for logging out during combat. | | `%combatlogx_enemy_name%` | This shows the name of the current enemy entity (or unknown). | | `{combatlogx_enemy_diplay_name%` | This shows the display name of the current enemy entity (or unknown). | diff --git a/expansion/compatibility/README.MD b/expansion/compatibility/README.MD index 6c93f4461..af825e1ff 100644 --- a/expansion/compatibility/README.MD +++ b/expansion/compatibility/README.MD @@ -1,7 +1,9 @@ # CombatLogX Compatibility Expansions + Compatibility expansions add features to CombatLogX based on the plugin that they add compatibility for. ## Compatibility Table + @@ -77,13 +79,15 @@ Compatibility expansions add features to CombatLogX based on the plugin that the
## Placeholder List + Surround with `%%` for PlaceholderAPI or `{}` for MVdWPlaceholderAPI. | Placeholder | Description | | ----------- | ----------- | | `combatlogx_time_left` | This is the amount of time (in seconds) that a player has left in combat. The zero value can be customized in the language files. | | `combatlogx_in_combat` | This displays different configurable values when a player is in combat and when they are not. | -| `combatlogx_status` | This displays different configurable values when a player is in combat and when they are not. *Different than in_combat* | +| `combatlogx_status` | This displays different configurable values when a player is in combat and when they are not. * +Different than in_combat* | | `combatlogx_enemy_name` | This shows the name of the current enemy entity (or unknown). | | `combatlogx_enemy_health` | This displays the health decimal of the current enemy entity (or unknown) | | `combatlogx_enemy_health_rounded` | This shows the health integer of the current enemy entity (or unknown) | diff --git a/expansion/damage-tagger/README.MD b/expansion/damage-tagger/README.MD index a17d84279..f6574975b 100644 --- a/expansion/damage-tagger/README.MD +++ b/expansion/damage-tagger/README.MD @@ -1,7 +1,9 @@ # CombatLogX Expansion: Damage Tagger + The damage tagger expansion allows you to tag players for non-combat damage types. ## Available Damage Types: + | Damage Type | Description | | ----------- | ----------- | | **CONTACT** | Touching a cactus or a berry bush. | diff --git a/expansion/death-effects/README.MD b/expansion/death-effects/README.MD index 45de2d0c3..578003008 100644 --- a/expansion/death-effects/README.MD +++ b/expansion/death-effects/README.MD @@ -1,8 +1,10 @@ # CombatLogX Expansion: Death Effects -The death effects expansion creates different effects when players die. -You can configure these effects to trigger for combat-log deaths or for all deaths. + +The death effects expansion creates different effects when players die. You can configure these effects to trigger for +combat-log deaths or for all deaths. ## Available Death Effects: + | Effect | Description | | ----------- | ----------- | | **LIGHTNING** | Spawn a lightning bolt at a player's location. Configurable silence and effect-only. | diff --git a/expansion/force-field/README.MD b/expansion/force-field/README.MD index ed0e8803d..c736b89f4 100644 --- a/expansion/force-field/README.MD +++ b/expansion/force-field/README.MD @@ -1,10 +1,15 @@ # CombatLogX Expansion: Force Field -The force field expansion shows a border around protected non-pvp areas. -You must have at least one compatibility expansion to use the force field. + +The force field expansion shows a border around protected non-pvp areas. You must have at least one compatibility +expansion to use the force field. ## Disclaimers: + - The force field is a nice visual effect that shows players areas they cannot enter. -- The force field should not be used as entry prevention, as players can just ignore the fake block packets that are sent to them. -- For the actual entry prevention options, please check the configuration for your region expansion (e.g. WorldGuard Compatibility). +- The force field should not be used as entry prevention, as players can just ignore the fake block packets that are + sent to them. +- For the actual entry prevention options, please check the configuration for your region expansion (e.g. WorldGuard + Compatibility). - If your server has weak hardware, or you have a lot of players online, we recommend disabling the force field effect. -- You can try unsafe mode and see if performance improves, but the most recommended option is to disable the force field. +- You can try unsafe mode and see if performance improves, but the most recommended option is to disable the force + field. diff --git a/expansion/glowing/README.MD b/expansion/glowing/README.MD index d84426b41..18aacfaea 100644 --- a/expansion/glowing/README.MD +++ b/expansion/glowing/README.MD @@ -1,9 +1,12 @@ # CombatLogX Expansion: Glowing + The glowing expansion makes players glow while they are in combat. ## Requirements + - Spigot 1.9 and above. ## Features + - Players will have a glowing effect during combat. - The glow effect will be removed once the player escapes. diff --git a/expansion/logger/README.MD b/expansion/logger/README.MD index 1922786ce..ff886f699 100644 --- a/expansion/logger/README.MD +++ b/expansion/logger/README.MD @@ -1,7 +1,9 @@ # CombatLogX Expansion: Logger + The logger expansion saves details about different combat events to files. ## Features + - Change the name and format of the log files. - Configurable log message and date format. - Option to log every CombatLogX event and the EntityDamageByEntityEvent. diff --git a/expansion/mob-tagger/README.MD b/expansion/mob-tagger/README.MD index e1f5c6c20..74c55df98 100644 --- a/expansion/mob-tagger/README.MD +++ b/expansion/mob-tagger/README.MD @@ -1,7 +1,9 @@ # CombatLogX Expansion: Mob Tagger -The mob tagger expansion causes players to be tagged when they hit a mob or when a mob attacks them. + +The mob tagger expansion causes players to be tagged when they hit a mob or when a mob attacks them. ## Features + - Allow mobs to tag players into combat. - Configurable list of mobs that can tag players. - Prevent certain types of mobs from tagging players. diff --git a/expansion/newbie-helper/README.MD b/expansion/newbie-helper/README.MD index 5fa4a790b..2843ed2b8 100644 --- a/expansion/newbie-helper/README.MD +++ b/expansion/newbie-helper/README.MD @@ -1,19 +1,23 @@ # CombatLogX Expansion: Newbie Helper + The newbie helper expansion helps new players. ## Features + - Prevent new players from being attacked for a configurable amount of time. - Remove protection from newbies when they attack someone. - Toggle your own ability to PVP. - (Admin Only) Force a certain player to have pvp enabled/disabled. ## Commands + - **/togglepvp:** - - **Aliases:** `pvptoggle`, `pvp` - - **/togglepvp check \:** Check the PVP status of a player. - - **/togglepvp on/off:** Enable or disable your ability to pvp. - - **/togglepvp admin on/off \:** Enable or disable the pvp of another player by force. - + - **Aliases:** `pvptoggle`, `pvp` + - **/togglepvp check \:** Check the PVP status of a player. + - **/togglepvp on/off:** Enable or disable your ability to pvp. + - **/togglepvp admin on/off \:** Enable or disable the pvp of another player by force. + ## Permissions + - **combatlogx.command.togglepvp:** Allows access to the `/togglepvp` command. - **combatlogx.command.togglepvp.admin:** Allows access to the `/togglepvp admin` command. diff --git a/expansion/rewards/README.MD b/expansion/rewards/README.MD index bffba1973..a37b3774c 100644 --- a/expansion/rewards/README.MD +++ b/expansion/rewards/README.MD @@ -1,11 +1,13 @@ # CombatLogX Expansion: Rewards + The rewards expansion runs commands whenever a player kills a mob or another player. ## Features + - Custom rewards - Enabled/Disabled worlds per reward. - Specific entity types per reward. - Chance based rewards. - Rewards with custom requirements: - - Vault Economy Balance - - *More coming soon...* + - Vault Economy Balance + - *More coming soon...* diff --git a/expansion/scoreboard/README.MD b/expansion/scoreboard/README.MD index f5e766a8a..919ad4483 100644 --- a/expansion/scoreboard/README.MD +++ b/expansion/scoreboard/README.MD @@ -1,10 +1,13 @@ # CombatLogX Expansion: Scoreboard + The scoreboard expansion shows a scoreboard to every player that is in combat. ## Features + - Customizable title and lines - Lines update without flickering ## Commands + - **/combatlogx toggle:** - - **/combatlogx toggle scoreboard:** Enable or disable your scoreboard display. + - **/combatlogx toggle scoreboard:** Enable or disable your scoreboard display. diff --git a/plugin/README.MD b/plugin/README.MD index fcde41cb2..7579eeb55 100644 --- a/plugin/README.MD +++ b/plugin/README.MD @@ -1,36 +1,39 @@ # CombatLogX Plugin + This is the plugin module for CombatLogX. It contains all the implementations, commands, and listeners that will be used on the Spigot server. ## Commands + - **/combatlogx**: - - **Aliases:** `/clx`, `/ctx`, `/combatlog`, `/combattagx`, `/combattag` - - **/combatlogx help:** View the list of sub-commands for CombatLogX. - - **/combatlogx about <expansion>:** View information about an expansion. - - **/combatlogx reload:** Reload the configuration files for the plugin and expansions. - - **/combatlogx toggle <bossbar/actionbar/scoreboard>:** Toggle the action bar, boss bar, and scoreboard - for yourself. - - **/combatlogx tag <player>:** Force a player to be tagged into combat. - - **/combatlogx untag <player>:** Force a player to be untagged from combat. - - **/combatlogx version:** View version information and a list of enabled expansions. + - **Aliases:** `/clx`, `/ctx`, `/combatlog`, `/combattagx`, `/combattag` + - **/combatlogx help:** View the list of sub-commands for CombatLogX. + - **/combatlogx about <expansion>:** View information about an expansion. + - **/combatlogx reload:** Reload the configuration files for the plugin and expansions. + - **/combatlogx toggle <bossbar/actionbar/scoreboard>:** Toggle the action bar, boss bar, and scoreboard for + yourself. + - **/combatlogx tag <player>:** Force a player to be tagged into combat. + - **/combatlogx untag <player>:** Force a player to be untagged from combat. + - **/combatlogx version:** View version information and a list of enabled expansions. - **/combat-timer:** - - **Aliases:** `/combattimer`, `/combattime`, `/ctime`, `/clt`, `/ct` - - **/combat-timer:** Check how much time you have left in combat. - - **/combat-timer <player>:** Check how much time a player has left in combat. - + - **Aliases:** `/combattimer`, `/combattime`, `/ctime`, `/clt`, `/ct` + - **/combat-timer:** Check how much time you have left in combat. + - **/combat-timer <player>:** Check how much time a player has left in combat. + ## Permissions + - **combatlogx.bypass:** Default bypass permission, can be changed in the config.yml file. -- **combatlogx.bypass.force.field:** Default bypass permission for the force field, can be changed in the - configuration file for the force field expansion. +- **combatlogx.bypass.force.field:** Default bypass permission for the force field, can be changed in the configuration + file for the force field expansion. - **combatlogx.command.combat-timer:** Gives access to the `/combat-timer` command. - **combatlogx.command.togglepvp:** Gives access to the `/togglepvp` command from the NewbieHelper expansion. - **combatlogx.command.togglepvp.admin:** Gives access to the admin features of the `/togglepvp` command. - **combatlogx.command.combatlogx:** Gives access to the base `/combatlogx` command, but not the sub-commands. -- **combatlogx.command.combatlogx.toggle:** Gives access to `/combatlogx toggle` command to toggle boss bar, - action bar, and scoreboard. +- **combatlogx.command.combatlogx.toggle:** Gives access to `/combatlogx toggle` command to toggle boss bar, action bar, + and scoreboard. - **combatlogx.command.combatlogx.about:** Gives access to information about expansions with `/combatlogx about`. -- **combatlogx.command.combatlogx.help:** Gives access to information about CombatLogX commands with +- **combatlogx.command.combatlogx.help:** Gives access to information about CombatLogX commands with `/combatlogx help`. - **combatlogx.command.combatlogx.reload:** Gives access to reload configurations with `/combatlogx reload`. - **combatlogx.command.combatlogx.version:** Gives access to version information with `/combatlogx version`.