https://github.com/notbeer/gametest-api-wrapper
Library built off of Minecraft Bedrock Edition Gametest API. Easily allows you to interact with the API, while including a lot more features!
https://github.com/notbeer/gametest-api-wrapper
mcbe-gametest mcbe-plugin mcbe-realms minecraft minecraft-bedrock-edition minecraft-custom-commands minecraft-gametest minecraft-plugin minecraft-scripts realms
Last synced: about 1 year ago
JSON representation
Library built off of Minecraft Bedrock Edition Gametest API. Easily allows you to interact with the API, while including a lot more features!
- Host: GitHub
- URL: https://github.com/notbeer/gametest-api-wrapper
- Owner: notbeer
- License: mit
- Created: 2021-06-16T05:41:20.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-05-28T04:04:46.000Z (about 3 years ago)
- Last Synced: 2024-01-28T04:52:11.981Z (over 2 years ago)
- Topics: mcbe-gametest, mcbe-plugin, mcbe-realms, minecraft, minecraft-bedrock-edition, minecraft-custom-commands, minecraft-gametest, minecraft-plugin, minecraft-scripts, realms
- Language: TypeScript
- Homepage:
- Size: 257 KB
- Stars: 42
- Watchers: 9
- Forks: 25
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
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][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Table of Contents
## 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
* [GameTest FrameWork](https://docs.microsoft.com/en-us/minecraft/creator/scriptapi/mojang-minecraft/mojang-minecraft)
## 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
```sh
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](https://github.com/notbeer/Gametest-API-Wrapper/tree/main/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](https://github.com/notbeer/Gametest-API-Wrapper/blob/main/transpile.sh) to tranpile your work!
## Roadmap
See the [open issues](https://github.com/notbeer/Gametest-API-Wrapper/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](https://discordapp.com/users/606353040336748584/) or contact me throught the [Bedrock OSS](https://discord.gg/y4cnaJ9E9C) Discord server.
Project Link: [https://github.com/notbeer/Gametest-API-Wrapper](https://github.com/notbeer/Gametest-API-Wrapper)
## Acknowledgements
* [GameTest FrameWork Documentation](https://docs.microsoft.com/en-us/minecraft/creator/scriptapi/mojang-minecraft/mojang-minecraft)
[contributors-shield]: https://img.shields.io/github/contributors/notbeer/MCBE-GameTest-FrameWork.svg?style=for-the-badge
[contributors-url]: https://github.com/notbeer/Gametest-API-Wrapper/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/notbeer/MCBE-GameTest-FrameWork.svg?style=for-the-badge
[forks-url]: https://github.com/notbeer/Gametest-API-Wrapper/network/members
[stars-shield]: https://img.shields.io/github/stars/notbeer/MCBE-GameTest-FrameWork.svg?style=for-the-badge
[stars-url]: https://github.com/notbeer/Gametest-API-Wrapper/stargazers
[issues-shield]: https://img.shields.io/github/issues/notbeer/MCBE-GameTest-FrameWork.svg?style=for-the-badge
[issues-url]: https://github.com/notbeer/Gametest-API-Wrapper/issues
[license-shield]: https://img.shields.io/github/license/notbeer/MCBE-GameTest-FrameWork.svg?style=for-the-badge
[license-url]: https://github.com/notbeer/Gametest-API-Wrapper/blob/main/LICENSE.txt