Mod-specific Logger & Logger configuration setup

Open
#123 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
documentation

Research direction

Start in the documentation's utilities section and review existing guidance around the Log4j API and FML's mod-specific Logger. Add a page covering logger usage and logging.properties configuration, with enough direction for newer modders to follow both tasks. Done means both requested topics are documented in the appropriate utilities section.

Written by the indexing model from the issue text.

Description

Page Request

Having a page in the documentation (likely in utilities) would be beneficial to let newer modders know about the proper way to use the Log4j API and use the mod-specific Logger that FML provides. Additionally, documentation on configuring the logging.properties file would be greatly appreciated.

Dominant language
HTML
Stars
513
Forks
192
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MinecraftForge/Documentation

All issues in MinecraftForge/Documentation

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.