Skip to content
This repository has been archived by the owner on Jan 2, 2023. It is now read-only.

Commit

Permalink
release 2.0.0-alpha.1
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeDoctor committed Sep 15, 2021
1 parent 6664b91 commit 4330c8b
Show file tree
Hide file tree
Showing 25 changed files with 369 additions and 20 deletions.
11 changes: 11 additions & 0 deletions docs/blog/2021-09-15-2.0.0-alpha.1-released.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 2.0.0-alpha.1 released
author: CodeDoctorDE
author_title: Core maintainer
author_url: https://github.com/CodeDoctorDE
author_image_url: https://avatars.githubusercontent.com/u/20452814?v=4
tags: [alpha, released, itemmods]
---

This is a maintenance update.
Translation bugs ([#18](https://github.com/CodeDoctorDE/ItemMods/issues/18)) were fixed and new api methods were implemented.
2 changes: 1 addition & 1 deletion docs/docs/api/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The latest build can you find [here](https://ci.codemc.io/job/CodeDoctorDE/job/I
<dependency>
<groupId>dev.linwood</groupId>
<artifactId>ItemMods</artifactId>
<version>2.0.0-alpha.0</version>
<version>2.0.0-alpha.1</version>
</dependency>
</dependencies>
</project>
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/user/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ slug: /
sidebar_position: 0
---

![Header](https://github.com/CodeDoctorDE/ItemMods/blob/develop/assets/header.png?raw=true)

---

Welcome to the ItemMods wiki!
Use the navigator to navigate between pages.

Expand Down
5 changes: 5 additions & 0 deletions docs/src/pages/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## 2.0.0-alpha.1

This is a maintenance update.
Translation bugs ([#18](https://github.com/CodeDoctorDE/ItemMods/issues/18)) were fixed and new api methods were implemented.

## 2.0.0-alpha.0

ItemMods has its first birthday! Happy birthday! Come to [the discord](https://go.linwood.dev/itemmods-discord) to celebrate this!
Expand Down
4 changes: 4 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/api/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Developer",
"position": 2
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Create an addon
---

* First, use this template: <https://github.com/CodeDoctorDE/ItemMods-Addon>. You can find a button "Use this template" to create your repository from this template.
* Clone this repository to your computer with the `git clone` command.
* ...
* Upload that on <https://spigotmc.org>. I will help you if you have problems or you want to link it on the main page of ItemMods.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Custom model data
---

## What is custom model data?

Minecraft added in 1.14 this new item property. With this you can change every item to a new model and texture.
29 changes: 29 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/api/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: API
---

The latest build can you find [here](https://ci.codemc.io/job/CodeDoctorDE/job/ItemMods/lastStableBuild/)

* You can use maven to get the dependency or can use the jars in the github actions.
* For maven please use this:
```xml
<project>
<repositories>
<repository>
<id>codemc-repo</id>
<url>https://repo.codemc.org/repository/maven-public/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>dev.linwood</groupId>
<artifactId>ItemMods</artifactId>
<version>2.0.0-alpha.0</version>
</dependency>
</dependencies>
</project>
```
* The documentation about the api can you find [here](https://codedoctor.tk/ItemMods/apidocs). Please use the classes in the api package. The ItemModsApi instance can you get with `ItemMods.getPlugin().getApi()`
* Custom events:
* CustomBlockPlaceEvent
* CustomBlockBreakEvent
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "User",
"position": 1
}
5 changes: 5 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/addons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Addons
---

There are currently no addons.
13 changes: 13 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/better-gui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: BetterGui
---

> Visit [BetterGUI](https://www.spigotmc.org/resources/75620/)
Usage:
```yaml
stone:
custom-item: YOUR_TAG
amount: 32
```
Replace YOUR_TAG with the tag of the custom item.
16 changes: 16 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/custom-blocks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Custom blocks
---

:::note
To have custom textures, you need to have a pack. See [here](pack.md#create-a-pack) to see how you can create one.
:::

## Create a custom block

* Create a [reference item](custom-items.md)
* Go to the block list and click on the knowledge book
* Give the block a name
* [Create a model](custom-models.md) for this block
* Set the model in the block gui
* Add the `Block set template` to the reference item and set the current block
14 changes: 14 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/custom-items.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Custom items
---

:::note
To have custom textures, you need to have a pack. See [here](pack.md#create-a-pack) to see how you can create one.
:::

## Create a custom item

* Go to the item list and click on the knowledge book
* Give the item a name
* [Create a model](custom-models.md) for this block
* Set the model in the item gui
85 changes: 85 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/custom-models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: Custom models
---

:::note
To have custom textures, you need to have a pack. See [here](pack.md#create-a-pack) to see how you can create one.
:::

## Create a custom model

* Go to the model list in the pack gui
* Click on the knowledge book
* Give it a name
* Go to the data gui
* Change the default variation or add your own variation to the texture by clicking on the knowledge book
* You can choose where the model file is located. File or internet:
* If you choose file, you need to add the texture file in plugins/ItemMods/temp
* Now you need to enter the file name, for example `ruby.json`
* If you choose internet, you need the direct link to the json
* If you choose it, please add `.json` to the url, for example `https://example.com/YOURFILE.json`

:::caution
You need to export the resource pack before having a custom model.
:::

## Examples

Create a file with this content in the temp directory.
Replace the *\<placeholder\>* with your values and assign it to a model

### Block model

The default block model:
```json title="block.json"
{
"textures": {
"0": "<your block texture>",
"particle": "<your block texture>"
},
"elements": [
{
"from": [0, 0, 0],
"to": [16, 16, 16],
"faces": {
"north": {"uv": [0, 0, 16, 16], "texture": "#0"},
"east": {"uv": [0, 0, 16, 16], "texture": "#0"},
"south": {"uv": [0, 0, 16, 16], "texture": "#0"},
"west": {"uv": [0, 0, 16, 16], "texture": "#0"},
"up": {"uv": [0, 0, 16, 16], "texture": "#0"},
"down": {"uv": [0, 0, 16, 16], "texture": "#0"}
}
}
],
"display": {
"thirdperson_righthand": {
"translation": [-7, 5, 3],
"rotation": [45.5, 5, -8.5],
"scale": [3.9, 3.9, 3.9]
},
"ground": {
"scale": [0.3, 0.3, 0.3]
},
"gui": {
"rotation": [45, 45, 0],
"scale": [0.65, 0.65, 0.65]
},
"head": {
"translation": [0, -30.75, 0],
"scale": [4, 4, 4]
}
}
}

```

### Block item model

```json title="block_item.json"
{
"parent": "minecraft:block/cube_all",
"textures": {
"all": "<your block texture>"
}
}
```
20 changes: 20 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/custom-textures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Custom textures
---

:::note
To have custom textures, you need to have a pack. See [here](pack.md#create-a-pack) to see how you can create one.
:::

## Create a custom texture

* Go to the textures list in the pack gui
* Click on the knowledge book
* Give it a name
* Go to the data gui
* Change the default variation or add your own variation to the texture by clicking on the knowledge book
* You can choose where the texture file is located. File or internet:
* If you choose file, you need to add the texture file in plugins/ItemMods/temp
* Now you need to enter the file name, for example `ruby.png`
* If you choose internet, you need the direct link to the png
* If you choose imgur, please add `.png` to the url, for example `https://example.com/YOURFILE.png`
17 changes: 17 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Home
slug: /
sidebar_position: 0
---

![Header](https://github.com/CodeDoctorDE/ItemMods/blob/develop/assets/header.png?raw=true)

---

Welcome to the ItemMods wiki!
Use the navigator to navigate between pages.

## Resource Pages:
* [SpigotMC](https://www.spigotmc.org/resources/72461/)
* [Polymart](https://polymart.org/resource/15)
* [Songoda](https://songoda.com/marketplace/product/162)
23 changes: 23 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/pack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Pack
---

A pack is a collection of blocks, items, models, textures and more.

## Create a pack

* Run `/itemmods`
* Click on the pack icon
* Click on the knowledge book and give a name. The name should only have a-z, - and _.
* Done

Now you can create [custom items](custom-items.md), [custom blocks](custom-blocks.md) and more...

## Share the pack

* Go to the pack gui
* Open the manage gui
* Click on export
* Now you should have a zip file with the same name as the pack in the temp folder

This archive can you send with a description in our #share channel in the discord server.
54 changes: 54 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/preset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Preset
---

The preset directory is the preset for the resource pack.
Here you can configure the `pack.mcmeta` and all models/textures and everything else.

## Create the preset

You need this folder structure to have a working resource pack.
If you have an item with the fallback texture diamond, you need to have a `diamond.json`.

```markdown
├── pack.mcmeta
└── assets
└── minecraft
└── models
└── item
└── diamond.json
```

The `pack.mcmeta` needs to have this content:

```json title="pack.mcmeta"
{
"pack": {
"description": "The name of the resource pack",
"pack_format": 7
}
}
```

The `diamond.json` needs to have the same content as the default texture of minecraft.

To get this done, you need an archive reader like 7-zip or WinRAR.

Then you need to locate to your minecraft client jar which is normally located in `%appdata%/.minecraft/versions/VERSION/VERSION.jar`
(You need to replace the VERSION with the version which you used to connect to the server).

In the jar archive you will find a `assets` directory. There you need to copy the same file. If you have the diamond fallback texture
you need to copy the file in `assets/minecraft/models/item/diamond.json`.

The model file should be similar to this:
```json title="assets/minecraft/models/item/diamond.json"
{
"parent": "minecraft:item/generated",
"textures": {
"layer0": "minecraft:item/diamond"
}
}
```

If you have a block fallback texture like a grass block, the model file is in the block subdirectory,
for example `assets/minecraft/models/block/grass_block.json`.
16 changes: 16 additions & 0 deletions docs/versioned_docs/version-2.0.0-alpha.1/user/supported.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Supported
---

## Supported server

Tested on spigot, paper, airplane and paper. Supported versions are 1.14.4-1.17.1.

## Supported plugins

__Supported by the author itself__
* (Outdated) 📢 [OreAnnouncer](https://alessiodp.com/docs/oreannouncer/editblock#custom)
* (Outdated) 🚀 [Custom Ore Generator](https://DerFrZocker/Custom-Ore-Generator/wiki/ItemMods)

__Supported by me__
* 📌 [BetterGui](better-gui.md)
14 changes: 14 additions & 0 deletions docs/versioned_sidebars/version-2.0.0-alpha.1-sidebars.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"version-2.0.0-alpha.1/docs": [
{
"type": "autogenerated",
"dirName": "user"
}
],
"version-2.0.0-alpha.1/api": [
{
"type": "autogenerated",
"dirName": "api"
}
]
}
2 changes: 1 addition & 1 deletion docs/versions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[
"2.0.0-alpha.0"
"2.0.0-alpha.1"
]
Loading

0 comments on commit 4330c8b

Please sign in to comment.