Jump to content

Recommended Posts

Posted

Started modding Minecraft a few weeks ago, doing good but simple, but i can't seem to find any api documentation of the classes, hooks, endpoints, enums, etc. Lots of tutorial lingering the world but no documentation it seems.

 

I'm kinda tired reading tutorials that say copy and paste this, do that and it'll work... I want to understand what i am doing and not listen to 13 videos to know how to do a custom furnace with a person that doesn't even seem to know what he's doing!

 

So where is that documentation?

Posted

So... Your asking for minecrafts documentation? Have fun with that. I wish you luck. Forges documentation on the other hand... Have you looked into Javadocs? Specifically the forge ones?

 

If you want to understand the what you are doing, start reading. Go up through the classes reading what method calls and this and what does this do etc.. It takes a lot of work and effort, but its worth it.

We all stuff up sometimes... But I seem to be at the bottom of that pot.

Posted

Hi

 

There isn't much around to be honest.  Some of the Forge documentation is really good, some of it... isn't.

 

I have put together some things myself about how vanilla works, enough to help folks get a grasp of the basic concepts and how the various bits hang together, but isn't not comprehensive by any stretch (and it's currently based on 1.6.4, which is a bit different to 1.7.2 sometimes).

 

http://greyminecraftcoder.blogspot.com.au/p/list-of-topics.html

 

Most of the time, I find a useful strategy is

1) think of a vanilla object that does similar to what I want

2) look at the code, flip back and forth until I figure out how it works (can sometime take a while!) and then test it myself.

 

-TGG

 

Posted

I'll need to check out your docs, but right off the start, it looks good. At least, that's some documentation.

 

Looking at the javadoc comments and interpretting obfuscated source code... that has to be even less efficient than watching 15h of video tutorial about someone trying to do something and not knowing how to explain and do it :P

Posted
  Quote
Looking at the javadoc comments and interpretting obfuscated source code... that has to be even less efficient than watching 15h of video tutorial about someone trying to do something and not knowing how to explain and do it :P

 

@crazycodr, I think you have to understand what Minecraft modding is.  Minecraft was not really meant to be modded -- so Mojang does not document and in fact obfuscates their code.  So any modding has to essentially be reverse engineered by the community of interested modders.  The people that are reverse engineering it are (as far as I know) essentially a volunteer group that is painstakingly tracing the undocumented result of decompilation and creating mapping to human-readable method and field names and adding comments to the code.  Then there is FML and Forge, which again are volunteer group adding hooks to the code to make it easier to intercept and interact with the vanilla code.

 

The key here is that this is volunteer community.  So the work is incomplete and inconsistent, and even buggy at times.  There are some functions that are well understood and named well and documented well, and there are others that are still called something like f_423435_a() with no documentation at all.  I've found bugs where things are mis-named, sometimes dangerously (i.e. the logic is backwards).

 

Lastly, every time Mojang does a major update the entire process has to be done over again.  That is why there are only a couple supported versions of Forge (common are 1.6.4 and 1.7.2) and frankly 1.7.2 is still a work in progress (although it is pretty useable now).

 

Basically I'm saying you're asking for too much.  There is no commercial company providing this, there are several different contributors that are loosely working together, and it is still a work in progress.

 

So the best way to learn it is simply to follow the decompiled source provided and put that together with your knowledge of Minecraft (like if you see code that treats an anvil differently, you should know that is because an anvil is different in behavior in Minecraft) and get hints from tutorials.

Check out my tutorials here: http://jabelarminecraft.blogspot.com/

Posted

Give that man a jar of cookies for that answer.

 

Thank you for explaining that Jabelar, but i still think, for the good of the whole minecraft modding community, there should be a documentation effort put in place. It would help all modders get the best of Forge and Minecraft... Yes, the work has to be done again on each new supported version but hey, the code can move, but it's not a whole new version each time, some principles stay, some change. So creating a multi-version documentation shouldn't be too hard.

 

