Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a glossary #148

Open
wants to merge 30 commits into
base: main
Choose a base branch
from

Conversation

IchHabeHunger54
Copy link
Member

@IchHabeHunger54 IchHabeHunger54 commented Aug 9, 2024

This PR adds a glossary explaining several overall terms for modding in general and modding Minecraft specifically, as well as links for common "what is this" questions.

This glossary is explicitly not final and will never be. I expect it to be expanded over time.

Closes #110.


Preview URL: https://pr-148.neoforged-docs-previews.pages.dev

IchHabeHunger54 and others added 29 commits January 29, 2024 18:04
Co-authored-by: ChampionAsh5357 <[email protected]>
@IchHabeHunger54
Copy link
Member Author

for some reason the commit history is fucked up badly, i have no idea why

@IchHabeHunger54 IchHabeHunger54 added the addition Adding or rewriting information. label Aug 9, 2024
@IchHabeHunger54 IchHabeHunger54 requested a review from a team August 9, 2024 14:07
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 9, 2024 14:09 Active
@neoforged-pages-deployments
Copy link

neoforged-pages-deployments bot commented Aug 9, 2024

Deploying with Cloudflare Pages

Name Result
Last commit: 7e723820547ead9d2ec118132dcd00db20822a4c
Status: ✅ Deploy successful!
Preview URL: https://0a000737.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-148.neoforged-docs-previews.pages.dev

@sciwhiz12
Copy link
Member

What I would suggest, if you want to cleanup the commit history, is:

  1. Force your local main branch to point to upstream/main (git fetch upstream, then git branch -f main upstream/main);
  2. Checkout a temporary branch for your PR branch (git switch -c test);
  3. Force your PR branch to match your main branch (git branch -f feature/glossary main);
  4. Cherry-pick your one commit from the temporary branch to your fresh PR branch (git switch feature/glossary, then git cherry-pick test); and
  5. Force-push your feature/glossary branch (and perhaps main too).

Comment on lines +33 to +35
A coremod is the term for an ASM transformer file used within a mod. Traditionally, coremods were written as JavaScript files that were then loaded by a special coremod engine during [Forge][forge] or [NeoForge][neoforge] startup. More recently, Java coremods were developed as a more robust alternative. Coremods have a high entry barrier and are generally considered a last resort solution for most problems. Many problems can be solved easier using API methods, or using [mixins][mixin].

Historically, the term "coremod" has also been incorrectly used for [library mods][librarymod].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A coremod is the term for an ASM transformer file used within a mod. Traditionally, coremods were written as JavaScript files that were then loaded by a special coremod engine during [Forge][forge] or [NeoForge][neoforge] startup. More recently, Java coremods were developed as a more robust alternative. Coremods have a high entry barrier and are generally considered a last resort solution for most problems. Many problems can be solved easier using API methods, or using [mixins][mixin].
Historically, the term "coremod" has also been incorrectly used for [library mods][librarymod].
A coremod is the term for an ASM transformer file used within a mod. Originally written in Java, later as JavaScript files, they are then loaded by a special coremod engine during [Forge][forge] or [NeoForge][neoforge] startup. More recently, Java coremods were reintroduced as a more robust alternative. Coremods have a high entry barrier and are generally considered a last-resort solution for most problems. Many problems can be solved more easily using API methods or [mixins][mixin].
As the older-style Java coremods had to maintain separation from mod code, they often were distributed as standalone mods. Over time, those evolved into code libraries, so the term "coremod" nowadays is often used incorrectly for any kind of [library mod][librarymod].

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) August 25, 2024 21:27 Active
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addition Adding or rewriting information.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a glossary
3 participants