diff --git a/README.md b/README.md index 4a3696b..0c23511 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,13 @@ - - -
![Bedrock-API](https://socialify.git.ci/JustSkyDev/Bedrock-API/image?description=1&descriptionEditable=Minecraft%20Bedrock%20Custom%20Scripting%20API&font=Source%20Code%20Pro&forks=1&issues=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2FJustSkyDev%2FBedrock-API%2Fmain%2Fpack_icon.png&name=1&owner=1&pattern=Circuit%20Board&pulls=1&stargazers=1&theme=Light) -

Bedrock API

-

Bedrock API is a library built using Minecraft Bedrock Scripting API. This library will help you keep your code clean and make it easier to interact with the Scripting API, while including a lot of new classes/functions/methods for you to use! and some built-in custom command
- Documentations
-
- View + Repository · Bug Report · @@ -28,7 +18,6 @@ https://github.com/othneildrew/Best-README-Template [![MIT License](https://img.shields.io/github/license/JustSkyDev/Bedrock-API?style=for-the-badge&color=yellow)](https://github.com/JustSkyDev/Bedrock-API/blob/main/LICENSE) [![Discord Server](https://img.shields.io/discord/898202806052347984?color=blue&label=Discord&style=for-the-badge)](https://discord.gg/g4EJ38HZ7R) - [![YouTube](https://img.shields.io/youtube/channel/subscribers/UC9gjEs8-syrZcgftpm3gsyQ?label=YouTube&style=for-the-badge&color=ff0000)](https://youtube.com/@JustSkyDev) [![GitHub Releases](https://img.shields.io/github/downloads/JustSkyDev/Bedrock-API/total?style=for-the-badge&color=orange) ](https://github.com/JustSkyDev/Bedrock-API/releases/latest) @@ -36,64 +25,31 @@ https://github.com/othneildrew/Best-README-Template

-

Table of Contents
    -
  1. - About The Project - -
    2. -
  2. - Getting Started - -
    3. +
  3. Installation
  4. Usage
    5. +
  5. Plugin example
  6. Documentations
    7. -
  7. Contributing
  8. License
  9. Contact
    10. -
  10. Acknowledgements
  11. Supports
-
-## About The Project - -JSBedrock-API 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 and Collection. Scripting API doesn't come with a Database or Collection 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 API! - -### Built With - -[![Scripting API](https://img.shields.io/badge/Scripting%20API%20Docs-white?style=for-the-badge&logoColor=f25022&logo=Microsoft)](https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/) - - -
+## Installation -## Getting Started - -Easy Method +**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 +**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 `PATH/TO/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 or using command `/reload`. - -
- -### Installation - -- Go to [releases](https://github.com/JustSkyDev/Bedrock-API/releases/latest) to get stable version, clone or [download](https://github.com/JustSkyDev/Bedrock-API/archive/refs/heads/main.zip) this repo to get a pre-release or beta version. - -
## Usage @@ -105,50 +61,64 @@ Recommended Method Create a new world, since Scripting API is still experimental. Make sure in your settings you have `Beta API's` in `Experiments` menu. I have some examples on how you can use this library. Specifically on custom commands. Type in the game chat `!help` or `!help [page number]` for the list of custom commands or `!help [command name]` to get information on a specific command! -
-## Documentations -- [Bedrock-API Docs](https://justskydev.github.io/docs/list/Bedrock-API-Docs) +## Plugin example +**Custom Command** + - TypeScript +```javascript +//PATH/plugin/Custom Commands/myCommand.ts - -
+import { Command, CommandRegistration } from "../@modules" + +const registration: CommandRegistration = new CommandRegistration() + .setName("ping") + .setDescription("Ping command"); + +Command.BuildCommand(registration, (interaction) => { + interaction.sender.sendMessage("Pong!"); +}); + +``` + - JavaScript +```javascript +//PATH/plugin/Custom Commands/myCommand.js -## Roadmap +import { Command, CommandRegistration } from "../@modules" -See the [open issues](https://github.com/JustSkyDev/Bedrock-API/issues) for a list of proposed features (and known issues). +const registration = new CommandRegistration() + .setName("ping") + .setDescription("Ping command"); + +Command.BuildCommand(registration, (interaction) => { + interaction.sender.sendMessage("Pong!"); +}); + +``` + +
+ +## Documentations +- [Bedrock-API Docs](https://justskydev.github.io/docs/list/Bedrock-API-Docs) -
## License Distributed under the MIT License. See `LICENSE` for more information. -
## Contact [![Discord Profile](https://img.shields.io/badge/Discord-blue?style=for-the-badge&logoColor=white&logo=Discord)](https://discordapp.com/users/625970059503992843) -[![Text OR](https://img.shields.io/badge/OR-e60023?style=for-the-badge)](#) -[![Discord Server](https://img.shields.io/badge/Discord%20Server-blue?style=for-the-badge&logoColor=white&logo=Discord)](https://discord.gg/g4EJ38HZ7R) - - -
- -## Acknowledgements - -[![Scripting API](https://img.shields.io/badge/Scripting%20API%20Docs-white?style=for-the-badge&logoColor=7fba00&logo=Microsoft)](https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/) -
## Supports [![Trakteer](https://tinyurl.com/JustSkyDev-Trakteer-Icon)](https://trakteer.id/justskydev) -
## Star