GregTechCEu Modern

GregTechCEu Modern

6M Downloads

Update documentation

jurrejelle opened this issue ยท 3 comments

commented

Cross-mod Integration

No response

Minecraft Version

1.20.1 Forge

Feature Description

List of documentation to update (provided by Phoenixvine (PFT Dev))

Machine related docs

machine registry needs moved to the new model system as it's still for 1.6.4<

steam singleblock machine registry needs updated as it's incorrect

remove kinetic machine as these don't exist anymore

generator(true) for multiblocks

Materiel related docs

a basic explanation of these

.washedIn()

.separatedIn()

.separatedInto()

.oreSmeltInto()

.polarizesInto()

.arcSmeltInto()

.maceratesInto()

.ingotSmeltInto()

.addOreByproducts()

while most people understand you need to pass objects into this some might not know

.toolProperties()

ToolProperty(float harvestSpeed, float attackDamage, int durability, int harvestLevel, GTToolType[] types)

.fluidPipeProperties()

 FluidPipeProperties(int maxFluidTemperature, int throughput, boolean gasProof, boolean acidProof,boolean cryoProof, boolean plasmaProof, int channels)

.itemPipeProperties()

(can't find the syntax for this nor have i seen people use this, but still)

example scripts/the arguments needed for these would be nice as not everyone knows how to look at the github's code to see how to use it for kjs

.rotorStats(speed, damage, durability)

example script of this would be nice and it's missing the efficiency arugment

as it is RotorProperty(int power, int efficiency, float damage, int durability)

an example script of some of the more complicated materiel modifcations like adding rotors/tools would be nice

Misc docs

an example of how to do models for coil blocks would be wonderful, other stuff that needs models could show back to this as well

example of custom drum/crate as well as saying they need a model would be nice

I'm not sure if there is anything new involving veins but I have seen some talk of changes so if there are any would be nice to have them documented

(if standard/geode are implemented at all, these would be good to know too)

more info about the ui editor would be nice but it would probably end up being a big part of the work.

and finnaly, the changes tab being updated to 7.x would be nice

commented

It would also be cool to show a basic example of a multi being loaded into a java class, like steam multiblocks and coil blocks. I forgot to say this earlier.

commented

To be fair, you can find that relatively easily? Whereas for KubeJS we need more docs bcs there's no base-mod kubejs stuff
https://github.com/GregTechCEu/GregTech-Modern/blob/1.20.1/src/main/java/com/gregtechceu/gtceu/common/data/machines/GTMultiMachines.java

commented

Yes but not for how it's used for kjs multiblocks. The syntax is different enough to confuse some people (like ebfOverclock being a very different thing than what a lot of kjs devs are used to. The syntax is a tad different) but I do understand what you mean.