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

READ ME: Bug Report Guidelines for Issues and Glitches #343

Open
Shibva opened this issue Feb 19, 2024 · 2 comments
Open

READ ME: Bug Report Guidelines for Issues and Glitches #343

Shibva opened this issue Feb 19, 2024 · 2 comments

Comments

@Shibva
Copy link

Shibva commented Feb 19, 2024

I The following are general guidelines for making a report in this repository. Please try to follow this to the best of your ability to ensure the issue is reproducible.

FOREWORD

Things to note about this version of NTM:

  • not all features are implemented and may never be fully implemented
  • CONFIGS ARE NOT FULLY VERSION STABLE: The way the config system is written appears to have itself updated instead of a full-blown overwrite or something; however, this system is far from perfect and will be prone to slipups; with that said REGENERATE YOUR CONFIG BEFORE MAKING A REPORT REGARDING CONFIGURABLE CONTENT
    • Configs markers can change, therefore certain things may be switched off.

Rendering issues:

Before you report a rendering issue, consider the following:

  • Do you have any mods that alter the rendering and/or lighting engine (IE. OPTIFINE, Phosphorus, etc.)
  • If it has something to do with special rendering things like shader lights and whatnot; make sure Shaders2 enabled
    • NOTE: By enabling this option, you hereby forfeit your right to use Optifine shaders for as long as it is on; game freezing will ensure, (this is why it was disabled by default sadly)

Configuration Bugs

  • Test for bugs using a fresh config with your settings before making a report; as mentioned above, the config may have rebuilt itself leaving previous values behind.

Crafttweaker bugs:

  • At this point in time OREDICTONARY is NOT supported

Modlist

  • In cases where they are a lot of mods or its an issue as a result of some other mod, its recommended to provide a mod list or more preferably perform the binary method (nicknamed Thanos Method; divide list in half and divide that half in the half that has the issue and so forth till you find the pinpoint mod with the mod affecting HBM NTM)
  • When a mod list is required, its best that a crash report is provided; crash reports always print a list of mods present and their load status each time a crash report is generated (Even when the Debug Crash (F3+C for 10 seconds)) but its best to report the mod causing the compact issue when possible
@Shibva
Copy link
Author

Shibva commented Feb 19, 2024

@Alcatergit I decided to make this after coming to realize a few things, hope this can help you out with people making reportsin the future ^w^; the fact the general configs can change and cause previous settings to be not considered might be something to be aware of regarding future updates that might scramble old configs

@Shibva Shibva changed the title PIN ME: Bug Report Checklist; READ ME PIN ME: Bug Report Guidelines for Issues and Glitches; READ ME Feb 23, 2024
@Alcatergit Alcatergit pinned this issue Mar 3, 2024
@Alcatergit
Copy link
Owner

Alcatergit commented Mar 3, 2024

And please add one of the following prefixes to the name of the issue you report.
"Bug: " - For bugs
"Suggestion: " - For suggestions
"QoL: " - For Quality of Life improvement proposals
"Question: " - For questions that you did not find an answer to after searching

@Shibva Shibva changed the title PIN ME: Bug Report Guidelines for Issues and Glitches; READ ME READ ME: Bug Report Guidelines for Issues and Glitches Mar 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants