Command line tools for creating and compiling JavaScript Minecraft plugins.

@customrealms/cli

CustomRealms command-line tools for setting up and compiling JavaScript Minecraft plugins.

Installation

Install the CLI on your computer:

npm install -g @customrealms/cli

Then, you can use the CustomRealms CLI using the crx command in your terminal.

Start a project

mkdir my-plugin
cd my-plugin
crx init

That's it! You now have a plugin project ready to develop!

Build a JAR file

Compile your plugin project to a JAR file:

If you used crx init above to create your project, you can compile a JAR file using:

npm run build:jar

If you used a different method to create your project, use this instead:

crx build -o ./dist/my-plugin.jar
Owner
CustomRealms
CustomRealms is a framework for building custom Minecraft servers with JavaScript.
CustomRealms
https://github.com/customrealms/cli https://customrealms.io
Comments
  • Added ARM64

    Added ARM64

    This will add support for arm64 and also display the architecture during the npm install phase.

    Should resolve https://github.com/customrealms/cli/issues/4

  • Support for `permissions` and `commands` and general code cleanup

    Support for `permissions` and `commands` and general code cleanup

    This change adds support for permissions and commands sections in the package.json file of a CustomRealms plugin project. This information is converted to YAML and inserted to the plugin.yml file in the generated JAR file.

    The update also adds a crx yml command that prints the generated plugin.yml file to the standard output, which is useful for debugging issues with permissions and commands.

  • Not able to install npm package

    Not able to install npm package

    during node package installation it stops half way on the message : "reify:mkdirp: sill tarball no local data for @customrealms/cli@https://registry.npmjs.org/@custo" I think there's a typo somewhere "https://registry.npmjs.org/@custo"

  • ARM64 / Apple M1

    ARM64 / Apple M1

    Can't install this package on Apple's M1 Silicon.

    The following error is produced:

    % npm i -g @customrealms/cli 
npm ERR! code 1
npm ERR! path /opt/homebrew/lib/node_modules/@customrealms/cli
npm ERR! command failed
npm ERR! command sh -c node postinstall.js install
npm ERR! Installation is not supported for this architecture: arm64
npm ERR! Invalid inputs

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/[...]/.npm/_logs/2022-01-31T14_54_25_019Z-debug-0.log
  • Add includes to Jar file

    Add includes to Jar file

    I have a request to add something to @customrealms/cli so this feature would work purfectly. Add something like configs argument.

    {
  "name": "example-plugin",
   "version": "1.0.0",
   "description":  "",
   "configs": { 
       "config": "./configs/config.yml", 
       "messages": "./configs/messages.yml", 
       "data": "./configs/data.yml" 
  }
}

    We need it so we could create configs and could add default creata form, it should be stored where plugin.yml is stored. Otherwise it will just not work!

    Originally posted by @nedaras in https://github.com/customrealms/bukkit-runtime/pull/9#issue-1114236444

    RE: For your cli suggestion, I think it would be beneficial to do something like that for future options too, so we should do something like

    {
  "name": "example-plugin",
  "version": "1.0.0",
  "description": "",
  "customrealms": {
    "includes": {
      "/": ["./configs/*.yml"]
    }
  }
}

    The nesting under "customrealms" is per the CommonJS standard and to not conflict with other packages or future features. And, it's just my initial thought, but having an includes property with a map of dirs relative to the root of the jar to include files into using globs. If that makes sense

    Originally posted by @AL1L in https://github.com/customrealms/bukkit-runtime/issues/9#issuecomment-1022615354

Related tags
Command Line javascript plugin golang minecraft
Dapper is a CLI toolkit for compiling, deploying, and managing Algorand applications

??️ Dapper Decentralized Application Manager for the Algorand Blockchain Dappman is a Golang CLI toolkit for compiling, deploying, and managing Algora

Feb 11, 2022
Brigodier is a command parser & dispatcher, designed and developed for command lines such as for Discord bots or Minecraft chat commands. It is a complete port from Mojang's "brigadier" into Go.

brigodier Brigodier is a command parser & dispatcher, designed and developed to provide a simple and flexible command framework. It can be used in man

