Skip to content

Commit

Permalink
Start of manual changes.
Browse files Browse the repository at this point in the history
 - First three categories are reorganized
 - All manual entries that did not correspond codeside are renamed to match ingame names
 - Manual is prepped to recieve more changes
 - First three category entries with minimal changes are respaced
     - Respacing means separating into easily-read paragraphs
     - Also means making things fit onto pages better on my monitor
     - I do not know how it will behave on other monitors
 - Overall manual should hopefuly be more intelligible once this is done
  • Loading branch information
voidsong-dragonfly committed Mar 20, 2024
1 parent 602f88b commit 274a5e1
Show file tree
Hide file tree
Showing 98 changed files with 220 additions and 159 deletions.
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ version_jei=17.0.0.30
version_cctweaked=1.102.0-SNAPSHOT
version_buildnumber=169
modid=immersiveengineering
org.gradle.java.home=/usr/lib/jvm/java-17-openjdk-amd64/
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,15 @@
*/
public class ManualHelper
{
public static String CAT_GENERAL = "general";
public static String CAT_RESOURCES = "resources";
public static String CAT_WORKBENCHES_STORAGE = "workbenches_storage";
public static String CAT_CONSTRUCTION = "construction";
public static String CAT_ENERGY = "energy";
public static String CAT_MACHINES = "machines";
public static String CAT_ELECTRICAL_GRIDS = "electrical_grids";
public static String CAT_EXPLOSIVES_WEAPONRY = "explosives_weaponry";
public static String CAT_TOOLS = "tools";
public static String CAT_HEAVYMACHINES = "heavymachines";
public static String CAT_DEVICES = "devices";
public static String CAT_SIMPLE_MACHINERY = "simple_machinery";
public static String CAT_HEAVY_MACHINERY = "heavy_machinery";
public static String CAT_UPDATE = "update";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,17 +127,17 @@ public static void initManual()
public static void addIEManualEntries()
{
IEManualInstance ieMan = (IEManualInstance)ManualHelper.getManual();
InnerNode<ResourceLocation, ManualEntry> generalCat = ieMan.getRoot().getOrCreateSubnode(new ResourceLocation(MODID,
ManualHelper.CAT_GENERAL), 0);
InnerNode<ResourceLocation, ManualEntry> resourcesCat = ieMan.getRoot().getOrCreateSubnode(new ResourceLocation(MODID,
ManualHelper.CAT_RESOURCES), 0);
InnerNode<ResourceLocation, ManualEntry> toolsCat = ieMan.getRoot().getOrCreateSubnode(new ResourceLocation(MODID,
ManualHelper.CAT_TOOLS), 50);

{
ManualEntry.ManualEntryBuilder builder = new ManualEntry.ManualEntryBuilder(ManualHelper.getManual());
builder.readFromFile(new ResourceLocation(MODID, "minerals"));
builder.readFromFile(new ResourceLocation(MODID, "mineral_deposits"));
builder.appendText(IEManual::getMineralVeinTexts);
ieMan.addEntry(generalCat, builder.create(), ieMan.atOffsetFrom(generalCat, "graphite", -0.5));
ieMan.addEntry(resourcesCat, builder.create(), ieMan.atOffsetFrom(resourcesCat, "ores", 0.5));
}
// hide entry on blueprints
ieMan.hideEntry(new ResourceLocation(MODID, "blueprints"));
{
ManualEntry.ManualEntryBuilder builder = new ManualEntryBuilder(ieMan);
builder.setContent(
Expand All @@ -163,7 +163,7 @@ public static void addIEManualEntries()
}
builder.setLocation(new ResourceLocation(MODID, "shader_list"));
ManualEntry e = builder.create();
ieMan.addEntry(generalCat, e);
ieMan.addEntry(toolsCat, e);
ieMan.hideEntry(e.getLocation());
}

Expand Down
16 changes: 10 additions & 6 deletions src/main/resources/assets/immersiveengineering/lang/en_us.json
Original file line number Diff line number Diff line change
Expand Up @@ -728,14 +728,18 @@
"effect.immersiveengineering.flashed": "Flashed",
"manual.immersiveengineering.manual": "Engineer's Manual",
"manual.immersiveengineering.update": "UPDATE NEWS!",
"manual.immersiveengineering.general": "Overview and Resources",
"manual.immersiveengineering.early_machines": "Workbenches & Furnaces",
"manual.immersiveengineering.introduction": "Introduction",
"manual.immersiveengineering.other_engineers": "Other Engineers",
"manual.immersiveengineering.resources": "Resources",
"manual.immersiveengineering.workbenches_storage": "Workbenches & Storage",
"manual.immersiveengineering.construction": "Construction",
"manual.immersiveengineering.energy": "Power, wires, generators",
"manual.immersiveengineering.test": "A subcategory!?",
"manual.immersiveengineering.electrical_grids": "Electrical Grids",
"manual.immersiveengineering.explosives_weaponry": "Explosives & Weaponry",
"manual.immersiveengineering.tools": "Tools",
"manual.immersiveengineering.machines": "Simple Machines",
"manual.immersiveengineering.heavymachines": "Heavy Machinery",
"manual.immersiveengineering.devices": "Devices",
"manual.immersiveengineering.simple_machinery": "Simple Machinery",
"manual.immersiveengineering.heavy_machinery": "Heavy Machinery",
"manual.immersiveengineering.test": "A subcategory!?",
"desc.immersiveengineering.info.shader.details.rosequartz": "First shader ever made!<br>No direct reference, though the name itself was inspired by a character in the „Inkheart“ series of novels",
"desc.immersiveengineering.info.shader.details.argo": "No direct reference, but style+colour were inspired by the videogame 'Destiny'.",
"desc.immersiveengineering.info.shader.details.sunstrike": "No direct reference but name+colour were inspired by Sunbreaker Titans from the videogame 'Destiny'.",
Expand Down
124 changes: 58 additions & 66 deletions src/main/resources/assets/immersiveengineering/manual/autoload.json
Original file line number Diff line number Diff line change
@@ -1,118 +1,110 @@
{
"autoload_priority": 1,
"general": {
"resources": {
"category_weight": 0,
"entry_list": [
"introduction",
"ores",
"plates",
"alloys",
"hemp",
"treated_wood",
"chemicals",
"dyes",
"redstone_acid",
"components",
"villagers",
"graphite",
"plastic",
"shader"
"industrial_hemp",
"industrial_dyes",
"duroplast"
]
},
"early_machines": {
"workbenches_storage": {
"category_weight": 10,
"entry_list": [
"craftingtable",
"workbench",
"engineers_crafting_table",
"engineers_workbench",
"blueprints",
"cokeoven",
"alloykiln",
"crude_blast_furnace",
"improved_blast_furnace",
"slag"
"silo",
"tank"
]
},
"construction": {
"category_weight": 20,
"entry_list": [
"crate",
"barrel",
"balloon",
"metalconstruction",
"metal_barrel",
"concrete",
"lighting",
"multiblocks",
"silo",
"tank"
"balloon",
"engineered_lighting"
]
},
"energy": {
"electrical_grids": {
"category_weight": 30,
"entry_list": [
"wiring",
"grid_construction",
"accumulators",
"generator",
"breaker",
"current_transformer",
"redstone_wire",
"logic_circuits",
"thermoelectric",
"redstone_wiring",
"redstone_control",
"kinetic_dynamo",
"thermoelectric_generator",
"diesel_generator",
"lightning_rod"
]
},
"tools": {
"explosives_weaponry": {
"category_weight": 40,
"entry_list": [
"toolbox",
"heavy_plated_shield",
"revolver",
"revolver_cartridges",
"railgun",
"chemical_thrower",
"razor_wire",
"tesla_coil",
"turrets"
]
},
"tools": {
"category_weight": 50,
"entry_list": [
"engineers_toolbox",
"jerrycan",
"ear_defenders",
"glider",
"maintenance_kit",
"engineers_skyhook",
"mining_drill",
"buzzsaw",
"shield",
"powerpack",
"revolver",
"bullets",
"chemthrower",
"herbicide",
"railgun",
"skyhook"
"accumulator_backpack",
"collapsible_glider",
"shaders"
]
},
"machines": {
"category_weight": 50,
"devices": {
"category_weight": 60,
"entry_list": [
"conveyors",
"turntable",
"conveyor_belts",
"item_router",
"item_batcher",
"turntable",
"fluid_transport",
"fluid_pipes",
"fluid_router",
"external_heater",
"electromagnet",
"garden_cloche",
"charging_station",
"razor_wire",
"tesla_coil",
"turrets"
"charging_station"
]
},
"heavymachines": {
"category_weight": 60,
"simple_machinery": {
"category_weight": 70,
"entry_list": [
"coke_oven",
"alloy_kiln",
"crude_blast_furnace",
"improved_blast_furnace"
]
},
"heavy_machinery": {
"category_weight": 80,
"entry_list": [
"metal_press",
"crusher",
"sawmill",
"assembler",
"automated_workbench",
"squeezer",
"fermenter",
"mixer",
"refinery",
"bottling_machine",
"fermenter",
"squeezer",
"refinery",
"assembler",
"automated_engineers_workbench",
"arc_furnace",
"excavator"
]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
{
"start": {
"molds_components": {
"type": "crafting",
"recipes": [
"crafting/blueprint_components",
"crafting/blueprint_molds"
]
},
"banners_projectiles": {
"type": "crafting",
"recipes": [
"crafting/blueprint_bannerpatterns",
"crafting/blueprint_bullets"
]
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,6 @@
}
]
},
"acetaldehyde": {
"type": "item_display",
"items": [
{
"item": "immersiveengineering:acetaldehyde_bucket"
}
]
},
"duroplast_sheet": {
"type": "bottling",
"recipe": {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
Engineer's Blueprints
Back to the drawing board
This page features all Engineer's Blueprints that can be crafted by normal means. Other Blueprints may need to be acquired from villagers or found in the world. All of these can be used in an <link;workbench;Engineer's Workbench> to craft the items they describe.
<&introduction> The following pages feature all the Engineer's Blueprints that can be crafted by normal means. Other specialized Blueprints may need to be acquired from villagers or found in the world.

All of these blueprints, including specialized ones, can be used in an <link;workbench;Engineer's Workbench> to craft the items they describe.
<&molds_components>
<&banners_projectiles>
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@ Concrete
Fortress Material
<&recipe>Concrete is a very hard and resistant composite material. It's cheap to craft and makes for an excellent use for the excess <link;slag;slag> produced by making steel.
<&brick>Concrete can be cut and assembled into various bricks and pillars using the §2Stonecutter§r.

Concrete bricks have the same blast resistance as concrete, but can be disassembled faster than their solid counterpart, making them a good structural material.
<&partial>Concrete can be cut into slabs of varying thickness using a §2Stonecutter§r.

You can also use that machine to make slabs and stairs of concrete, as well as concrete tiles which are smoother and more polished.
<&leaded>Leaded concrete is a reinforced material, which is highly resistant to explosions. It may also afford protection against radiation, if that is something you worry about.
<&liquid>Liquid concrete can be produced in a <link;mixer;Mixer> by combining half a bucket of Water with §2Gravel§r, §2Clay§r and §2two pieces of Sand§r. When emptied onto the ground it will spread like water, before solidifying after some time.
<br>Multiple buckets can be used to fill a larger area by placing it at key locations. Note that if it spreads too thin, the liquid will dry into slabs instead of full blocks.
<br>Multiple buckets can be used to fill a larger area by placing it at key locations.
Note that if it spreads too thin, the liquid will dry into slabs instead of full blocks.

If the concrete dries while a creature is standing in it, they will be trapped and unable to move. You can also fill a <link;chemthrower;Chemical Thrower> with liquid concrete in order to create improvised platforms or immobilize enemies.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Resin and Duroplast
Duroplast
It's fantastic!
<&resin>Phenolic Resin is a sticky, viscous fluid, which can be molded into a resilient plastic known as Duroplast. This incredible new material is rigid, non-flammable and not conductive, making it an excellent insulator in electrical engineering.
Additionally, its ability to be molded makes it far more reliable in mass production than wood or ceramics.<np>
<&acetaldehyde>Its production process however is more involved and relies on complex chemical processes only possible within a <link;refinery;§o§nRefinery§r>.<br>
First, <link;fermenter;Ethanol;start> gained from fermenting plants must be oxidized to become Acetaldehyde. This process is done by using a §2Silver Plate§r as a catalyst and filling one of the refinery's tanks with Ethanol, while the other tank remains empty.
The resulting Acetaldehyde is then transferred to a §osecond§r refinery, where it is combined with <link;cokeoven;Creosote Oil> to create §2Phenolic Resin§r. This process requires no catalyst.<np>
<&resin>
Duroplast is a synthetic plastic created from TD: LINK RESIN. This incredible new material is rigid, non-flammable and not conductive, making it an excellent insulator in electrical engineering.

The easy moldability of plastic resins also allows it to be created into a variety of shapes, such as sheets and blocks.
<&duroplast_sheet>Duroplast items are created by filling appropriate <link;metal_press;molds;mold_recipes> with resin in the <link;bottling_machine;§o§nBottling §o§nMachine§r>. The machine is able to confer enough heat and pressure within these molds to trigger the resin to harden.<br>
The resulting sheets are used in the creation of <link;components;Advanced Electronic Components;elec_components> and <link;components;Circuit Backplanes;pcb>, where they act as insulators.<np>
<&duroplast_block>Solid blocks of duroplast can be used for construction and decorational purposes, though not everyone appreciates their colour. More importantly however, they serve to replace §2Terracotta§r when crafting <link;wiring;wire connectors and relays;connector_recipes>, thus reducing the amount of clay required!<np>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
Engineered Lighting
Lighting up the Wasteland
<&lantern>Deep in the halls of the factories, it can be quite dark. In order to still find your way around the machines, you should probably light up the place with some Lanterns. These Lanterns provide almost as much light as a glowstone block would.
<&electric_lantern>Powered Lanterns are one of the first ever invented uses for electric power. To run these, you need to connect them directly to your power grid using wires. They will allow power to be transferred through them, so you can link them in a row.
Using the Engineer's Hammer on them will flip them upside down. As long as they are supplied with a little bit of power, they will light up the surrounding area like a normal Lantern, but additionally, they will also prevent hostile mobs to spawn in a 32 block radius!<np>
<&floodlight>Floodlights are strong lightsources. While they require more power than a simple Powered Lantern, they will create a cone of light up to 32 blocks long. Use an Engineer's Hammer on the top or bottom faces of the block to rotate the light or click its sides to change its pitch.
Generally, Floodlights require a redstone signal to run, however their control-behavior can be inverted by right-clicking them base with an Engineer's Screwdriver.
<&electric_lantern>Powered Lanterns are one of the first ever invented uses for electric power.

To run these, you need to connect them directly to your power grid using wires. They will allow power to be transferred through them, so you can link them in a row.
Using the Engineer's Hammer on them will flip them upside down.

As long as they are supplied with a little bit of power, they will light up the surrounding area like a normal Lantern, but additionally, they will also prevent hostile mobs to spawn in a 32 block radius!<np>
<&floodlight>Floodlights are strong lightsources. While they require more power than a simple Powered Lantern, they will create a cone of light up to 32 blocks long.

Use an Engineer's Hammer on the top or bottom faces of the block to rotate the light or click its sides to change its pitch.

Generally, Floodlights require a redstone signal to run, however their control-behavior can be inverted by right-clicking them base with an Engineer's Screwdriver.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Engineer's Crafting Table
For various projects
The Engineer's Crafting Table is a simple upgrade to the normal Crafting Table. In addition to the treated wood top, it keeps ingredients inside the crafting grid when it is closed.
The table also features a small drawer to store some of your crafting components.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Engineer's Workbench
Always cluttered
The Engineer's Workbench is a professional worktable for the educated engineer. It is widely used to create items described by <link;blueprints;Engineer's Blueprints>.

A wide variety of blueprints can be crafted, as detailed <link;blueprints;here>, whereas a few select ones can only be discovered in the world or bought from villagers.<np>
To use a blueprint in the Workbench, put it in the slot on the left of the GUI and the necessary ingredients in the six slots in the middle.

The resulting items can then be retrieved from the right side. Hovering your mouse over these output slots will inform you exactly which materials are needed for each item.<np>
A secondary function of the Workbench is the modification and configuration of more complex tools and gadgets. The <link;mining_drill;Mining Drill>, <link;shield;Heavy Plated Shield> or <link;revolver;Revolver> are examples of such items.

When placed in the main slot of the workbench, it's use becomes that of modifying these tools by inserting applicable upgrades into the new slots that appear.

This file was deleted.

Loading

0 comments on commit 274a5e1

Please sign in to comment.