If you think at how much time is put all around the web at people creating countless video tutorials, text tutorials and then all the work put into the forums to help each other, i'm sure it possible to convert a bit of that into a documentation base that can be reused over time.

 

I actually like documenting a lot, and if there is support from the community, i wouldn't mind putting my efforts into documenting Forge, FML and Minecraft along with directing a small team of dedicated people that want to make this possible.

 

What would be the best way to launch this initiative in your opinion?

Posted

I like documentation too.  That is why I've been trying to write a number of text tutorials that actually explain (rather than just give example).

 

Since it is a really big project and I assume you'd want to allow multiple contributors, I think wiki format would be suitable.  But I think the problem is still the format of the information.  Do you want this to just be a simple API documentation where every public method is explained? 

 

The question then is what the level of explanation is.  For example, listing methods and parameter types isn't much more useful than the code itself in my opinion.  That is why I've been concentrating on tutorials -- they may be haphazard in terms of topics covered, but when they cover a topic a tutorial give a lot of explanation that is difficult to document except in the context of trying to implement something specific.

 

Anyway, can you give an example of what kind of documentation you're really interested in providing/collecting?

Check out my tutorials here: http://jabelarminecraft.blogspot.com/

Posted

I think that documentation must always focus on 3 aspects:

 

- Concepts : They explain the general item of something or a group of things. For example, a really important aspect to conceptualize in minecraft is the concept of Items and Blocks. It's the first thing a modder will want to do and the first thing that every modder should know how to handle.

 

- Tutorials : They explain how to achieve something. Direct links from the concept pages would link to those tutorials. So, how to do your custom "furnace" or "crusher" or "mechanical block", how to create blocks with adaptive structure (block lookups), etc.

 

- Reference : Listing of the different classes and parameters using a javadoc analyser to extract that information. Someone that doesn't know where to look in the code is bound to look for a long time. A well defined wiki with a search engine is always faster to find what you are looking for. User comments, examples, links to corresponding tutorials maybe, etc.

 

The documentation would use a Wiki approach for sure, we need to make version branches so we can keep the whole documentation for each version change. I think documentation should not be open to all, but thats me, i think it's a collective decision of all the initial writters that has to be taken into account.

 

What do you think?

Posted

I found something interresting this morning that can simplify our work greatly and promote easier collaboration on the documentation aspect of Forge and Minecraft.

 

First of all, I love Markdown as a documentation language. Is it very similar to most wiki language but just better and it's pretty much a standard now in community based projects due to GitHub's adoption of it. GitHub flavored markdown is even better at this and there are libraries to parse github flavored markdown and render it to HTML.

 

How i see the reference being built is by generating a markdown documentation using a javadoc scanner and you push the changes to a GitHub profile. The rest of the documentation can simply be another folder in the doc, one for tutorials and one for concepts. So you'd have folders like :

 

  • 1.6.4
    • Concepts
    • Tutorials
    • Reference

     

    [*]1.7.2

    • Concepts
    • Tutorials
    • Reference

 

People can fork the documentation and issue pull requests to update the documentation... Makes it simpler to review changes and promotes community work. And then, we could have a server that check's out the documentation from GitHub and use "http://parsedown.org/" to render it to HTML and get it styled easily.

 

