Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/foopis23/ts-datapacks

A TypeScript library for creating Minecraft datapacks
https://github.com/foopis23/ts-datapacks

datapack framework minecraft

Last synced: about 2 months ago
JSON representation

A TypeScript library for creating Minecraft datapacks

Awesome Lists containing this project

README

        

# ts-datapacks

ts-datapacks is a TypeScript library for creating Minecraft datapack. It started out as just some cobbled together scripts for a data pack I was making, but I decided I wanted to make it into a library to use on future projects.

## Benefits

- Type safe interface for creating Minecraft data packs
- No need to learn a new language or syntax

## Supports
- Pack Version 48+ (1.21+)

## Features

- [x] mcfunction generation (for doing macro like operations in mcfunction files)
- [x] Static directory for non-generated files and/or unsupported features
- [x] Project initialization
- [ ] Syntax highlighting for embedded mcfunction strings
- [x] Type safe recipe definitions
- [ ] Type safe dimension definitions
- [ ] Type safe loot table definitions
- [ ] Type safe advancement definitions
- [ ] Type safe structure definitions
- [ ] Type safe tag definitions
- [ ] Older pack version support

## Getting Started

### Requirements

- bun (https://bun.sh/docs/installation)

### Create New Project

```bash
bun add -g https://github.com/foopis23/ts-datapacks
bux tsmc init # this will create a new directory named ./ and create the initial project in there
```

### Compile Data Pack

```bash
bun run build
```

## Example Projects

- [Example](./example/)
- [Cool Points](https://github.com/foopis23/cool-points)