@mc-resource/cli/README.md

a Resource Manager for Minecraft

<img height="40" alt="MCR" src="./assets/mcr-logo.png" />

> **⚠️WARNING:**
> MCR is now at the very beginning (EXPERIMENTAL) stage.
> experimental versions are available on npm to install.
Consider specifying the version when installing MCR.
> we ask Developers to help the project. Pull Requests are welcome!

# Resource Manager for Minecraft (MCR) 📦

<a href="https://discord.com/invite/z94zBybbhX">
    <img src="https://img.shields.io/badge/Discord-Click_Here-5865F2?style=flat-square&logo=discord&logoColor=white" />
</a>
<a href="https://www.npmjs.com/package/@mc-resource/cli">
    <img src="https://img.shields.io/badge/npm-%40mc--resource%2Fcli-red?style=flat-square&logo=npm" />
</a>
<a href="https://www.npmjs.com/package/@mc-resource/cli">
    <img src="https://img.shields.io/npm/dm/%40mc-resource%2Fcli?style=flat-square&label=Downloads&color=purple">
</a>
<a href="https://www.npmjs.com/package/@mc-resource/cli">
    <img src="https://img.shields.io/npm/v/@mc-resource/cli/latest?link=https://www.npmjs.com/package/@mc-resource/cli&color=emerald&label=Latest&style=flat-square" />
</a>
<a href="https://www.npmjs.com/package/@mc-resource/cli">
    <img src="https://img.shields.io/npm/v/@mc-resource/cli/experimental?label=Experimental&link=https://www.npmjs.com/package/@mc-resource/cli&style=flat-square" />
</a>



**Resource Manager for Minecraft (MCR)** is an advanced CLI tool for setting up and managing Minecraft Instances and Servers and publishing your Resources. Possibilities of
This tool is much higher than managing big and complex Modpacks and Servers.

## Installation

MCR requires [Node.js](https://nodejs.org/) and `npm` (installed with Node.js by default) to be installed on your system. To install mcr, you can get the CLI package with:

```bash
npm i -g @mc-resource/cli
```

## Usage

MCR Command-Line Interface (CLI) is accessible using Terminal to interact with resources in the Path.
The shortcut is `mcr`.

for example, to install resources you can easily write: 
```bash
mcr install fabric-api sodium fresh-animations ...
```

to see the general and complete usage of MCR please refer to [Wiki](https://github.com/mc-resource/cli/wiki) page.


## Roadmap
MCR has a lot of ideas and plans shared by it's own Community, generaly approved ones are available at this [Roadmap](https://github.com/mc-resource/cli/wiki/Roadmap).

## Development
- Dev Dependencies are required for Typescript: `npm i -D`.
- Commands can be directly run with `npm run dev`.
- Typescript Building is possible within `npm run build` with export of `./dist/`.
- Folders generated by MCR is already excluded from git.

## Security
Currently, MCR retrieves resources from external registries based on user request. Although these registries are publicly trusted by the community, we do not take responsibility for any harm or system/software damage caused by files obtained from these sources.  
For more details and best practices, please refer to the [Security](https://github.com/mc-resource/cli/wiki/Security) page.

## License 
This project is released, published and maintained under MIT License.

@ 2024-present Arman Studios.

Not an official Minecraft product or service. Not approved by Mojang or Microsoft.