Skip to content

Latest commit

 

History

History
98 lines (74 loc) · 3.75 KB

README.md

File metadata and controls

98 lines (74 loc) · 3.75 KB
Raw

Minecraft Bedrock NPM Updater

Icon

Overview

The Minecraft Bedrock NPM Updater is a Visual Studio Code extension designed to streamline the process of managing Node.js packages for Minecraft Bedrock scripting API development. With this tool, developers can automatically update their Node modules, ensuring they always have the latest versions across their projects.

Features

  • Auto-Update Modules: Automatically update your specified Minecraft-related Node modules when you start VSCode.
  • Customizable Scheduling: Set your updates to run daily, weekly, or monthly based on your preferences.
  • Manual Update Command: Trigger an update for your Node modules at any time with a simple command.
  • User-Defined Modules: Add your own custom Node modules to the update list, ensuring all your dependencies stay current.
  • Visual Studio Code Settings Integration: Easily configure your update settings through the VSCode settings GUI or the settings.json file.

Installation

  1. Clone this repository to your local machine: 
    git clone https://github.com/YourUsername/minecraft-bedrock-npm-updater.git
  2. Navigate to the project directory: 
    cd minecraft-bedrock-npm-updater
  3. Install the necessary dependencies: 
    npm install
  4. Compile the TypeScript files: 
    npm run compile
  5. Open the project in Visual Studio Code: 
    code .

Usage

Auto-Update Settings

The extension allows you to customize which modules are updated and how often. You can configure these settings in your settings.json or via the VSCode settings GUI:

{
  "minecraftModules.enableAutoUpdate": true, // Enable or disable auto-update
  "minecraftModules.scheduleUpdate": "daily", // Set to "daily", "weekly", or "monthly"
  "minecraftModules.enabledModules": [
    "@minecraft/server",
    "@minecraft/server-ui",
    "@minecraft/math",
    "@minecraft/vanilla-data",
    "@minecraft/common",
    "@minecraft/core-build-tasks",
    "@minecraft/server-admin",
    "@minecraft/server-gametest",
    "@minecraft/server-net",
    "@minecraft/server-editor",
    "@minecraft/debug-utilities"
  ],
  "minecraftModules.userDefinedModules": [
    // Add any custom or third-party modules here
  ]
}

Commands

  • Update Minecraft Modules: Run this command to manually update your Node modules.
Press F1 and type "Update Minecraft Modules"

Contributing

We welcome contributions from the community! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name.
  3. Make your changes and commit them with clear messages.
  4. Push your changes to your fork and submit a pull request.

Issues

If you encounter any issues or have suggestions for improvements, please report them on the GitHub Issues page.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

About CrossXover Gaming

CrossXover Gaming is a small but passionate development studio founded by Captain Cooky. We focus on creating practical and useful tools for developers and content creators, especially within the Minecraft community. Our work supports and collaborates with creators like TersHD, ArtsByKev, and Nexus Mob Studio.

We're dedicated to building tools that make the development process easier and more efficient, whether you're working on a Minecraft project or other creative endeavors. At CrossXover Gaming, we're all about sharing what we've learned and helping others bring their ideas to life.