https://github.com/azuyamat/boxes

Quick and easy CLI to create and manage Minecraft servers
https://github.com/azuyamat/boxes

cli minecraft rust

Last synced: 3 months ago
JSON representation

Quick and easy CLI to create and manage Minecraft servers

• Host: GitHub
• URL: https://github.com/azuyamat/boxes
• Owner: Azuyamat
• License: mit
• Created: 2023-12-08T06:04:28.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-24T08:23:43.000Z (about 1 year ago)
• Last Synced: 2024-04-25T02:39:47.841Z (9 months ago)
• Topics: cli, minecraft, rust
• Language: Rust
• Homepage: https://azu.lol/post/boxes
• Size: 121 MB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 📦 Boxes `v0.1.x` [![Rust](https://github.com/Azuyamat/Boxes/actions/workflows/rust.yml/badge.svg)](https://github.com/Azuyamat/Boxes/actions/workflows/rust.yml)

Heyo! I made a cool CLI to manage servers locally and externally. Like it? Consider adding that cool little ⭐. 

![Preview](images/preview.png)

## Description

Boxes is a tool designed to manage Minecraft servers locally. It provides a convenient way to start, stop, and configure Minecraft servers on your local machine. With Boxes, you can easily create and manage multiple server instances, *install plugins* (WIP), and customize server settings. Whether you're a Minecraft enthusiast or a server administrator, Boxes simplifies the process of running Minecraft servers locally, allowing you to focus on enjoying the game or managing your community!

This tool only supports **Windows** and **MacOS (With Cargo)** unless you build your own version by cloning the repository.

## Installation

### Easiest method (Requires cargo)

1. Run `cargo install boxes`

2. Enjoy :)

### Second method

1. Install the latest stable `.exe` from [here](https://github.com/Azuyamat/Boxes/releases/latest)

2. Place the `.exe` under a `Boxes` folder in your `Program Files`

3. Add the path to the parent directory of the `.exe` to the environment variables

4. Run the `.exe` in your terminal or simply write `boxes` if you did steps 2 & 3

5. Enjoy :)

## Usage

> All commands are pre-fixed with `boxes`

### Default commands

Create a server:

`create     [BUILD]`

Start a server:

`start `

View config (Not much here yet):

`config info`

### Server commands

> All commands below are pre-fixed with `boxes server`

List all servers verbosely:

`list `

Generate a server using a quick and handy "questionnaire":

`generate`

Get info about a server:

`info `

Start a server:

`start `

Delete a server (CAUTION):

`delete `

Add an existing server:

`add `

Manage plugins (WIP):

`plugins `

Assign an IP to a server:

`assign-ip  `

## License

This product is available under the [MIT license](https://opensource.org/licenses/MIT).