# servercraft

> Make your own Minecraft server

Latest version **0.2.1** (published 2023-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install servercraft
pnpm add servercraft
yarn add servercraft
bun add servercraft
```

Provides the commands `ip`, `servercraft`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2023-04-22 |
| First published | 2022-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 10 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | CoolStone Tech |
| Maintainers | coolstone, systemsoftware |
| Keywords | minecraft, server, setup |

## Links

- npm: https://www.npmjs.com/package/servercraft
- Homepage: https://servercraft.coolstone.dev
- npm.io page: https://npm.io/package/servercraft

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^1.3.6
- [opener](https://npm.io/package/opener.md) ^1.5.2
- [praseodymium](https://npm.io/package/praseodymium.md) ^0.0.1

## Recent versions

- 0.2.1 (latest) — 2023-04-22
- 0.2.0 — 2023-04-21
- 0.1.0 — 2022-08-01
- 0.0.5 — 2022-07-11
- 0.0.4 — 2022-06-26
- 0.0.3 — 2022-06-13
- 0.0.2 — 2022-06-11
- 0.0.1 — 2022-06-11

## README

# Servercraft
### Make your own Minecraft server


## Installation
Download [Java](https://www.oracle.com/java/technologies/downloads/), if you haven't already. Then run
[`sudo npm i servercraft -g`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) in your command-line.
If you want to use it programmatically, install it with [`npm i servercraft`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) in your command-line.


## CLI

Get a full list of commands:
```bash
servercraft
```

Set up your server
```bash
servercraft setup <version>
```
Omit version to download the latest version

Setup & start your server
```bash
servercraft start
```

Get your IP
```bash
ip
```

## API 
### Initialize
```js
const servercraft = require('servercraft')
const server = new servercraft()
```
### Setup
```js
server.setup(startAfter, args, config, version)
```
If `startAfter` is false, you can omit or pass `null` for the `args` and `config` parameters. If `startAfter` is true, you can omit the `config` parameter.
### Start
```js
server.start(args, config)
```
### Stop
```js
server.stop()
```
### Get IP
```js
server.ip()
```

Args are command-line arguments, and config is a JSON object. You can find a list of all the arguments [here](https://servercraft.coolstone.dev/args). You can find a list of all the config options [here](https://servercraft.coolstone.dev/node.js)

## Other info
### Want this as an app? [Download for macOS & Windows](https://coolstone.itch.io/servercraft)

### Get more in-depth help on [Discord](https://discord.gg/nzTmfZ8) or read our [docs](https://servercraft.coolstone.dev)

### Report feedback & bugs [here](https://forms.gle/s7Wi4pZqNbZG72mU7)

### Like our work? [Support us on Patreon](https://www.patreon.com/coolstone)

---
_Source: https://npm.io/package/servercraft · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._