-
Notifications
You must be signed in to change notification settings - Fork 251
Clarify that mod-id placeholders must be customized
#348
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
Conversation
mod-id should be replace with specific mod-id, and shoud notice beginers, or will confusing them for lots time and i am the unlucky poor guy stucke for 2 hours!!!!
✅ Deploy Preview for nimble-elf-d9d491 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
| The package name should be lowercase, separated by dots, and unique to avoid conflicts with other programmers' packages. It is typically formatted as a reversed internet domain, such as `com.example.mod-id`. | |
…请添加以下英文内容(下面提供中文翻译,方便理解,但在文档中请务必写英文版本):
::: warning
请务必记住你模组的 ID!
每当你在这些文档中看到 `mod-id`,特别是在文件路径中时,你都需要将其替换为你自己的。
:::在我们解决了本项目中的一些其他问题之后,我计划处理这个(非常常见的)问题。
我有一个想法,就是在 Docs 网站上提供一个功能,让用户可以动态设置 mod-id,并将其应用到所有地方(从而解决这个问题)。
我很期待你能提出一些解决这个问题的建议。
最后,我想提醒你,如果你还不知道的话,当你遇到类似这种阻碍时,欢迎联系 Fabric Discord 服务器 上的社区。
你也可以在这个页面中找到其他技巧:关于调试模组。
Thank you for your contribution!
I definitely agree that the docs lack clarity in which placeholders/names can be customized, and how that influences the rest of the codebase.
I am sorry that you found yourself stuck because of this misunderstanding.
However, I don't believe this is the best solution, because we'd need to specify this everywhere.
Instead, for now I'd want to ask you to edit develop/getting-started/creating-a-project.md, and under line 16:
fabric-docs/develop/getting-started/creating-a-project.md
Lines 16 to 17 in 02ece42
| The package name should be lowercase, separated by dots, and unique to avoid conflicts with other programmers' packages. It is typically formatted as a reversed internet domain, such as `com.example.mod-id`. | |
...please add the following:
::: warning
Make sure you remember your mod's ID!
Whenever you find `mod-id` in these docs, especially in file paths, you will have to replace it with your own.
:::
After we've sorted some other issues in this project, I plan on tackling this (very common) problem.
I have an idea for dynamically allowing the user to set the mod-id on the Docs website, and that would apply everywhere (fixing this).
I'd love any suggestions you may have to solve this.
Finally, I'd like you remind you, in case you didn't know, that when getting stuck like this you are welcome to contact the community on the Fabric Discord server.
You can find other tips in this page about debugging mods.
mod-id placeholders must be customized
|
let user dynamicly set mod-id is good idea. that mean after user use template-generator, and we can remember there mod-id, or just prompt user navigate to tutorial page with mod-id user set. |
just remind user replace mod-id with id user set
litter change
notice user replace mod-id in doument with their specific mod's id
|
tired let it be |
* upstream/main: Update rendering concepts page (FabricMC#362) "Setting up a Development Environment": VS Code (FabricMC#360) Running Game Tests In Github Actions (FabricMC#338) Items: Item Models (FabricMC#324) Call `.useBlockPrefixedTranslationKey()` (FabricMC#358) Clarify that `mod-id` placeholders must be customized (FabricMC#348) replace remaining mentions of tickDelta with tickProgress (FabricMC#361) Project location (FabricMC#326) improve the first items docs to state what's needed for item appearance, link fix (FabricMC#359)
* Update first-item.md mod-id should be replace with specific mod-id, and shoud notice beginers, or will confusing them for lots time and i am the unlucky poor guy stucke for 2 hours!!!! * Update creating-a-project.md just remind user replace mod-id with id user set * Update creating-a-project.md litter change * Apply suggestions from code review --------- Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com> (cherry picked from commit 70285c3)
* Update first-item.md mod-id should be replace with specific mod-id, and shoud notice beginers, or will confusing them for lots time and i am the unlucky poor guy stucke for 2 hours!!!! * Update creating-a-project.md just remind user replace mod-id with id user set * Update creating-a-project.md litter change * Apply suggestions from code review --------- Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com> (cherry picked from commit 70285c3)
* Update first-item.md mod-id should be replace with specific mod-id, and shoud notice beginers, or will confusing them for lots time and i am the unlucky poor guy stucke for 2 hours!!!! * Update creating-a-project.md just remind user replace mod-id with id user set * Update creating-a-project.md litter change * Apply suggestions from code review --------- Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com> (cherry picked from commit 70285c3)
mod-id should be replace with specific mod-id, and shoud notice beginers, or will confusing them for lots time and i am the unlucky poor guy stucke for 2 hours!!!!
What was written earlier is too misleading.