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

Enhancement: Include a link to the modding documentation in a README.txt in the mods folder #3080

Closed
1 of 2 tasks
biomseed opened this issue Jul 31, 2024 · 7 comments
Closed
1 of 2 tasks
Labels
status: resolved The issue has been fixed or the suggestion has been implemented. type: documentation Involves improvements or additions to documentation.

Comments

@biomseed
Copy link

biomseed commented Jul 31, 2024

Issue Checklist

  • I have properly named the enhancement
  • I have checked the issues/discussions pages to see if the enhancement has been previously suggested

What is your suggestion, and why should it be implemented?

You should add a link to the modding documentation a README in the mods folder so newer people can understand that that is where to go to figure out how to mod the game.

@biomseed biomseed added status: pending triage Awaiting review. type: enhancement Involves an enhancement or new feature. labels Jul 31, 2024
@Cartridge-Man
Copy link
Contributor

w h a t .

@NotHyper-474
Copy link
Contributor

@Cartridge-Man
Copy link
Contributor

oh thanks lol I had no idea documentation for modding existed! Gonna make a pr for this in order to link the repository for the mods folder README.md

@biomseed
Copy link
Author

biomseed commented Aug 2, 2024

oh thanks lol I had no idea documentation for modding existed! Gonna make a pr for this in order to link the repository for the mods folder README.md

I was referring to the mods folder readme. You changed the one for the repository. Do not add my issue to your PR or else it will be closed if merged.

@NotHyper-474
Copy link
Contributor

NotHyper-474 commented Aug 2, 2024

Do not add my issue to your PR or else it will be closed if merged.

Actually he didn't use keywords as mentioned here so it's not linked to the PR. Unless you mean Eric/Cameron manually closing the issue.

@biomseed biomseed changed the title Enhancement: Refer to the modding documentation in the mods folder README Enhancement: Include a link to the modding documentation in a README.txt in the mods folder Aug 2, 2024
@biomseed
Copy link
Author

biomseed commented Aug 2, 2024

I was wrong, there was no README in the mods folder. I made the changes to this issue as needed (imo)

@biomseed
Copy link
Author

Partially done

@Hundrec Hundrec added type: documentation Involves improvements or additions to documentation. status: resolved The issue has been fixed or the suggestion has been implemented. and removed status: pending triage Awaiting review. type: enhancement Involves an enhancement or new feature. labels Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: resolved The issue has been fixed or the suggestion has been implemented. type: documentation Involves improvements or additions to documentation.
Projects
None yet
Development

No branches or pull requests

4 participants