Skip to content

Library built off of Minecraft Bedrock Edition Gametest API. Easily allows you to interact with the API, while including a lot more features!

License

Notifications You must be signed in to change notification settings

notbeer/Gametest-API-Wrapper

Repository files navigation


Logo

GameTest API Wrapper

Gametest API Wrapper is a library built using Minecraft Bedrock Edition Gametest API. This library will help you keep your code clean and make it easier to interact with the Gametest API, while including a lot of new functions/methods for you to use! This pack will have some miscellaneous and some custom command that you may use!
Docs Coming soon »

View Demo · Report Bug · Request Feature

Contributors Forks Stargazers Issues MIT License

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Gametest API Wrapper will provide you with a lot of classes and methods for you to use. There be a lot of useful custom methods for you to use. There are also classes like Database. Gametest API doesn't come with a Database as of now, so I have added a way for you to easily store and get access to the data. There are a lot more stuff in this library!

Built With


Getting Started

Easy Method

  • Download this zip folder and name it to .mcpack and import it by double clicking on the folder. This method will only work if you have Minecraft Bedrock Edition on the same device you are doing this action on.

Recommended Method

  • Another Method would be to take the zipped folder and unzip/extract it. Take your folder and move it to the folder 'development_behavior_packs', which can be found in a path like \Users\USER_NAME\AppData\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang\development_behavior_packs. This will make your life way easier, while developing this pack. It will update the content inside your game everytime you make any changes to the script. For the changes to apply you must leave and rejoin your world where the pack is applied at.

Installation

  1. Clone the repo
    git clone https://github.com/notbeer/Gametest-API-Wrapper.git

Usage

WARNING: If you are going to apply any GameTest related scripts to your world, please make a copy of your world before you do so! I'm not responsible if anything goes wrong-

Create a new world, since GameTest FrameWork is still experimental. Make sure in your settings you have GameTest FrameWork enabled under Experiments category. I have some examples on how you can use this library. Specifically on custom commands. Type in the game chat +help for the list of custom commands or +help [command name] to get information on a specific command!

If you want to add or edit your own stuff to the pack. Please head to the src folder. You can start working with the typescript files in there. At the end of your work make sure to transpile your work. You can run transpile.sh to tranpile your work!


Roadmap

See the open issues for a list of proposed features (and known issues).


Contributing

You can share your amazing talent with other people! Any Contributions are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.


Contact

Discord - Message me on notbeer#9204 or contact me throught the Bedrock OSS Discord server.

Project Link: https://github.com/notbeer/Gametest-API-Wrapper


Acknowledgements