JavaDocs for Mojang-Mapped Minecraft NMS and CraftBukkit for the latest Minecraft Version
InceptusNMS is a repository of documented Net-Minecraft-Server (NMS) and CraftBukkit Code for Minecraft: Java Edution. It utilizes a custom parser made in Kotlin from an input of JSON files to generate a JavaDocs-style browser.
Click to Expand
The goal of this project is to attempt to emulate a JDK 17 JavaDocs-style Browser for the Mojang-Mapped NMS Mappings and CraftBukkit Server, in order to make NMS and CraftBukkit Development easier and more accessible.
Click to Expand
We use a custom parser to parse JSON files stored in our docs folder to emulate a JavaDocs browser. Developed in Kotlin and Java, the parser is able to parse the JSON files and generate a JavaDocs-style browser for the NMS and CraftBukkit Server. Things like schemas, examples, and contributing guidelines are available in CONTRIBUTING.md.
IntelliJ
- File -> Project Structure -> Libraries Locate your NMS Dependency
- Click on "Specify Documentation URL" (Plus with the Earth Icon)
- Enter the Browser URL
- Done!
Eclipse
Credit to @SkytAsul
- Right click on project -> Properties -> Java Build Path -> Libraries
Locate your NMS Dependency
- Expand Dependency, select "JavaDoc Location" and click on "Edit..."
- Enter the Browser URL
- Done!
Please see CONTRIBUTING.md for more information.
