# minecraft-splash-ts

> An updated collection of minecraft's title screen messages (java + bedrock).

Latest version **1.0.1** (published 2023-01-30) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install minecraft-splash-ts
pnpm add minecraft-splash-ts
yarn add minecraft-splash-ts
bun add minecraft-splash-ts
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-01-30 |
| First published | 2023-01-30 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 84.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | cuppachino |
| Maintainers | cuppachino |
| Keywords | minecraft, title, splash, text, list, typescript, bedrock edition, java edition |

## Links

- npm: https://www.npmjs.com/package/minecraft-splash-ts
- Repository: https://github.com/Cuppachino/minecraft-splash-ts
- Homepage: https://github.com/Cuppachino/minecraft-splash-ts#readme
- Issues: https://github.com/Cuppachino/minecraft-splash-ts/issues
- npm.io page: https://npm.io/package/minecraft-splash-ts

## Dependencies (1)

- [colorix](https://npm.io/package/colorix.md) ^1.0.3

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-01-30
- 1.0.0 — 2023-01-30

## README

# Minecraft Splash (TS)

502 total splash quotes.

```json5
[
  "That's no moon!",
  "90% bug free!",
  "Gasp!",
  "Bees, bees, bees, bees!",
  "Jag känner en bot!",
  "This text is hard to read if you play the game at the default resolution, but at 1080p it's fine!",
  "...!",
  // ... 495 more
]
```

## `mincraft-splash-ts`

### Installation

Add to your project using your favorite package manager.

### NPM

```llvm
npm install minecraft-splash-ts
```

### PNPM

```llvm
pnpm add minecraft-splash-ts
```

### Yarn

```llvm
yarn add minecraft-splash-ts
```

## Exports

| Feature | Description (literally typed) |
| :---: | :--- |
| [`default`](src/splashes.mts) | Combined 502 splashes from Minecraft (Java + Bedrock) |
| [`je`](src/splashes.mts) | 439 splashes from Minecraft Java Edition |
| [`be`](src/splashes.mts) | 63 splashes from Minecraft Bedrock Edition |
| [`logRandomSplash`](src/index.mts) | Log a random splash to the console (with or without color) |
| [`pickRandom`](src/index.mts) | Pick a random element from an array |

## Usage

The lists are literally typed, so you can skim through them in your IDE to find the one you want.

```ts
import splashes, { pickRandom, je, be } from 'minecraft-splash-ts';

console.log(pickRandom(splashes)); // "GOTY!",
console.log(pickRandom(je)); // "100% pure!",
console.log(pickRandom(be)); // "Made in C++!",
```

If you want to log a random splash to the console, and you want it to be colorful, you can use `logRandomSplash`. The function uses [`colorix`](https://www.npmjs.com/package/colorix) to colorize the text.

```ts
import { logRandomSplash } from 'minecraft-splash-ts';

logRandomSplash(); // italic + gray
logRandomSplash("bgYellow", "white") // yellow background + white text
logRandomSplash(false) // no color
```

## Omitted Quotes

| Splash Text | Reason |
| :---: | :--- |
| `"code.org/minecraft"` | commercial |
| `"discord.gg/minecraft"` | potentially confusing out of context |
| `"feedback.minecraft.net"` | commercial / potentially confusing out of context |

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