Skip to content

WayfindEntertainment/Bedrock-Debug-Screen

Bedrock Debug Screen

Licensed under the GPL version 3.0 Maintained Contributions welcome

Debug Screen Logo, a block of bedrock with a red bug logo crawling on the side

What Does This Pack Do?

Minecraft Bedrock lacks a debug screen (unless you have one of the developers' copies, that is). If you have played the Java version, you might be familiar with how useful that screen is. This behavior pack brings some of that functionality into Bedrock.

Adding It To Your Worlds

How to Install

Download the latest version of the addon. Once downloaded, double click it to run. Minecraft will automatically import the addon.

Your world will need to enable the Beta APIs in the game settings for this addon to work. Please note that this is an irreversible setting change for this world.

Using In Game

Once you are playing, bring up the chat menu (default key binding is T). Then, type

!debug on

and press enter. When you close the chat window, you'll now see a debug screen like this:

Bedrock debug screenshot in action

When you no longer want to see this information, open the chat menu again and type

!debug off

then press enter. Now when you close the window that debug screen will go away.

Troubleshooting

Requesting dependency on beta APIs

[Scripting][error]-Plugin [Minecraft Bedrock Debug Screen - 2.0.0] - requesting dependency on beta APIs [@minecraft/server - 1.12.0-beta], but the Beta APIs experiment is not enabled.

You have activated the add-on correctly, but you need to activate the Beta APIs in your game settings.

Unknown command: !

Unknown command: !. Please check that the command exists and that you have prmission to use it.

You have accidentally entered the command with the / preceding the !. You must remove the slash before entering the command.

Requesting Invalid Module Version

If you get an error similar to this:

[Scripting][error]-Plugin [Minecraft Bedrock Debug Screen] - module [Minecraft Bedrock Debug Screen - 2.1.1] requesting invalid module version [@minecraft/server - 2.0.0-beta].

Current [beta] version is [2.1.0-beta].

Available versions:
0.1.0
1.19.0
2.1.0-beta
3.0.0-alpha

it means the latest official Minecraft API has updated. The only way to resolve this is by updating the manifest to the new version and reloading the addon. Submit a ticket to let me know that it needs fixing!

Debug Screen Limitations

  • To prevent run time errors from trying to access blocks or entities in unloaded chunks, the "Looking at Block" section will say "None" if the block is out of ticking distance.
  • The official API has no way to calculate block lighting levels or biome types.

Contributions

Contributions are welcome! Please help keep this project open and inclusive. Refer to the Code of Conduct before your first contribution.

REMEMBER THIS IS A PROJECT WITH CHILDREN AS A SIGNIFICANT PART OF THE TARGET AUDIENCE!

While I don't expect most children to delve into the intricacies of software development, the older they get the more likely they are to search things like this out. And even if they don't come to this particular project repository, they are still the target audience of the developed mod itself. Therefore, keep the rating for this project at a PG level or better.

See more contributing instructions

Here are some ways you can contribute.

Submit Issues

Bug Reports: Be as detailed as possible, and fill out all information requested in the bug report template.

For security related issues, see the security policy.

Documentation Requests: Is something unclear in the documentation or the API? Submit a documentation change request! Be as detailed as possible. If you have the question, chances are someone else will also who isn't as willing to speak up as you are.

Propose New Features

Feature requests are welcome! Before submitting, take a moment to make sure your feature idea fits within the scope and aims of this project. This behavior pack aims to provide a light weight and non-intrusive way to show debug information to players. Be as detailed as possible when filling out a new feature request. It is up to you to make your case of why the feature should get included!

Please ask before embarking on any significant undertaking by opening an issue for the proposal, otherwise you risk wasting time on something that might not fit well with the project.

Submit a Pull Request

Good pull requests are outstanding help. They should remain focused in scope and avoid unrelated commits.

To submit a pull request,

  1. Fork and clone the repository
  2. Create a branch for your edits
  3. Make sure your work follows the Common Commit Guidance guidance

Development Environment

This project uses a Node environment to help with linting, formatting, testing, and distribution. To install a local copy, clone the repository:

git clone https://github.com/WayfindEntertainment/Bedrock-Debug-Screen.git
cd Bedrock-Debug-Screen

Use the command npm run dev to package the source files into the Minecraft behavior pack development folder.

All commits must follow the Wayfind Entertainment Common Commit Guidance. This specification is inspired by and supersedes the Angular Commit Message. This project has no custom scopes.

License

To help as many fellow developers as possible, this behavior pack and all other files in this repository are distributed as free and open-source software under the GPL v3.0 License, © 2023.

Contact

If you find this project useful, please leave a 🌟 and subscribe to the Wayfind Minecraft YouTube channel for tutorials and 3D graphic art adventures!

Subscribe to the Wayfind Minecraft YouTube channel

Maintained by Wayfind Minecraft.

GitHub Badge Profile Twitter Badge Profile LinkedIn Badge Profile Stackoverflow Badge Profile

About

A Minecraft Bedrock behavior pack to give debug screen features

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks