https://github.com/mojang/minecraft-creator-tools

A set of tools for creating content and add-ons for Minecraft Bedrock Edition.
https://github.com/mojang/minecraft-creator-tools

Last synced: 5 days ago
JSON representation

A set of tools for creating content and add-ons for Minecraft Bedrock Edition.

• Host: GitHub
• URL: https://github.com/mojang/minecraft-creator-tools
• Owner: Mojang
• License: other
• Created: 2023-09-04T15:47:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-05T18:09:59.000Z (18 days ago)
• Last Synced: 2024-12-16T12:08:20.458Z (7 days ago)
• Language: TypeScript
• Size: 28.8 MB
• Stars: 75
• Watchers: 45
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Support: SUPPORT.md

Awesome Lists containing this project

README

        
# Minecraft Creator Tools

This project is a work in progress for a set of web-based and command line tools for Minecraft creators.

Visit the [documentation](https://mctools.dev/docs/) for more information on Minecraft Creator Tools and the current set of capabilities.

See the [changelog](CHANGELOG.md) for detailed updates and notes. If you have issues, please create a [GitHub issue](https://github.com/Mojang/minecraft-creator-tools/issues).

See the [Project Structure](ProjectStructure.md) file for a look at the structure of the codebase including a tour of major types.

Please note that, at this time, we are not able to accept pull request contributions from the broader community.

## Using Creator Tools

Visit this web app via .

Enjoy!

## GitHub Repo & Developer Getting Started

Everything is built out of the `app` folder.

In the `app\` folder, run

```dotnetcli

npm run all

```

to install dependencies and resources, and compile projects.

## Build Scripts

In the project directory, you can run:

### `npm start` \ `npm run web`

Runs the app in the development mode.

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.

See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run jsnbuild`

Builds the command line application into `toolbuild/jsn` folder. You can then run the command line tool from `npx toolbuild\jsn`.

You can package the command-line by running `npm pack` in `toolbuild/jsn`.

### `npm run webbuild`

Builds the web app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is also minified.

## Command Line Tool

Once packaged, you can install the command line locally via `npm install minecraft-creator-tools-.tgz`. If you'd like to make Minecraft Creator Tools available across your device, you can install it globally via `npm install -g minecraft-creator-tools-.tgz`. Minecraft Creator Tools is also available on NPM via [@minecraft/creator-tools](https://aka.ms/mctnpm).

See the [command-line readme](./app/jsnode/README.md) for more instructions on using the command line.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.