https://github.com/blockception/mb-action-create-mcworld

The github action that will create a mcworld in a given respository
https://github.com/blockception/mb-action-create-mcworld

actions bedrock create github-actions hacktoberfest hacktoberfest2022 mcworld minecraft

Last synced: 4 months ago
JSON representation

The github action that will create a mcworld in a given respository

• Host: GitHub
• URL: https://github.com/blockception/mb-action-create-mcworld
• Owner: Blockception
• License: bsd-3-clause
• Created: 2021-03-14T09:57:15.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-01-27T18:58:53.000Z (about 1 year ago)
• Last Synced: 2025-01-27T19:52:28.411Z (about 1 year ago)
• Topics: actions, bedrock, create, github-actions, hacktoberfest, hacktoberfest2022, mcworld, minecraft
• Language: TypeScript
• Homepage:
• Size: 2.39 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Minecraft Bedrock Action: Create MCWorld

[![tagged-release](https://github.com/Blockception/MB-Action-Create-MCWorld/actions/workflows/tagged-release.yml/badge.svg)](https://github.com/Blockception/MB-Action-Create-MCWorld/actions/workflows/tagged-release.yml)

[![npm-unit-test](https://github.com/Blockception/MB-Action-Create-MCWorld/actions/workflows/npm-test.yml/badge.svg)](https://github.com/Blockception/MB-Action-Create-MCWorld/actions/workflows/npm-test.yml)

- [Minecraft Bedrock Action: Create MCWorld](#minecraft-bedrock-action-create-mcworld)

  - [Actions](#actions)

  - [Inputs](#inputs)

  - [Outputs](#outputs)

  - [Example usage](#example-usage)

The github action that will create a mcworld in a given repository and performs configurable actions on the world:

## Actions

- Minify and removing comments from json files

- Removing unwanted files from folders

## Inputs

**folder**:  

The folder where the world is, example `${{github.workspace}}/world`

**processJson**:  

Whether or not to format json and minify json, defaults to true

**trimFiles**:  

Whether or not to remove unwanted files, defaults to true

**outputFile**:  

Defaults to the folder above the specified source folder with file name: word.mcworld, but this parameter can be overwritten.

## Outputs

**worldFilepath**:  

The outputted mcworld filepath

## Example usage

See [Create-Mcworld-On-Tag](examples/Create-Mcworld-On-Tag.yml) for a workflow that creates a release for each git tag created.

```yml

# This is a basic workflow to help you get started with Actions

name: create-mcworld

# Controls when the action will run.

on:

  push:

    # Sequence of patterns matched against refs/tags

    tags:

      - "v*"

  # Allows you to run this workflow manually from the Actions tab

  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel

jobs:

  # This workflow contains a single job called "build"

  build:

    # The type of runner that the job will run on

    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job

    steps:

      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it

      - name: 📦 Checkout Repository

        uses: actions/checkout@v3

      # Runs a single command using the runners shell

      - uses: Blockception/MB-Action-Create-MCWorld@v1.2.1

        id: create_mcworld

        with:

          # Path to the folder, assume ${{github.workspace}} leads to root of the repo

          folder: ${{github.workspace}}/world

          processJson: false

          trimFiles: true

```