Skip to content

Conversation

@fatherOfMS
Copy link
Contributor

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.

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!!!!
@fatherOfMS fatherOfMS requested a review from a team as a code owner August 19, 2025 15:02
@netlify
Copy link

netlify bot commented Aug 19, 2025

Deploy Preview for nimble-elf-d9d491 ready!

Name Link
🔨 Latest commit bf313df
🔍 Latest deploy log https://app.netlify.com/projects/nimble-elf-d9d491/deploys/68ca70499dcfef000876ce78
😎 Deploy Preview https://deploy-preview-348--nimble-elf-d9d491.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@its-miroma
Copy link
Member

its-miroma commented Aug 19, 2025

阅读自动翻译

感谢你的贡献!

我完全同意,文档在说明哪些占位符/名称可以自定义,以及这如何影响代码库的其余部分时缺乏清晰性。
很抱歉你因为这个误解而遇到了阻碍。

不过,我认为这并不是最好的解决方案,因为我们需要在所有地方都进行说明。
相反,目前我想请你编辑 develop/getting-started/creating-a-project.md,并在 第 16 行 下方:

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:

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.

@its-miroma its-miroma added improvement A new addition to an already existing page todo:expand This should be expanded priority:low This is nice to have, but it can wait a little labels Aug 19, 2025
@its-miroma its-miroma changed the title Update first-item.md Clarify that mod-id placeholders must be customized Aug 19, 2025
@fatherOfMS
Copy link
Contributor Author

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.
and waiting for better solution and maker the tutorial document more friendly use for beinnger.

just remind user replace mod-id with id user set
notice user replace mod-id in doument with their specific mod's id
@fatherOfMS
Copy link
Contributor Author

tired let it be

@its-miroma its-miroma added stage:ready and removed todo:expand This should be expanded priority:low This is nice to have, but it can wait a little labels Sep 17, 2025
@its-miroma its-miroma requested a review from a team September 17, 2025 09:26
@its-miroma its-miroma merged commit 70285c3 into FabricMC:main Sep 17, 2025
7 checks passed
its-miroma added a commit to dicedpixels/fabric-docs that referenced this pull request Sep 24, 2025
* 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)
kevinthegreat1 pushed a commit to kevinthegreat1/fabric-docs that referenced this pull request Oct 14, 2025
* 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)
kevinthegreat1 pushed a commit to kevinthegreat1/fabric-docs that referenced this pull request Oct 14, 2025
* 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)
kevinthegreat1 pushed a commit to kevinthegreat1/fabric-docs that referenced this pull request Oct 15, 2025
* 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement A new addition to an already existing page

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants