Skip to content

Commit

Permalink
Update README and change config.properties to config.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
Gaming32 committed Oct 24, 2023
1 parent a8d8084 commit eae4562
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

An advanced loading screen with the loading progress of mods. It works on all Minecraft versions, as it doesn't even require Minecraft. Its only requirement is Fabric Loader 0.12.0 or later or Quilt Loader (specific versions of Quilt support are unknown). Do note that if you run this mod on a game other than Minecraft, the loading screen may not close itself.

## Agent

Mod Loading Screen provides a Java agent, which allows opening the loading screen before even the mod loader itself loads. This feature is primarily targeted at modpack developers who want to make a seamless loading experience. The agent can be used by passing `-javaagent:mod-loading-screen-1.0.4.jar` as a JVM argument. If the agent is used, the loading screen should *not* be installed as a mod.

## API

To depend on the API, use the Modrinth Maven. The API should be JiJed, and doing so will not include Mod Loading Screen inside your mod (it will only include the API, which is only a few kilobytes). The API is designed to have both forwards and backwards binary compatibility with future Mod Loading Screen versions. An API is provided for checking which API calls will return stubs and which ones are real.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ public static void startLoadingScreen(boolean fabricReady) {
}

private static void loadConfig() {
final Path configFile = configDir.resolve("config.properties");
final Path configFile = configDir.resolve("config.txt");

final Properties configProperties = new Properties();
try (InputStream is = Files.newInputStream(configFile)) {
Expand Down

0 comments on commit eae4562

Please sign in to comment.