{"id":15174894,"url":"https://github.com/team-inceptus/inceptusnms","last_synced_at":"2025-10-01T12:30:58.546Z","repository":{"id":197109755,"uuid":"697055758","full_name":"Team-Inceptus/InceptusNMS","owner":"Team-Inceptus","description":"JavaDocs Generator for Spigot NMS Implementations \u0026 CraftBukkit","archived":true,"fork":false,"pushed_at":"2024-01-30T20:10:10.000Z","size":13802,"stargazers_count":5,"open_issues_count":14,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-09-27T12:01:19.572Z","etag":null,"topics":["bukkit","craftbukkit","documentation","minecraft","minecraft-api","nms","spigot","spigot-api"],"latest_commit_sha":null,"homepage":"http://nms.teaminceptus.us/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Team-Inceptus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-09-27T00:55:48.000Z","updated_at":"2024-02-04T08:58:37.000Z","dependencies_parsed_at":"2023-10-04T09:35:11.509Z","dependency_job_id":"4638fe46-06ea-4428-bb6e-10f59c85bae4","html_url":"https://github.com/Team-Inceptus/InceptusNMS","commit_stats":null,"previous_names":["team-inceptus/inceptusnms"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Team-Inceptus%2FInceptusNMS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Team-Inceptus%2FInceptusNMS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Team-Inceptus%2FInceptusNMS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Team-Inceptus%2FInceptusNMS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Team-Inceptus","download_url":"https://codeload.github.com/Team-Inceptus/InceptusNMS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219875425,"owners_count":16554677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bukkit","craftbukkit","documentation","minecraft","minecraft-api","nms","spigot","spigot-api"],"created_at":"2024-09-27T12:01:32.624Z","updated_at":"2025-10-01T12:30:53.095Z","avatar_url":"https://github.com/Team-Inceptus.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# InceptusNMS\r\n\u003e JavaDocs for Mojang-Mapped Minecraft NMS and CraftBukkit for the latest Minecraft Version\r\n\r\nInceptusNMS 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.\r\n\r\n## 📕 Background\r\n\u003cdetails\u003e\r\n    \u003csummary\u003eClick to Expand\u003c/summary\u003e\r\n\r\nThe 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.\r\n\u003c/details\u003e\r\n\r\n### ❓How Does it Work?\r\n\r\n\u003cdetails\u003e\r\n    \u003csummary\u003eClick to Expand\u003c/summary\u003e\r\n\r\nWe 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](CONTRIBUTING.md).\r\n\u003c/details\u003e\r\n\r\n## 💻 Using with an IDE\r\n\r\n\u003cdetails\u003e\r\n    \u003csummary\u003eIntelliJ\u003c/summary\u003e\r\n\r\n1. File -\u003e Project Structure -\u003e Libraries\r\nLocate your NMS Dependency\r\n\r\n![Step 1](https://proxy.spigotmc.org/58c4035953801bd2cf399bd0af587b66a6a42fc5?url=https%3A%2F%2Fmedia.discordapp.net%2Fattachments%2F894254760075603980%2F1161000215348785213%2Fimage.png%3Fex%3D6536b4b5%26is%3D65243fb5%26hm%3Da7b65f14e3cc13d53ad7301a3ac68a83ae3a7432fdb5da27bb4ae2c5fc31b601%26%3D%26width%3D854%26height%3D702)\r\n\r\n2. Click on \"Specify Documentation URL\" (Plus with the Earth Icon)\r\n\r\n![Step 2](https://proxy.spigotmc.org/f426b0f664207033e95f5ff87c3ecf1c0361b314?url=https%3A%2F%2Fmedia.discordapp.net%2Fattachments%2F894254760075603980%2F1161000429023408269%2Fimage.png%3Fex%3D6536b4e8%26is%3D65243fe8%26hm%3D9a58f136e94a3b63445f7b137a9336e42a36f264ad569332b75bab334bb6cde2%26%3D)\r\n\r\n3. Enter the Browser URL\r\n\r\n![Step 3](https://proxy.spigotmc.org/d332d79120cc6eb95f7808eb5111faa99bd10335?url=https%3A%2F%2Fmedia.discordapp.net%2Fattachments%2F894254760075603980%2F1161000611572097114%2Fimage.png%3Fex%3D6536b514%26is%3D65244014%26hm%3Da8d54f9a71fd82cc8c1eb4a92efc2cfb7531f686bbc9e2d0035e3289afbdf188%26%3D)\r\n\r\n4. Done!\r\n\r\n![Step 4](https://proxy.spigotmc.org/7f560e2d345a50a5721981a5d705a232180c0f2d?url=https%3A%2F%2Fmedia.discordapp.net%2Fattachments%2F894254760075603980%2F1161001055740510278%2Fimage.png%3Fex%3D6536b57e%26is%3D6524407e%26hm%3D6ccb32cb51584e3c517408198fbc7a1eb5413c6d887174787fa53fa86c7660a0%26%3D)\r\n\u003c/details\u003e\r\n\r\n\u003cdetails\u003e\r\n    \u003csummary\u003eEclipse\u003c/summary\u003e\r\n\r\nCredit to [@SkytAsul](https://www.spigotmc.org/members/373955/)\r\n\r\n1. Right click on project -\u003e Properties -\u003e Java Build Path -\u003e Libraries   \r\nLocate your NMS Dependency\r\n\r\n![Step 1](https://media.discordapp.net/attachments/894254760075603980/1172009961048518816/upload_2023-10-9_20-54-45.png?ex=655ec255\u0026is=654c4d55\u0026hm=f485cff5179620213ee174a2a2fc6cb3a43540b2cd3334da7accbffa406115ff)\r\n\r\n2. Expand Dependency, select \"JavaDoc Location\" and click on \"Edit...\"\r\n\r\n![Step 2](https://media.discordapp.net/attachments/894254760075603980/1172009961333719081/upload_2023-10-9_20-57-32.png?ex=655ec255\u0026is=654c4d55\u0026hm=fdceb0033f1091d8acc509bd8dbd83b8bce471801db3061666beaad60ac3ec41)\r\n\r\n3. Enter the Browser URL\r\n\r\n![Step 3](https://media.discordapp.net/attachments/894254760075603980/1172009961568608328/upload_2023-10-9_20-58-33.png?ex=655ec255\u0026is=654c4d55\u0026hm=a69e92b65f9731d8b55a9e5a6a87f69a3298d6e1d7d4d4beac805babc5b7f68e)\r\n\r\n4. Done!\r\n\u003c/details\u003e\r\n\r\n## 📝 Contributing\r\n\r\nPlease see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteam-inceptus%2Finceptusnms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteam-inceptus%2Finceptusnms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteam-inceptus%2Finceptusnms/lists"}