Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 2.35 KB
Raw

Contributing

Contributing infomation. This info changes because Script API is currently in active development, and breaking changes are frequent.

Creating a new script sample

  • Create a new directory for your script sample in the scripts directory. The directory name is your sample name and should be is unique and infomative.

  • Create a folder structure based on the following:

File Purpose
index.js or index.ts This is main file for the package.
README.md Infomation for the package.

In the main file, you must input basic credentials for the scripts with the right format. For example, here are the first few lines of script example:

// Script example for ScriptAPI
// Author: Alice <https://github.com/alice>
//         Bob <https://github.com/bob>
//         Steve <https://steve.com/>
// Project: https://github.com/JaylyDev/ScriptAPI

In order for the pull request to be merged, the scripts must pass TypeScript Compiling process for all JavaScript/TypeScript files.

image

Above image shows all checks have passed and the pull request should be able to be merged.

If the check did not pass, go to the 'details' section and see what section of the check went wrong, and attempt to fix the issue by pushing another commit to your branch.

Create an editor extension sample

An editor extension sample should only be used in Minecraft Editor, otherwise the sample should be hosted in 'scripts' folder.

  • Create an editor extension sample in editorExtensions directory.

  • Create the same folder structure as used in scripts folder and a header in main file like creating a new script sample.

  • We recommend using TypeScript for editor extension samples.

Don't edit docs folder

Documentation are no longer being updated as mentioned in README.

Please do not submit any pull requests that changes any content to the docs directory. Instead, please visit Bedrock Wiki and perhaps contribute scripting documentation in Bedrock Wiki GitHub repository: https://github.com/Bedrock-OSS/bedrock-wiki/tree/wiki/docs/scripting