Where to Find the EaglerForge Guide and API Docs

Updated

The official EaglerForge site (eaglerforge.github.io) is the place to start: its main navigation lists EaglerForge, Guide, API Docs, Appearance, and Source code. Use Guide to learn how to use the mod loader, API Docs to build mods against its API, and Source code when you need to inspect the implementation.

What each entry gives you

Entry What it is for When to use it
EaglerForge The site's landing section, describing the project as a mod loader for Eaglercraft First visit, to confirm you are on the right project
Guide Step-by-step usage material Setting up and running EaglerForge
API Docs Reference for the modding API Writing or debugging a mod
Source code Link to the project's code Checking behavior the docs do not cover
Appearance Site display settings Adjusting how the site looks; not a modding resource

How to use them together

  1. Open the site and read the landing section so you know what EaglerForge is: a mod loader for Eaglercraft.
  2. Go to Guide and follow it in order for setup and first use. Treat it as the primary path; the site presents it as the main learning resource alongside the API reference.
  3. Switch to API Docs once you move from running mods to writing them. Keep it open as a reference while coding.
  4. Fall back to Source code only for questions the Guide and API Docs do not answer.

The site also has a Search control in its navigation, which is the fastest way to jump to a specific topic once you know roughly what you need.

Common sticking points

  • Confusing the two resources. The Guide teaches usage; the API Docs describe interfaces. If a step fails during setup, recheck the Guide before digging into API details.
  • Skipping the landing section. It states the project's purpose in one line, which prevents wasted time if you actually need a different tool.
  • Expecting pricing or account details. The site's navigation shows no pricing or login entries, so do not assume a paid tier or account system exists; check the site itself if that matters to you.

Start at eaglerforge.github.io, then choose Guide for usage or API Docs for development.