Skip to content

Commit

Permalink
docs: update list of modules in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kernitus committed Dec 26, 2024
1 parent 9bef3ef commit 3f6c0b4
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,58 +24,55 @@ A performant Spigot/Paper plugin to configure combat-related mechanics for Minec
<img src="res/bukkit.png" alt="Bukkit" height="100">
</a>

## Modesets
## 🧰 Modesets
Modesets can be configured for your players to choose from. Each modeset can have any combination of the below features enabled, with examples provided to replicate 1.9 vs 1.8 combat. Players can switch between modesets via command, choosing from the modesets allowed for the world they are in.

## ⚡ Development Builds
Oftentimes a particular bug fix or feature has already been implemented but a new version of OCM has not been released yet. You can find the most up-to-date version of the plugin on [Hangar](https://hangar.papermc.io/kernitus/OldCombatMechanics/versions?channel=Snapshot&platform=PAPER).

## Configurable Features
## Configurable Features
Features are grouped in `module`s as listed below, and can be individually configured and disabled. Modules that are fully disabled will have no impact on server performance.

#### Combat
#### Combat
- Attack cooldown
- Attack frequency
- Tool damage
- Critical hits
- Player regen

#### Armour
#### 🤺 Armour
- Armour strength
- Armour durability

#### Swords & Shields
#### 🛡 Swords & Shields
- Sword blocking
- Shield damage reduction
- Sword sweep

#### Knockback
#### 🌬 Knockback
- Player knockback
- Fishing knockback
- Fishing rod velocity
- Projectile knockback

#### Gapples & Potions
#### 🧙 Gapples & Potions
- Golden apple crafting & effects
- Potion effects & duration
- Chorus fruit

#### New feature disabling
#### New feature disabling
- Item crafting
- Offhand
- Bow boost
- New attack sounds
- Enderpearl cooldown
- Brewing stand refuel
- Enchantment table auto-lapis
- Burn delay
- Projectile randomness

## Plugin Compatibility
## 🔌 Plugin Compatibility
Most plugins will work fine with OCM. Some are explicitly supported, including:
- Placeholder API (see [wiki](https://github.com/kernitus/BukkitOldCombatMechanics/wiki/PlaceholderAPI) for details)

## Contributions
## 🤝 Contributions

If you are interested in contributing, please [check this page first](.github/CONTRIBUTING.md).
<hr/>
Expand Down

0 comments on commit 3f6c0b4

Please sign in to comment.