Skip to content

Commit 548a740

Browse files
authored
Repo Rewrite - May 2024 (#355)
* Remove docs directory * Update cl.yml * add minecraft/math module * start updating scripts * test * Update README.md * Update README.md * Update README.md * Update README.md * they * ssssssssssssssss * Update README.md * hope it works * image fixes * Update README.md * Update README.md
1 parent 0851e8b commit 548a740

File tree

88 files changed

+530
-6121
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+530
-6121
lines changed

.github/workflows/cl.yml

+1-5
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,7 @@ jobs:
1717
- name: Checkout
1818
uses: actions/checkout@v4
1919

20-
- name: npm install
21-
run: |
22-
pwd && npm install
23-
find ./scripts/* -maxdepth 2 -name package.json -execdir sh -c 'pwd && npm install' \;
24-
find ./docs/* -maxdepth 5 -name package.json -execdir sh -c 'pwd && npm install' \;
20+
- run: npm install
2521

2622
- name: Type Check
2723
run: tsc --build

README.md

+40-13
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,57 @@ The `main` branch is used for script development for Minecraft Preview and may o
1111

1212
<hr/>
1313

14-
- ### [Scripts](./scripts/)
14+
## [Scripts](./scripts/)
1515

16-
Community driven scripts that use Script API to do all kinds of crazy stuff in Minecraft.
16+
Community driven scripts that use Script API to do all kinds of crazy stuff in Minecraft.
1717

18-
> ⚠️ Some scripts might use API modules that are only enabled in specific runtime environments, including:
19-
>
20-
> - `@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).
18+
> [!IMPORTANT]
19+
> Some scripts might use API modules that are only enabled in specific runtime environments, including:
20+
>
21+
> `@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).
22+
>
23+
> `@minecraft/vanilla-data` and `@minecraft/math`: These are external Minecraft libraries published to NPM. They are not part of Minecraft's native modules.
2124
22-
- ### [Editor Extensions](./editorExtensions/)
25+
There are two ways to use external Minecraft libraries in behavior pack scripts:
2326

24-
Community driven editor extensions samples for editing Minecraft worlds. Only available on Editor projects in [Minecraft Editor](https://github.com/mojang/minecraft-editor).
27+
1. **Standalone file**
2528

26-
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!
29+
Download standalone files available from https://jaylydev.github.io/scriptapi-docs/meta/useful-links.html for quick, small-scale projects.
2730

28-
- ### [docs](./docs/)
29-
Contains technical documentation of Script API features.
30-
> **🚫 Documentation are no longer being updated**. Check out [Microsoft Learn](https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/) and [Bedrock Wiki](https://wiki.bedrock.dev/scripting/starting-scripts) for up-to-date infomation.
31+
2. **Bundling**
32+
33+
Installing it through npm, with advanced build configurations and bundling with esbuild:
34+
35+
```bash
36+
npm i @minecraft/math
37+
npm i @minecraft/vanilla-data
38+
```
39+
40+
Guide on bundle Minecraft Scripts with the following bundlers:
41+
42+
- ESBuild (Recommended): [Bundle Minecraft Scripts with ESBuild](https://jaylydev.github.io/posts/bundle-minecraft-scripts-esbuild/)
43+
- Webpack: [Bundle Minecraft Scripts with Webpack](https://jaylydev.github.io/posts/scripts-bundle-minecraft/)
44+
45+
## [Editor Extensions](./editorExtensions/)
46+
47+
Community driven editor extensions samples for editing Minecraft worlds. Only available on Editor projects in [Minecraft Editor](https://github.com/mojang/minecraft-editor).
48+
49+
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!
50+
51+
## Documentation
52+
53+
Check out the following links for Script API documentation:
54+
55+
- [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
56+
- [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.
57+
- [Bedrock Wiki](https://wiki.bedrock.dev/scripting/starting-scripts.html) - Learn the basics of the Script API on Bedrock Wiki.
3158
3259
## Contributing
3360
34-
Please contribute to this repository if you can. Check out [**Contributing Guidelines**](./CONTRIBUTING.md) for more infomation.
61+
Please contribute to this repository if you can. Check out [Contributing Guidelines](./CONTRIBUTING.md) for more infomation.
3562
3663
## License
64+
3765
This project is licensed under the MIT license.
3866
3967
Copyrights on the script files are each contributor listed at the beginning of each script file.
40-

docs/JavaScript/Error.md

-80
This file was deleted.

docs/JavaScript/ErrorReference.md

-228
This file was deleted.

0 commit comments

Comments
 (0)