Sample GameTests for Minecraft Bedrock Edition.
Перейти к файлу
Mike Ammerlaan e0d67e171f
Merge pull request #11 from microsoft/mammerla-gtupdates
Update and refactor gametests
2024-06-17 09:34:22 -07:00
js-gametests
starterTestsTutorial
CODE_OF_CONDUCT.md
LICENSE
README.md
SECURITY.md
SUPPORT.md

README.md

Project

This repo contains sample GameTest behavior files for Minecraft Bedrock Edition. Minecraft supports GameTests - a combination of JavaScript + MCStructures - for validating facets of Minecraft behavior. You can use GameTests to validate facets of your creations, as well!

Getting started with GameTest

To get started with GameTest Framework in Minecraft, see this GameTest Framework Introduction page.

A tutorial for creating your first GameTest is available here. The sample code for the tutorial is within this repo, at starterTestsTutorial.

Behavior packs & tests

Name Link Description
StarterTestsTutorial Open A very basic gametest documented in the tutorial at https://aka.ms/newgametest.
JavaScript GameTests Open A variety of basic gametests written directly in JavaScript.

Using these behavior packs

To use these behavior packs with an installed Windows version of Minecraft Bedrock Edition:

  1. Copy the desired behavior packs into the development_behavior_packs folder.

For the main Minecraft folder, this is at %localappdata%\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang\development_behavior_packs. For Minecraft Preview, this is at %localappdata%\Packages\Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe\LocalState\games\com.mojang\development_behavior_packs.

  1. Create a new world in Minecraft with the following options:
  • Enable the Beta APIs Experiment
  • Set to Creative mode
  • Add the desired Behavior packs

Contributing

This project welcomes contributions and suggestions. For the GameTests you'd like to submit for inclusion in this sample repo, please make sure:

  • the GameTest(s) are small and self contained
  • can run in a short amount of time, with clear pass/fail criteria
  • are generally passing, or used to document an unexpected failure and are tagged as such (with the .tag function on .register)
  • do not have any external dependencies (e.g., on extra behavior or resource packs)
  • for JavaScript, that files are formatted consistent with the settings defined in prettierrc.json (mainly, two-space indentation)

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.