Skip to content
This repository has been archived by the owner on Jun 23, 2022. It is now read-only.

Commit

Permalink
1.0.0: full release
Browse files Browse the repository at this point in the history
Add `configver` param to `.rpkr.json`
  • Loading branch information
Nixinova committed Aug 1, 2020
1 parent 63115f5 commit 535e879
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
11 changes: 7 additions & 4 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# Changelog

## 1.0.0-pre3
## 1.0.0
*2020-08-01*
- Added `configver` parameter to the `.rpkr.json` configuration file.

### 1.0.0-pre3
*2020-07-18*
- **Breaking:** Changed configuration file from `.rpkr` (in a custom format) to `.rpkr.json` (in a JSON format).
- Added support for automatic langugage generation by setting the values of language codes in the `.rpkr.json` configuration file.
- Removed support for custom variables in the configuration file.

## 1.0.0-pre2
### 1.0.0-pre2
*2020-07-16*
- Added `description` property to `.rpkr`, which creates an automatic `pack.mcmeta` file if set.
- Can contain references to other parameters in the `.rpkr` file (including custom ones) by enclosing the parameter name in angle brackets (`<>`).
- Ampersands (`&`) are automatically converted to section signs (`§`) to become color codes.
- Pack version is automatically generated from the value of `mcver`.
- Added support for custom variables in the `.rpkr` configuration file.

## 1.0.0-pre1
### 1.0.0-pre1
*2020-07-16*
- Supports the creation and reading of `.rpkr` configuration files with keys `name`, `packver`, `mcver`, `snapver`, and `files`.
- Supports packaging into either a pre-set (using `.rpkr`) or user-specified output folder.
3 changes: 2 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
#!/usr/bin/env node
const RPKR_VERSION = '1.0.0-pre3';
const RPKR_VERSION = '1.0.0';

const fs = require('fs');
const copyfiles = require('copyfiles');
const jsonformat = require('json-format');
const log = str => console.log('<resourcepacker> ' + str);

const CONFIG = {
configver: 2,
name: process.cwd().split(/\/|\\/).slice(-1)[0],
packver: '1.0.0', mcver: '1.16.x', mcsnap: null,
description: null, languages: null,
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "resourcepacker",
"version": "1.0.0-pre3",
"version": "1.0.0",
"description": "Easily and cleanly packages Minecraft resource packs from a messy working directory",
"keywords": [
"minecraft",
Expand Down
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[![Latest version](https://img.shields.io/github/v/release/Nixinova/resourcepacker?label=latest&style=flat-square&include_prereleases)](https://github.com/Nixinova/resourcepacker/releases)
[![npm version](https://img.shields.io/npm/v/resourcepacker?style=flat-square)](https://www.npmjs.com/package/resourcepacker)
[![npm downloads](https://img.shields.io/npm/dt/resourcepacker?style=flat-square)](https://www.npmjs.com/package/resourcepacker)
[![Latest version](https://img.shields.io/github/v/release/Nixinova/resourcepacker?label=latest&style=flat-square&logo=github)](https://github.com/Nixinova/resourcepacker/releases)
[![npm downloads](https://img.shields.io/npm/dt/resourcepacker?style=flat-square&logo=npm)](https://www.npmjs.com/package/resourcepacker)
[![Last updated](https://img.shields.io/github/release-date-pre/Nixinova/resourcepacker?label=updated&style=flat-square)](https://github.com/Nixinova/resourcepacker/releases)

# resourcepacker
Expand All @@ -13,14 +12,15 @@ Install [resourcepacker on npm](https://www.npmjs.com/package/resourcepacker) by

After installing resourcepacker, type **`rpkr init`** to ready your directory with a configuration file (`.rpkr.json`). For information on how to use this configuration file, please see the **Configuration** section below.

To package a resource pack, simply type **`rpkr pack`** and your resource pack will be packaged into an output folder. You can control which directory the files are outputted to by placing the output folder name in quotes after this command; for example, `rpkr pack "My Pack 1.16"` outputs to folder "My Pack 1.16". If the output folder is not set, it defaults to the format "`name` `packver` (`mcver`)", where each value comes from the `.rpkr.json` file.
To package a resource pack, simply type **`rpkr pack`** and your resource pack will be packaged into an output folder. You can control which directory the files are outputted to by placing the output folder name in quotes after this command; for example, `rpkr pack "My Pack 1.16"` outputs to folder "My Pack 1.16". If the output folder is not set, it defaults to the format "`<name>` `<packver>` (`<mcver>`)", where each value comes from the `.rpkr.json` file.

## Configuration

The `.rpkr.json` configuration file can be edited to fine tune the output of your resource pack. Comments can be added using a hash (`#`).

### Parameters

* `configver`: The `.rpkr.json` file version. Leave as-is.
* `name`: The name of your resource pack. Defaults to the name of the current folder.
* `packver`: The version of your resource pack. Defaults to "1.0.0".
* `mcver`: The Minecraft version your resource pack is made for. Defaults to "1.16.x".
Expand Down

0 comments on commit 535e879

Please sign in to comment.