beta program documentation.pdf - Lukas Voigts

Please enable JavaScript to view the full PDF

1 Java Debug Screen for Bedrock An Integrated MoLang/JSON UI Tech Demo Documentation and Manual Version 1.0.0 – Private Beta #1 by @LukasPAH Table of Contents p2) – Installation p3) – Using in Game p4) – Incompatibilities and Known Issues p5) – Uninstallation p6) – Technical Details and Licensing 2 Installation Do not apply on any important world during the beta program 1. Download the JavaDebugScreenV100-B1.mcaddon file from MediaFire. Link: https://www.mediafire.com/file/45mtxv9dzcvespj/ 2. Import the JavaDebugScreenV100.mcaddon file in-game. There are various ways to do this, so chose whatever way you feel comfortable with. *AT THIS STAGE, IF YOU ARE USING THIS PACK ON AN EXISTING WORLD, I WOULD HIGHLY RECOMMEND BACKING UP YOUR WORLD* 3. Apply the behavior pack to the world. Doing this will also apply the required resource pack. 4. Ensure that you have the following world options ticked: i. “Show Coordinates” ii. “Holiday Creator Features” iii. “Additional Modding Capabilities” You DO NOT need to tick “Allow Cheats” for this pack to work. 5. Start the world. Automatic installation of the pack features will begin immediately on loading the world. When loading for the first time, the pack will make the following changes to the world: i. Place a command block at 0, 0, 0 ii. Add ticking area from 0, 0, 0 to 15, 0, 15 iii. Set max player limit to 1 iv. Setup the scoreboard sidebar If you are a developer and wish to use this pack, keep in mind that the scoreboard sidebar is reserved for the debug screen. Do not set a different scoreboard sidebar. Ensure that you have space in your world for another ticking area if you currently use them. Also ensure there is nothing important at 0, 0, 0 (this is normally a block of bedrock on survival worlds. 3 Using in Game • Mobile: o Press the F3 button at the top of the screen to toggle the debug screen on and off • Computer: o Press F8 on your keyboard to toggle the debug screen on and off o If you want to remap the debug screen to F3, you may download the AutoHotKey executable file from https://www.mediafire.com/file/96cezinyqy1oydl. Run it when you are playing Minecraft on Windows 10. This will change the key binding from F8 to F3 in the Minecraft window (and only the Minecraft window). • Console/Controller: o Go the the video settings screen by going to: ▪ Pause->Settings->Video o Press the “Debug Screen” toggle to toggle the debug screen on and off This pack is currently only compatible on single player worlds and the Bedrock Dedicated Server* with one player online at a time. Applying this pack will set the max player limit on your world to 1 to prevent debug screen issues. The minimum supported game version is 1.16.100. *if using on the BDS, be sure to enable experimental world features in the configuration file! 4 Incompatibilities and Known Issues Incompatible Resource Packs: o F1 button on HUD by Elwaer o Many resource packs that change the HUD. You should apply this pack above any UI packs for the best chance of success. Incompatible Game Versions: o 1.16.210.50-53 beta – MoLang entity queries broken Known Issues: o When loading into world, the light level may be wrong. To fix, walk around to a brighter or darker place to update the light counter. Placing and breaking a torch nearby will also update the counter. o FPS is not 100% accurate. This pack only takes into consideration TPS, entity count, and rendered entities to generate FPS. It does not consider opened programs, tile entities, etc. o TPS may not be 100% accurate on some devices – this is a game bug. o If you have more than 500 entities in a 72 block radius, the entity counter may break. If this is the case, you may need to reassess why you need so many entities in one place. o Chat messages may disappear from the chat screen window after a few minutes. This is also a game bug. 5 Uninstallation (Incomplete as of Dec. 22) Do not apply on any important world during the beta program If you wish to uninstall this pack from your world, there are a couple of additional steps you need to follow. This pack makes several (yet minor and reversible) modifications to the world that may be annoying after removal of the main pack. Here are the main things that need to be reversed after uninstallation of the pack from the world: o Remove the command block at 0, 0, 0 o Remove the ticking area at 0, 0, 0 to 15, 0, 15 o Set the max player limit back to 8 players o Reset the scoreboard sidebar, objective, and players This is easily done by downloading the JavaDebugScreenRemovalTool.mcpack file from https://www.mcpedl.com/java-debug-screen-addon First remove the Debug Screen Pack from the world, and then import the JavaDebugScreeRemovalTool.mcpack file. Apply the removal tool to the world in the behavior packs section. Load the world, and you should see a chat message like this: [Player] Java Debug Screen removal successful! This means the operation was successful. You may leave the world, remove the tool from the behavior packs section, and reload the world. You should see that your world appears normal! 6 Technical Details This pack works by querying the player in different conditions, executing a scoreboard command, and sending it to the JSON UI for formatting. For example, if I want to test whether or not a player is in the “Nether Wastes” biome, I query the tag “nether_wastes”, and execute a scoreboard command “/scoreboard players “Biome: Nether Wastes” set OBJECTIVE NUMBER for the UI to format. The formatting is complicated. Feel free to look at scoreboards.json and the entity controller to get a complete sense of what is going on. Inquiries about the technology are ok too! I am more than happy to answer questions! Licensing This pack uses the Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0) License See https://creativecommons.org/licenses/by-nc-nd/4.0/ for more details The main points of the license include: o Give credit o Do not monetize the content (YouTube is acceptable, ad.fly is not) o No remixes and/or custom redistributions