Jump to content

Official documentation


hanschrome

Recommended Posts

Hello!

 

I was looking for the official documentation about forge, and I just find tutorials and old documentation(and short) about olders forge versions.

 

Well, I just find tutorials, but I'm not use to work with them because are longs, so explained(explaining how to develop java or how to use an IDE) and the most of the cases they haven't the enough Forge information. I want an official not explained documentation, like all software have on its website.

 

For work, I'm force to read the Forge code or see JavaDoc, but it hasn't how to consume the API, just explains code, and I will prefer read it.

 

So, how I couldn't find anything, I have installed a simply wiki and I will fill it down starting with 1.8.9 version. I wanted to know If I could copy on the official Wiki the page with "Forge 1.8.9 Documentation". This way the proffessional developer who are used to this kind of documentation can work more confortable.

 

The structure should be like it

  • Blocks
  • Items
    • Potions
    • Tools
    • ...

     

    [*]Mobs

    [*]...

 

And it must have just the necessary documentation, or at least on summary.

For example, for an Item:

 

// Create the Item
Item test_item = new ItemSword(Item.ToolMaterial.WOOD);
test_item.setUnlocalizedName("test_item");

//Register it on Game
GameRegistry.registerItem(test_item, "test_item");

//Register its resource on client
ModelResourceLocation mr = new ModelResourceLocation("examplemod:test_item", "inventory")
Minecraft.getMinecraft().getRenderItem().getItemModelMesher().register(test_item, 0, mr);

And It's an example, really It should has just "Item name", "Item.ToolMaterial Object" etc. And then yes, can be an example.

 

I have seen that for create a simply Item the people show them "superknowledge" about Java creating non-necessary proxy, classes, singletons and anothers programming models that every developer knows and doesn't need learn it.

 

So, finally just I can offer the people my job when It will be finished and accept every help for anyone.

 

Regards,

Hans

----------------------------------------------------

 

Professional backend developer.

Job experience on PHP Backend & Java EE.

Link to comment
Share on other sites

Thanks!

 

I read the documentation and I think It has to improve. Its information is useful, but it doesn't explain everything about Forge. Forge has a lot of features that aren't on its doc.

 

That documentation is like a "getting started". Just reading it one time, you will learn it at the moment. And documentation should has to have information about the whole system and features, which you read even if you're an experienced modder.

 

----------------------------------------------------

 

Professional backend developer.

Job experience on PHP Backend & Java EE.

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Announcements



×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.