Dec 15, 2022
minectl 🗺 is a cli for creating Minecraft (java or bedrock) server on different cloud provider.

minectl ?? minectl️️ is a cli for creating Minecraft (java or bedrock) server on different cloud provider. It is a private side project of me, to lear

Jan 3, 2023
A command tool to help user install oh-my-zsh plugins fast in a comfortable way

zshx A command tool to help user install oh-my-zsh plugins fast in a comfortable way. in other way, it is a zsh plugin package manager. How to use the

Feb 11, 2022
A command line tool that builds and (re)starts your web application everytime you save a Go or template fileA command line tool that builds and (re)starts your web application everytime you save a Go or template file

# Fresh Fresh is a command line tool that builds and (re)starts your web application everytime you save a Go or template file. If the web framework yo

Nov 22, 2021
textnote is a command line tool for quickly creating and managing daily plain text notes.

textnote is a command line tool for quickly creating and managing daily plain text notes. It is designed for ease of use to encourage the practice of daily, organized note taking. textnote intentionally facilitates only the management (creation, opening, organizing, and consolidated archiving) of notes, following the philosophy that notes are best written in a text editor and not via a CLI.

Jan 2, 2023
An open-source GitLab command line tool bringing GitLab's cool features to your command line
 An open-source GitLab command line tool bringing GitLab's cool features to your command line

GLab is an open source GitLab CLI tool bringing GitLab to your terminal next to where you are already working with git and your code without switching

Dec 30, 2022
A command line tool to prompt for a value to be included in another command line.

readval is a command line tool which is designed for one specific purpose—to prompt for a value to be included in another command line. readval prints

Dec 22, 2021
Inotify-tools is a C library and a set of command-line programs providing a simple interface to inotify.

inotify-tools This is a package of some commandline utilities relating to inotify. The general purpose of this package is to allow inotify's features

Jan 4, 2023
go program that installs and customizes ohmyzsh tmux vim via various plugins and other nice to haves
 go program that installs and customizes ohmyzsh tmux vim via various plugins and other nice to haves

Pimp-My-Shell Table of Contents Pimp-My-Shell Install Usage About Resources Tmux Hotkeys VIM Hotkeys Adjusting Custom Aliases Mac Fix Terminal bind ke

Dec 22, 2022
Basic command line example using golang grpc client tools

This is a basic command line interface that demonstrates using the golang GRPC API. The API is reused between dishy and the wifi router, however both

Jan 3, 2023
GoTTY is a simple command line tool that turns your CLI tools into web applications.
 GoTTY is a simple command line tool that turns your CLI tools into web applications.

GoTTY - Share your terminal as a web application

Jan 3, 2023
Simple activity indicator for your command line tools.
 Simple activity indicator for your command line tools.

Simple activity indicator for your command line tools.

Oct 22, 2021
Command-line tools for the FFS module.

Command-line tools for FFS The blobd tool defines a JSON-RPC service that implements the FFS blob store interface over various underlying key-value st

Dec 14, 2022
wy : a set of command-line tools to test your container-based platform

wy wy (Abbreviation of Would You) is a set of command-line tools to test your container-based platform. ToC: Commands Deployment Monitoring Contributi

Apr 30, 2022
create boilerplate structure for neovim plugins

boilit Boil yourself a sweet plugin Installation • Usage Ain't nobody got time to create plugin directories: boilit yourself! boilit creates boilerpla

Dec 28, 2022
Loc2Midi - This project uses realtime location data to control audio effects plugins in order to simulate movement throughout a virtual soundscape
 Loc2Midi - This project uses realtime location data to control audio effects plugins in order to simulate movement throughout a virtual soundscape

Visualization of coordinate math Video demonstration of project This project use

Jan 3, 2022
mlp is a comman line tool responsible for creating, updating and deleting kubernetes resources based on files generated by Mia-Platform Console.

mlp is a comman line tool responsible for creating, updating and deleting kubernetes resources based on files generated by Mia-Platform Console.

Apr 28, 2022
Watcher - A simple command line app to watch files in a directory for changes and run a command when files change!

Watcher - Develop your programs easily Watcher watches all the files present in the directory it is run from of the directory that is specified while

Mar 27, 2022