This commit is contained in:
DaanV2
2021-04-30 17:21:14 +02:00
parent 9bcfd97f21
commit fb63d19def
2 changed files with 26 additions and 4 deletions

View File

@@ -1,4 +1,16 @@
# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a
change. For smaller fixes, additions or changes a simple fork and pull request is sufficient.
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
## Titles
Titles of elements or object in schemas are preferered to be a capitilized version of the name of the object replacing any special character with space forexample. Some are in need
of version numbering (behaviors) to help with debugging complex schemas
## Description
Descriptions are to be 1:1 with Microsofts original description of said item. If none are provided or the object doesn't exist in official documentation but is a feature, then
replace the description with `UNDOCUMENATED`. Or fill in a general description that would hold true even if any changes are made to the workings of the item.

View File

@@ -1,20 +1,27 @@
# Minecraft-bedrock-json-schemas
The json validation schema files for Minecraft bedrock
- [Minecraft-bedrock-json-schemas](#minecraft-bedrock-json-schemas)
- [Contributing](#contributing)
- [Manual Usage](#manual-usage)
- [Vscode](#vscode)
- [Contents](#contents)
- [behavior files](#behavior-files)
- [Resource files](#resource-files)
- [Contributing](#contributing)
- [Contributing](#contributing-1)
## Contributing
Any changes to the schemas are to be done through the source files in the folder source. these get converted and compressed through an action into smaller schemas. On other matters
follow the [Contribution guide](CONTRIBUTING.md)
## Manual Usage
### Vscode
- Copy the `vscode-settings.json` file into the `.vscode` folder in your project and rename it to: `settings.json`
OR
OR
- Copy the contents of `vscode-settings.json` into your `.code-workspace` file under the property settings:
```json
@@ -29,9 +36,11 @@ OR
```
---
# Contents
## behavior files
- [Animation Controllers](behavior/animation_controllers/animation_controller.json)
- [Animations](behavior/animations/animations.json)
- [Blocks](behavior/blocks/blocks.json)
@@ -64,6 +73,7 @@ OR
- [Terrain list](resource/textures/texture_list.json)
## Contributing
This project could more help in filling in descriptions, titles and giving snippets!
Json validation can give snippets for sub items. as well as description, but this hasn't always been filled out!
Json validation can give snippets for sub items. as well as description, but this hasn't always been filled out!