What do you think?

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



  • Recently Browsing

    • No registered users viewing this page.
  • Posts

    • I never thought I’d fall for it but I did. It all started with what seemed like a promising crypto investment opportunity I found through a popular social media platform. The project looked legitimate, with a sleek website, professional looking team profiles, and glowing testimonials. After doing what I thought was enough due diligence, I invested. First $5,000. Then $10,000. Over the next few months, I put in a total of $153,000. The returns were amazing on paper. My account showed massive gains, and I was told I could “withdraw soon.” But when I tried to cash out, I was hit with endless delays, excuses, and requests for additional “verification fees.” That’s when the panic set in: I realized I’d been scammed. I felt sick. Devastated. Embarrassed. After days of searching online, I came across Malice Cyber Recovery, a firm that specialized in tracing and recovering lost digital assets. I was skeptical at first I’d already lost so much, and I wasn’t ready to be taken advantage of again. But their team was incredibly professional and transparent from the start. They explained the recovery process in detail and didn’t make any unrealistic promises. They began with a full investigation, tracing the blockchain transactions and identifying the wallet addresses involved. Within a week, they had compiled enough evidence to begin their recovery strategy. It wasn’t easy and it wasn’t overnight but within a matter of weeks, I received the news I never thought I’d hear They had recovered my $153,000. I cried. Not just because I got my money back but because someone actually cared enough to help me. If you’ve fallen victim to a crypto scam, don’t suffer in silence. Malice Cyber Recovery gave me my life back and they just might be able to do the same for you  
    • Maximizing savings on  Temu  has never been easier! With the exclusive 70% Off Coupon Code [acu729640], you can enjoy unparalleled discounts on a vast array of trending products. This offer, coupled with fast delivery and free shipping across 67 countries, ensures that shoppers receive high-quality items at remarkably reduced prices. Exclusive  Temu  Coupon Codes for Maximum Savings Enhance your shopping experience by applying these verified Coupon Codes: acu729640 – Enjoy a 70% discount on your order. acu729640 – Receive an extra 30% off on select items. acu729640 – Benefit from free shipping on all purchases. acu729640 – Save $10 on orders exceeding $50. acu729640 – Unlock special discounts on newly launched products. What is the  Temu  70% Off Coupon Code [acu729640]? The 70% Off Coupon Code [acu729640] is a premier promotional tool that significantly reduces the cost of various products across  Temu 's extensive marketplace. Whether you are a first-time buyer or a returning customer, applying this Code at checkout guarantees exceptional discounts on categories such as apparel, electronics, home essentials, and more. How Does the 70% Off Coupon Code [acu729640] Work on  Temu ? Leveraging the 70% Off Coupon Code [acu729640] is effortless: Browse  Temu ’s diverse product range. Select and add desired items to your shopping cart. Enter [acu729640] at checkout. Instantly receive a 70% discount. Complete your transaction and enjoy expedited, reliable shipping. Is the  Temu  70% Off Coupon Code [acu729640] Legitimate? Absolutely! The  Temu  70% Off Coupon Code [acu729640] is an authentic and verified discount, actively used by thousands of savvy shoppers. Unlike misleading online offers, this Coupon is officially endorsed by  Temu , ensuring its seamless functionality across multiple product categories. Latest  Temu  Coupon Code 70% Off [acu729640] + Additional 30% Discount  Temu  continually updates its promotional lineup. In addition to the 70% Off Coupon Code [acu729640], customers can utilize to obtain an extra 30% discount on selected items. These stacked savings empower users to optimize their purchases and maximize financial benefits.  Temu  Coupon Code 70% Off United States [acu729640] For 2025 For customers residing in the United States, the  Temu  Coupon Code 70% Off [acu729640] remains a top-tier deal in 2025. Coupled with nationwide free shipping, this offer presents an unparalleled opportunity to secure premium products at a fraction of their original cost.  Temu  70% Off Coupon Code [acu729640] + Free Shipping In addition to receiving 70% off, users also enjoy complimentary shipping when applying the  Temu  70% Off Coupon Code [acu729640]. This combination of discounts and free shipping eliminates hidden costs, reinforcing  Temu ’s dedication to customer satisfaction and affordability. More Exclusive  Temu  Coupon Codes for Additional Savings Maximize your savings with these additional discount Codes: acu729640 – Unlock a 70% discount instantly. acu729640 – Avail extra savings for new users. acu729640 – Get free shipping on all orders. acu729640 – Enjoy bulk purchase discounts. acu729640 – Access exclusive markdowns on premium collections. Why Should You Use the  Temu  70% Off Coupon Code [acu729640]? Substantial savings across multiple product categories. Exclusive discounts for new and returning customers. Verified and legitimate Coupon Codes with immediate application. Complimentary shipping available across 67 countries. Expedited delivery and a seamless shopping experience. Final Note: Use The Latest  Temu  Coupon Code [acu729640] 70% Off The  Temu  Coupon Code [acu729640] 70% off offers an unparalleled opportunity to save significantly on high-quality products. Secure this deal now to maximize your benefits in July 2025. With the  Temu  Coupon 70% off, you can access exceptional discounts and unbeatable pricing. Apply the Code today and transform your shopping experience. Summary:  Temu  Coupon Code 70% Off  Temu  70% Off Coupon Code acu729640 70% Off Coupon Code acu729640  Temu   Temu  Coupon Code 70% Off United States 2025 Latest  Temu  Coupon Code 70% Off acu729640  Temu  70% Off Coupon Code legit How to use  Temu  70% Off Coupon Code Temu  70% Off Coupon Code free shipping Best  Temu  discount Codes 2025  Temu  promo Codes July 2025 FAQs About the  Temu  70% Off Coupon What is the 70% Off Coupon Code [acu729640] on  Temu ? The 70% Off Coupon Code [acu729640] is a promotional tool enabling shoppers to secure up to 70% savings on a vast selection of  Temu  products. How can I apply the  Temu  70% Off Coupon Code [acu729640]? To redeem the Coupon, simply add your chosen items to the cart, enter [acu729640] at checkout, and enjoy the automatic discount. Is the  Temu  70% Off Coupon Code [acu729640] available for all users? Yes! Both first-time and returning customers can leverage the 70% Off Coupon Code [acu729640] to access incredible savings. Does the 70% Off Coupon Code [acu729640] include free shipping? Yes! Applying [acu729640] at checkout not only provides a 70% discount but also ensures free shipping across applicable regions. Can the  Temu  70% Off Coupon Code [acu729640] be used multiple times? The validity and frequency of Coupon usage are subject to  Temu ’s promotional policies. Many users report success in applying the Coupon across multiple transactions, maximizing their overall savings potential.  
    • Temu Gutscheincode 100 € RABATT → [acu729640] für die USA im Juli  Spare riesig mit dem Temu Gutscheincode 100 € RABATT → [acu729640] im Juli 2025 Im Juli 2025 bringt Temu unglaubliche Rabatte für seine treuen Kunden mit einem exklusiven Gutscheincode (acu729640), der dir beeindruckende 100 € Rabatt auf deinen Einkauf gewährt. Egal, ob du Neukunde oder Stammkunde bist – du kannst bei einer riesigen Auswahl an Artikeln sparen, darunter Elektronik, Mode, Haushaltswaren und vieles mehr! Jetzt ist der perfekte Zeitpunkt, um satte Rabatte zu genießen und zu erleben, warum Temu eine der führenden globalen E-Commerce-Plattformen ist. Was macht Temu so besonders? Temu ist bekannt für eine riesige Auswahl an trendigen Produkten zu unschlagbaren Preisen. Von den neuesten Technik-Gadgets bis zu stylischer Kleidung und Haushaltsbedarf – hier findest du alles. Außerdem bietet Temu kostenlosen Versand in über 67 Länder, schnelle Lieferung und Rabatte von bis zu 90 % auf ausgewählte Produkte. Mit dem Gutscheincode (acu729640) erhältst du zusätzliche Rabatte! So verwendest du den Temu Gutscheincode (acu729640) im Juli 2025 So nutzt du das 100 €-Angebot mit dem Temu Gutscheincode (acu729640): Registrieren oder Einloggen bei Temu: Ob neu oder bereits Kunde – du musst dich anmelden oder ein Konto erstellen, um den Gutscheincode einzulösen. Durchstöbere die große Temu-Auswahl: Entdecke Temus umfangreiches Produktsortiment – von Haushaltsartikeln, Beauty-Produkten, Mode bis hin zu Hightech-Gadgets. Gutscheincode eingeben (acu729640): Gib den Code im Feld "Promo Code" beim Checkout ein, um die 100 € sofort abzuziehen. Zusätzliche Rabatte sichern: Neben den 100 € Rabatt gibt es bis zu 40 % Rabatt auf ausgewählte Artikel oder kombinierbare Gutscheinpakete. Bestellung abschließen: Überprüfe deinen Warenkorb und schließe die Bestellung ab – inklusive kostenlosem Versand in über 67 Länder! Warum du den Temu Gutscheincode (acu729640) verwenden solltest Der Temu Gutscheincode (acu729640) bietet viele Vorteile – egal ob Neukunde oder Bestandskunde: 100 € Rabatt für Neukunden: Spare 100 € bei deiner ersten Bestellung. 100 € Rabatt für Bestandskunden: Auch wiederkehrende Kunden profitieren mit acu729640 von 100 € Rabatt. 40 % zusätzlicher Rabatt: Auf ausgewählte Produkte gibt es bis zu 40 % zusätzlich. Gratisgeschenk für Neukunden: Neukunden erhalten ein kostenloses Geschenk beim Einsatz des Gutscheins. 100 € Gutscheinpaket: Spare noch mehr mit gebündelten Gutscheinen für Technik, Mode, Haushaltswaren und mehr. Temu Neukunden-Rabatte & Angebote Perfekt für Neueinsteiger! Als Neukunde bekommst du: 100 € Rabatt auf die erste Bestellung mit dem Code (acu729640). Kostenloser Versand in über 67 Länder. Exklusive Promo-Codes je nach Produktkategorie. Zusätzliche Temu Gutscheine speziell für Neukunden im Juli 2025. Temu Gutscheine für Bestandskunden Auch bestehende Kunden gehen nicht leer aus: 100 € Rabatt mit acu729640 auf die nächste Bestellung. 40 % Rabatt auf ausgewählte Produkte in vielen Kategorien. Gutscheinpaket für Bestandskunden, ideal für größere Einkäufe. Weitere Rabattcodes für beliebte Produkte und Aktionen. Neue Temu-Angebote im Juli 2025 Temu überrascht immer wieder mit frischen Angeboten. Im Juli 2025 gibt es: 100 € Rabatt für Neu- und Bestandskunden mit dem Code acu729640. Bis zu 40 % Rabatt auf Elektronik, Beauty, Deko und mehr. Neukunden-Coupons inklusive Gratisgeschenk und Sonderaktionen. Laufend neue Angebote den ganzen Juli über – regelmäßig reinschauen lohnt sich! Spare in verschiedenen Ländern & Kategorien mit Temu Gutscheinen Beispiele, wie Temu-Codes weltweit funktionieren: USA: 100 € Rabatt mit acu729640 auf Bestellungen in den USA. Kanada: Kanadier erhalten 100 € Rabatt bei Erst- oder Folgebestellung. UK: Auch britische Kunden sparen 100 € mit dem Code. Japan: Japanische Kunden erhalten 100 € Rabatt plus Sonderaktionen. Mexiko, Brasilien, Spanien, Deutschland: Bis zu 40 % Rabatt auf ausgewählte Artikel mit acu729640. Fazit Ob neu oder treu – der Temu Gutscheincode (acu729640) bringt dir im Juli 2025 satte Rabatte:  100 € sparen, 40 % auf ausgewählte Artikel und kostenloser Versand weltweit. Temu bietet großartige Preise, eine riesige Auswahl und jede Menge Aktionen. Jetzt zuschlagen: Code acu729640 im Warenkorb eingeben und sparen!  
  • Topics

×
×
  • Create New...

Important Information

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