https://github.com/mworzala/mc_debug_renderer

Enables servers to render debug shapes on the client.
https://github.com/mworzala/mc_debug_renderer

fabricmc minecraft minestom-library

Last synced: 12 days ago
JSON representation

Enables servers to render debug shapes on the client.

• Host: GitHub
• URL: https://github.com/mworzala/mc_debug_renderer
• Owner: mworzala
• License: mit
• Created: 2021-11-01T14:57:09.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-03T17:13:34.000Z (2 months ago)
• Last Synced: 2024-05-03T19:26:44.283Z (2 months ago)
• Topics: fabricmc, minecraft, minestom-library
• Language: Java
• Homepage:
• Size: 771 KB
• Stars: 48
• Watchers: 4
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-minestom - mc_debug_render - Draw arbitrary debug shapes on the client. (Libraries)

README

        
# Minecraft Debug Renderer

Allows servers to render arbitrarily placed and sized debug shapes on the client.

![showcase](.github/showcase.png)

# Usage

Any platform which can send plugin messages is supported. There is a server library for Minestom, 

which is available on Jitpack.

```groovy

repositories {

    // ...

    maven { url 'https://jitpack.io' }

}

dependencies {

    // Minestom

    implementation 'com.github.mworzala.mc_debug_renderer:minestom:$LATEST_COMMIT_HASH'

}

```

## Checking if enabled

The client will send a plugin message with the id `debug:hello` when joining a server if the mod is present.

The message will contain a single integer representing the current version of the mod.

## Plugin Messages

The following plugin messages are supported:

todo

## Credit

The following was very helpful when working on this mod:

- [WorldEditCUI](https://github.com/EngineHub/WorldEditCUI)

- [BuilderMod](https://github.com/Moulberry/BuilderMod)

# License

This project is licensed under the [MIT License](./LICENSE).