Skip to content

Commit

Permalink
Update Contributing guide and translation keys
Browse files Browse the repository at this point in the history
  • Loading branch information
nageih committed Nov 1, 2024
1 parent c5c231e commit c3973b0
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 9 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@ Does not include mods, or most configs, only pack specific files which are used

## Contributing

For developers: If you just want to edit the text, do it in this [file](resources\createastral\lang\en_us.json) (Ponders are in this [file](kubejs\assets\ponderjs_generated\lang\en_us.json)), editing the text in other files will NOT work! If you want to add items, blocks, fluids, tooltips and everything else that contains text, please use the translation key and the [lang file](resources\createastral\lang\en_us.json).

Here's an [example](https://github.com/Laskyyy/Create-Astral/pull/389) of changing the added tooltip and some other text to a translation key. For adding a new item/block/fluid, the naming of the key in the language file needs to follow these rules.

To name keys in the [lang file](resources\createastral\lang\en_us.json) correctly, you need use the **prefix** (`item/block/fluid`) + the **namespace** of mod (such as `kubejs`,`create_astral`) + the **id** of item/block/fluid. For vaules, it's the **displayed name** instead of translation keys. There is a example.

```json
{
"item.createastral.crushed_raw_desh": "Crushed Raw Desh",
"block.kubejs.fragile_sheet_block": "Fragile Sheet Block",
"fluid.kubejs.molten_calorite": "Calorite",
}
```

