Skip to content

Commit

Permalink
New docs website
Browse files Browse the repository at this point in the history
  • Loading branch information
ShonP40 committed Oct 16, 2024
1 parent c9de9cb commit d731f62
Showing 1 changed file with 3 additions and 25 deletions.
28 changes: 3 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,9 @@

The CheatBreaker API will allow you to detect when a player is running CheatBreaker, enable and disable HUD modules, allow x-ray for your staff, and much more.

## Compatibility

This API has been tested with Spigot 1.7.10, PaperSpigot 1.7.10 and mSpigot 1.7.10 (MineHQ Spigot). However, it can work on other/newer versions as well.

This API can detect people on CheatBreaker 1.7.10 and 1.8.9.

## Download

The latest release can be found [here](https://github.com/CheatBreakerNet/Bukkit-API/releases/latest).

## Commands

`/cb (username)` - Check if a player is using CheatBreaker.

`/cbm` - Send a message to all CheatBreaker players (Default permission: `cheatbreaker.message`).

`/cbt` - Send a title text to all CheatBreaker players (Default permission: `cheatbreaker.title`).

## Examples
## Documentation

Example plugins can be found under the [`Examples`](/Examples) folder. Those examples will help you integrate the CheatBreaker API into your plugins.
Documentation can be found [here](https://docs.cheatbreaker.net/category/bukkit-api).

## Get the Source

Expand All @@ -43,14 +25,10 @@ Example plugins can be found under the [`Examples`](/Examples) folder. Those exa
3. Run `./compile`
4. Find the compiled jar at `target/CheatBreakerAPI.jar`

## Documentation

Documentation can be found on the [wiki pages](https://github.com/CheatBreakerNet/Bukkit-API/wiki).

---

**License:** [GNU/GPL v3](https://github.com/CheatBreakerNet/Bukkit-API/blob/master/LICENSE)

## Credits

The original CheatBreaker Bukkit API (made by CheatBreaker, LLC) can be found [here](https://github.com/CheatBreaker/CheatBreakerAPI).
The original CheatBreaker Bukkit API (made by CheatBreaker, LLC) can be found [here](https://github.com/CheatBreaker/CheatBreakerAPI).

0 comments on commit d731f62

Please sign in to comment.