Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JaylyDev/ScriptAPI
Community Driven Scripts for Minecraft's Scripting
https://github.com/JaylyDev/ScriptAPI
bedrock bedrock-addons bedrock-edition gametest minecraft minecraft-server
Last synced: 3 months ago
JSON representation
Community Driven Scripts for Minecraft's Scripting
- Host: GitHub
- URL: https://github.com/JaylyDev/ScriptAPI
- Owner: JaylyDev
- License: mit
- Created: 2022-02-13T22:07:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T13:39:53.000Z (6 months ago)
- Last Synced: 2024-05-22T14:03:29.911Z (6 months ago)
- Topics: bedrock, bedrock-addons, bedrock-edition, gametest, minecraft, minecraft-server
- Language: JavaScript
- Homepage:
- Size: 7.8 MB
- Stars: 121
- Watchers: 2
- Forks: 23
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-minecraft-bedrock - ScriptAPI - Community Driven Scripts for Minecraft's Scripting (Documentation)
README
# ScriptAPI Samples
This repository is filled with community driven script samples for Minecraft Bedrock Script API.
### 🔴 USE `stable` not `main` 🔴
**Check out the `stable` branch from here: https://github.com/JaylyDev/ScriptAPI/tree/stable**.
The `main` branch is used for script development for Minecraft Preview and may often be in a **broken** state.
## [Scripts](./scripts/)
Community driven scripts that use Script API to do all kinds of crazy stuff in Minecraft.
> [!IMPORTANT]
> Some scripts might use API modules that are only enabled in specific runtime environments, including:
>
> `@minecraft/server-net` and `@minecraft/server-admin`: Modules that can only be used in [Bedrock Dedicated Servers](https://www.minecraft.net/en-us/download/server/bedrock).
>
> `@minecraft/vanilla-data` and `@minecraft/math`: These are external Minecraft libraries published to NPM. They are not part of Minecraft's native modules.
There are two ways to use external Minecraft libraries in behavior pack scripts:
1. **Standalone file**
Download standalone files available from [jaylydev.github.io](https://jaylydev.github.io/scriptapi-docs/meta/cdn-links.html) for quick, small-scale projects.
2. **Bundling**
Installing it through npm, with advanced build configurations and bundling with esbuild:
```bash
npm i @minecraft/math
npm i @minecraft/vanilla-data
```
Guide on bundle Minecraft Scripts with the following bundlers:
- ESBuild (Recommended): [Bundle Minecraft Scripts with ESBuild](https://jaylydev.github.io/posts/bundle-minecraft-scripts-esbuild/)
- Webpack: [Bundle Minecraft Scripts with Webpack](https://jaylydev.github.io/posts/scripts-bundle-minecraft/)
## [Editor Extensions](./editorExtensions/)
Community driven editor extensions samples for editing Minecraft worlds. Only available on Editor projects in [Minecraft Editor](https://github.com/mojang/minecraft-editor).
Highly recommend checking out Mojang's [editor extension starter kit](https://github.com/Mojang/minecraft-editor-extension-starter-kit) if you're experimenting with editor API for the first time!
## Documentation
Check out the following links for Script API documentation:
- [Official Script API Documentation](https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/) - Microsoft's official documentation of high-level introduction of experimental Script API
- [Jayly's Script API References](https://jaylydev.github.io/scriptapi-docs/) - Jayly's Script API documentation with guides and easy to use and understand API references for programming beginners.
- [Bedrock Wiki](https://wiki.bedrock.dev/scripting/starting-scripts.html) - Learn the basics of the Script API on Bedrock Wiki.
## Contributing
Please contribute to this repository if you can. Check out [Contributing Guidelines](./CONTRIBUTING.md) for more infomation.
## License
This project is licensed under the MIT license.
Copyrights on the script files are each contributor listed at the beginning of each script file.