For other texts in javascript, you should use [Text Components](https://wiki.latvian.dev/books/kubejs-legacy/page/components-kubejs-and-you). There is a [example](kubejs/startup_scripts/item_tooltip.js#L402C2-L407C7).

---

This repository uses [packwiz](https://github.com/packwiz/packwiz), which allows a lightweight repository such as this to be built into a full modpack by downloading mods from Modrinth or CurseForge.

The following instructions are a simplified version of the [packwiz installer tutorial](https://packwiz.infra.link/tutorials/installing/packwiz-installer/), so if you run into any issues, you should check there.
Expand Down
24 changes: 17 additions & 7 deletions kubejs/assets/ponderjs_generated/lang/en_us.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,24 @@
"kubejs.ponder.melter.text_4": "Finally, faucets are placed on the sides, which can be used to pour the liquid into a casting basin or table",
"kubejs.ponder.melter.text_5": "Create fluid pipes can be used to transfer the liquid to something like a Spout",
"kubejs.ponder.set_replace_modify_tutorial.header": "Ultrapure Carbon",
"kubejs.ponder.set_replace_modify_tutorial.text_1": "Polished Andesite",
"kubejs.ponder.set_replace_modify_tutorial.text_2": "Lava in the middle",
"kubejs.ponder.set_replace_modify_tutorial.text_3": "This is the Stone Growth Chamber",
"kubejs.ponder.set_replace_modify_tutorial.text_4": "Use an Andesite Funnel on the front or a Hopper on the bottom to output Andesite",
"kubejs.ponder.set_replace_modify_tutorial.text_5": "When built using different Polished Stone, the Stone Growth Chamber will generate different types of cobblestone",
"kubejs.ponder.set_replace_modify_tutorial.text_6": "This currently works with Andesite, and any default stone from each planet, like Moon Stone and Mars Stone.",
"kubejs.ponder.set_replace_modify_tutorial.text_1": "This is the Desizer",
"kubejs.ponder.set_replace_modify_tutorial.text_2": "The casings don\u0027t have to be accurate. This also works",
"kubejs.ponder.set_replace_modify_tutorial.text_3": "The Desizer will shrink a 3x3x3 cube of blocks down into a single item",
"kubejs.ponder.set_replace_modify_tutorial.text_4": "It\u0027s powered by Redstone. Place a button on the back of the Desizer Controller",
"kubejs.ponder.set_replace_modify_tutorial.text_5": "If it doesn\u0027t detect a valid recipe, it will just break the blocks",
"kubejs.ponder.shimmer_refinery.header": "How to create a Shimmer Refinery",
"kubejs.ponder.shimmering_stone.header": "How to create the Moon Portal",
"kubejs.ponder.shimmering_stone.text_1": "In this pack, the nether is disabled. Instead, items are spread throughout the different planets.",
"kubejs.ponder.shimmering_stone.text_2": "There is a new portal added, which takes you to the moon!"
"kubejs.ponder.shimmering_stone.text_2": "There is a new portal added, which takes you to the moon!",
"kubejs.ponder.stone_growth_chamber.header": "Stone Growth Chamber",
"kubejs.ponder.stone_growth_chamber.text_1": "Stone Growth Chamber",
"kubejs.ponder.stone_growth_chamber.text_10": "Similarly, valid glass blocks can be found by searching \u0027$createastral:stone_growth_chamber/glass_blocks\u0027",
"kubejs.ponder.stone_growth_chamber.text_2": "Polished Andesite",
"kubejs.ponder.stone_growth_chamber.text_3": "Glass",
"kubejs.ponder.stone_growth_chamber.text_4": "Lava in the middle",
"kubejs.ponder.stone_growth_chamber.text_5": "This is a completed Stone Growth Chamber",
"kubejs.ponder.stone_growth_chamber.text_6": "Use an Andesite Funnel on the front or a Hopper on the bottom to output Andesite",
"kubejs.ponder.stone_growth_chamber.text_7": "When built using different Stones, the Stone Growth Chamber will generate different types of cobblestone",
"kubejs.ponder.stone_growth_chamber.text_8": "This currently works with Stone, Andesite and any default stone from each planet, like Moon Stone and Mars Stone",
"kubejs.ponder.stone_growth_chamber.text_9": "A list of valid stone blocks can be found by searching \u0027$createastral:stone_growth_chamber/building_blocks\u0027 in REI"
}
2 changes: 1 addition & 1 deletion kubejs/startup_scripts/item_tooltip.js
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ onEvent("item.tooltip", (e) => {
},
{
item: "astralfoods:dipped_potato",
tooltip: "Beloved food of the piglins! Suggested by TheRobbie72",
tooltip: "tooltip.astralfoods.dipped_potato",
},
{
item: "createbigcannons:steel_screw_breech",
Expand Down
5 changes: 4 additions & 1 deletion resources/createastral/lang/en_us.json
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@

"tooltip.astralfoods.shimmered_rabbit_stew": "Suggested by NikWas!",
"tooltip.astralfoods.astral_sauce": "The bowl comes from the recipe :blehh:",
"tooltip.astralfoods.dipped_potato": "Beloved food of the piglins! Suggested by TheRobbie72",

"tooltip.createbigcannons.steel_screw_breech": "Wrenchable",
"tooltip.createbigcannons.incomplete_steel_screw_breech": "Wrenchable",
Expand Down Expand Up @@ -341,7 +342,8 @@
"item.astralfoods.shimmered_apple": "Shimmered Apple",
"item.astralfoods.compressed_onion": "Compressed Onion",
"item.astralfoods.food_amalgamation": "Food Amalgamation",
"item.astralfoods:bulbas_tea":"Bulba's Tea",
"item.astralfoods.bulbas_tea": "Bulba's Tea",
"item.astralfoods.astralfoods.dipped_potato": "Dipped Potato",

"block.kubejs.fragile_sheet_block": "Fragile Sheet Block",
"block.kubejs.broken_fragile_sheet_block": "Broken Fragile Sheet Block",
Expand Down Expand Up @@ -389,6 +391,7 @@
"block.createastral.synthetic_slime_block": "Synthetic Slime Block",
"block.createastral.swift_andesite": "Swift Andesite",
"block.createastral.rocket_casing": "Rocket Casing",
"block.createastral.moonset_stone": "Moonset Stone",

"block.doodads.asphalt_slab": "Asphalt Slab",
"block.doodads.asphalt_stair": "Asphalt Stair",
Expand Down

0 comments on commit c3973b0

Please sign in to comment.