diff --git a/docs/blog/2021-09-15-2.0.0-alpha.1-released.md b/docs/blog/2021-09-15-2.0.0-alpha.1-released.md new file mode 100644 index 000000000..a9c7d7ab3 --- /dev/null +++ b/docs/blog/2021-09-15-2.0.0-alpha.1-released.md @@ -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. diff --git a/docs/docs/api/intro.md b/docs/docs/api/intro.md index eb2f2b7d7..0a696841b 100644 --- a/docs/docs/api/intro.md +++ b/docs/docs/api/intro.md @@ -18,7 +18,7 @@ The latest build can you find [here](https://ci.codemc.io/job/CodeDoctorDE/job/I dev.linwood ItemMods - 2.0.0-alpha.0 + 2.0.0-alpha.1 diff --git a/docs/docs/user/intro.md b/docs/docs/user/intro.md index d41121de8..5c4d7ac61 100644 --- a/docs/docs/user/intro.md +++ b/docs/docs/user/intro.md @@ -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. diff --git a/docs/src/pages/changelog.md b/docs/src/pages/changelog.md index e29e626da..a501140b0 100644 --- a/docs/src/pages/changelog.md +++ b/docs/src/pages/changelog.md @@ -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! diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/api/_category_.json b/docs/versioned_docs/version-2.0.0-alpha.1/api/_category_.json new file mode 100644 index 000000000..1e71efc75 --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/api/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Developer", + "position": 2 +} \ No newline at end of file diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/api/create-addons.md b/docs/versioned_docs/version-2.0.0-alpha.1/api/create-addons.md new file mode 100644 index 000000000..872ff589e --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/api/create-addons.md @@ -0,0 +1,8 @@ +--- +title: Create an addon +--- + +* First, use this template: . 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 . I will help you if you have problems or you want to link it on the main page of ItemMods. \ No newline at end of file diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/api/custom-model-data.md b/docs/versioned_docs/version-2.0.0-alpha.1/api/custom-model-data.md new file mode 100644 index 000000000..f1b6187b7 --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/api/custom-model-data.md @@ -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. \ No newline at end of file diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/api/intro.md b/docs/versioned_docs/version-2.0.0-alpha.1/api/intro.md new file mode 100644 index 000000000..eb2f2b7d7 --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/api/intro.md @@ -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 + + + + codemc-repo + https://repo.codemc.org/repository/maven-public/ + + + + + dev.linwood + ItemMods + 2.0.0-alpha.0 + + + + ``` +* 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 diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/_category_.json b/docs/versioned_docs/version-2.0.0-alpha.1/user/_category_.json new file mode 100644 index 000000000..f328301b7 --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "User", + "position": 1 +} \ No newline at end of file diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/addons.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/addons.md new file mode 100644 index 000000000..dd796ba9f --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/addons.md @@ -0,0 +1,5 @@ +--- +title: Addons +--- + +There are currently no addons. \ No newline at end of file diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/better-gui.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/better-gui.md new file mode 100644 index 000000000..542701c40 --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/better-gui.md @@ -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. \ No newline at end of file diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-blocks.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-blocks.md new file mode 100644 index 000000000..3510b6c0a --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-blocks.md @@ -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 diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-items.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-items.md new file mode 100644 index 000000000..ff3576c2d --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-items.md @@ -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 diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-models.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-models.md new file mode 100644 index 000000000..23c4d4486 --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-models.md @@ -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 *\* with your values and assign it to a model + +### Block model + +The default block model: +```json title="block.json" +{ + "textures": { + "0": "", + "particle": "" + }, + "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": "" + } +} +``` diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-textures.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-textures.md new file mode 100644 index 000000000..5b1d7798c --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/custom-textures.md @@ -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` diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/intro.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/intro.md new file mode 100644 index 000000000..5c4d7ac61 --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/intro.md @@ -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) diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/pack.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/pack.md new file mode 100644 index 000000000..11d8f71fa --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/pack.md @@ -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. diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/preset.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/preset.md new file mode 100644 index 000000000..f7acefb9c --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/preset.md @@ -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`. diff --git a/docs/versioned_docs/version-2.0.0-alpha.1/user/supported.md b/docs/versioned_docs/version-2.0.0-alpha.1/user/supported.md new file mode 100644 index 000000000..b1bab1f62 --- /dev/null +++ b/docs/versioned_docs/version-2.0.0-alpha.1/user/supported.md @@ -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) diff --git a/docs/versioned_sidebars/version-2.0.0-alpha.1-sidebars.json b/docs/versioned_sidebars/version-2.0.0-alpha.1-sidebars.json new file mode 100644 index 000000000..46127edd1 --- /dev/null +++ b/docs/versioned_sidebars/version-2.0.0-alpha.1-sidebars.json @@ -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" + } + ] +} diff --git a/docs/versions.json b/docs/versions.json index 0c3884d01..8658206ae 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,3 +1,3 @@ [ - "2.0.0-alpha.0" + "2.0.0-alpha.1" ] diff --git a/docs/yarn.lock b/docs/yarn.lock index 726eadfd2..04238e39f 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -2088,9 +2088,9 @@ ansi-regex@^4.1.0: integrity sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg== ansi-regex@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.0.tgz#388539f55179bf39339c81af30a654d69f87cb75" - integrity sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg== + version "5.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== ansi-styles@^3.2.0, ansi-styles@^3.2.1: version "3.2.1" @@ -3494,9 +3494,9 @@ ee-first@1.1.1: integrity sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0= electron-to-chromium@^1.3.564, electron-to-chromium@^1.3.830: - version "1.3.838" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.838.tgz#d178b34a268c750c0444ba69e4c94d4c4fb3aa0d" - integrity sha512-65O6UJiyohFAdX/nc6KJ0xG/4zOn7XCO03kQNNbCeMRGxlWTLzc6Uyi0tFNQuuGWqySZJi8CD2KXPXySVYmzMA== + version "1.3.839" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.839.tgz#27a5b21468e9fefb0e328a029403617f20acec9c" + integrity sha512-0O7uPs9LJNjQ/U5mW78qW8gXv9H6Ba3DHZ5/yt8aBsvomOWDkV3MddT7enUYvLQEUVOURjWmgJJWVZ3K98tIwQ== emoji-regex@^7.0.1: version "7.0.3" diff --git a/pom.xml b/pom.xml index a592df39b..466ef4e5f 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ dev.linwood ItemMods - 2.0.0-alpha.1-SNAPSHOT + 2.0.0-alpha.1 UTF-8 11 @@ -120,47 +120,47 @@ ui-templates dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 serializer dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 ui dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 config dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 server dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 translations dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 request dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 item dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 utils dev.linwood - 3.1.0-SNAPSHOT + 3.1.0 com.google.code.gson diff --git a/src/main/java/dev/linwood/itemmods/gui/pack/raw/DataGui.java b/src/main/java/dev/linwood/itemmods/gui/pack/raw/DataGui.java index 2d544ae8b..3e9c74b04 100644 --- a/src/main/java/dev/linwood/itemmods/gui/pack/raw/DataGui.java +++ b/src/main/java/dev/linwood/itemmods/gui/pack/raw/DataGui.java @@ -25,7 +25,7 @@ public class DataGui extends ListGui { private final @NotNull RawAsset asset; public DataGui(@NotNull String namespace, @NotNull RawAsset asset, @NotNull Runnable action, @NotNull Consumer showAction) { - super(ItemMods.getTranslationConfig().subTranslation("raw.data"), 4); + super(ItemMods.getTranslationConfig().subTranslation("raw.data").merge(ItemMods.getTranslationConfig().subTranslation("gui")), 4); setPlaceholders(new PackObject(namespace, asset.getName()).toString()); setItemBuilder((gui) -> new ArrayList<>(asset.getVariations()) {{ remove("default"); diff --git a/src/main/java/dev/linwood/itemmods/gui/pack/raw/model/ModelGui.java b/src/main/java/dev/linwood/itemmods/gui/pack/raw/model/ModelGui.java index 1c6cf60f0..7b47812fb 100644 --- a/src/main/java/dev/linwood/itemmods/gui/pack/raw/model/ModelGui.java +++ b/src/main/java/dev/linwood/itemmods/gui/pack/raw/model/ModelGui.java @@ -68,7 +68,7 @@ public ModelGui(@NotNull PackObject packObject) { case APPEARANCE: gui.addItem(new TranslatedGuiItem(new ItemStackBuilder(asset.getFallbackTexture()).displayName("fallback.title").lore("fallback.description").build()) {{ setRenderAction(gui -> setPlaceholders(asset.getFallbackTexture().getKey().toString())); - setClickAction(event -> new MaterialListGui(ItemMods.getTranslationConfig().subTranslation("materials"), material -> { + setClickAction(event -> new MaterialListGui(ItemMods.getTranslationConfig().subTranslation("materials").merge(ItemMods.getTranslationConfig().subTranslation("gui")), material -> { asset.setFallbackTexture(material); packObject.save(); show((Player) event.getWhoClicked());