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] Link the official modding documentation in repository README #3082

Closed
wants to merge 0 commits into from

Conversation

Cartridge-Man
Copy link
Contributor

Does this PR close any issues? If so, link them below.

#3080

Briefly describe the issue(s) fixed.

Just adds a link to the book created by the official Funkin’ Crew to the repository’s README.

@NotHyper-474
Copy link
Contributor

NotHyper-474 commented Aug 2, 2024

I feel like Modding.md could also be updated

@biomseed
Copy link

biomseed commented Aug 2, 2024

You did the wrong thing. I was talking about the mods folder readme. There is a readme in the mods folder. This is for the REPOSITORY. Do not do this. This should not close my issue. I'm pretty sure the mods folder just shows up on release builds, so if the mods folder's README is copied from something in this repo, you should edit that instead. If not, this should not be merged because then it will close my issue.
If you decide to update this if my suggestion is possible, use the dev branch instead just in case any updates release. That'll remove any merge conflicts if this isn't merged until a hotfix.
EDIT: I was confused and there is no readme in the mods folder. They should add one though. I changed things in my issue as appropriate and someone said that this shouldn't automatically close my issue. You should remove the section though as I still stand by the mods folder thing in the issue.

@biomseed
Copy link

biomseed commented Aug 2, 2024

I feel like Modding.md could also be updated

That is a really old file so I think they should get rid of it instead. The README in the mods folder is a better replacement and it is in all release builds. They could also just replace the contents with the mods folder's readme if they add my suggestion to add the link to the docs to that instead.

@NotHyper-474
Copy link
Contributor

Replying to #3082 (comment)

You mean like the introMod/README.md file or the "do NOT readme.txt"? If the former these example mods don't even get copied to release builds due to a problem.

Funkin/Project.xml

Lines 90 to 97 in 9b483de

<!-- <assets path='example_mods' rename='mods' embed='false'/> -->
<!--
AUTOMATICALLY MOVING EXAMPLE MODS INTO THE BUILD CAUSES ISSUES
Currently, this line will add the mod files to the library manifest,
which causes issues if the mod is not enabled.
If we can exclude the `mods` folder from the manifest, we can re-enable this line.
<assets path='example_mods' rename='mods' embed='false' exclude="*.md" />
-->

@biomseed
Copy link

biomseed commented Aug 2, 2024

You mean like the introMod/README.md file or the "do NOT readme.txt"? If the former these example mods don't even get copied to release builds due to a problem.

Funkin/Project.xml

Lines 90 to 97 in 9b483de

<!-- <assets path='example_mods' rename='mods' embed='false'/> -->
<!--
AUTOMATICALLY MOVING EXAMPLE MODS INTO THE BUILD CAUSES ISSUES
Currently, this line will add the mod files to the library manifest,
which causes issues if the mod is not enabled.
If we can exclude the `mods` folder from the manifest, we can re-enable this line.
<assets path='example_mods' rename='mods' embed='false' exclude="*.md" />
-->

The mods folder has a readme separate from that one. Look inside it in a release build and you will see. I know what I'm talking about.
It's not a "problem". That intro mod is just REALLY outdated and they don't use it anymore. It's what was used to add the intro text to the game back in the week 6/7 days. They just didn't delete it from the repo.

@NotHyper-474
Copy link
Contributor

NotHyper-474 commented Aug 2, 2024

Replying to #3082 (comment)

Couldn't find anything, and this is a fresh download.

@biomseed
Copy link

biomseed commented Aug 2, 2024

Couldn't find anything, and this is a fresh download. image

Oh my god I'm so sorry, I thought the mods folder had a readme but it was just mandela effect or something, there was one with codename engine and for some reason I thought there was one in the mods folder in the base game

@NotHyper-474
Copy link
Contributor

Oh my god I'm so sorry, I thought the mods folder had a readme but it was just mandela effect or something, there was one with codename engine and for some reason I thought there was one in the mods folder in the base game

It's alright, happens to the best of us lol.

@Cartridge-Man
Copy link
Contributor Author

You did the wrong thing. I was talking about the mods folder readme. There is a readme in the mods folder. This is for the REPOSITORY. Do not do this. This should not close my issue. I'm pretty sure the mods folder just shows up on release builds, so if the mods folder's README is copied from something in this repo, you should edit that instead. If not, this should not be merged because then it will close my issue.
If you decide to update this if my suggestion is possible, use the dev branch instead just in case any updates release. That'll remove any merge conflicts if this isn't merged until a hotfix.
EDIT: I was confused and there is no readme in the mods folder. They should add one though. I changed things in my issue as appropriate and someone said that this shouldn't automatically close my issue. You should remove the section though as I still stand by the mods folder thing in the issue.

I think I just experienced brain damage, but thanks for the support! (This is a joke, I’m not actually trying to be mean, I mean, I might be, but idk!)

@biomseed
Copy link

biomseed commented Aug 3, 2024

I think I just experienced brain damage, but thanks for the support! (This is a joke, I’m not actually trying to be mean, I mean, I might be, but idk!)

I don't think you're joking. That was a LONG LONG stream of text with a lot of edits made. It's all good. You can see how much I edit stuff by clicking that "edited" dropdown.

@EliteMasterEric EliteMasterEric added the status: pending triage The bug or PR has not been reviewed yet. label Aug 14, 2024
Copy link

@biomseed biomseed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one is good actually

@ninjamuffin99
Copy link
Member

i busted up the git rebase derp derp im still learning...

but I did get this merged! thank you!

@ninjamuffin99 ninjamuffin99 added type: documentation Is related to improvements or additions to documentation. and removed status: pending triage The bug or PR has not been reviewed yet. labels Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Is related to improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants