Update basic-csharp-mod.md (Correcting misleading instructions) #145
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the Setting up your Project section, there are a couple of slightly misleading instructions that are not entirely true, causing extra pain points to readers wishing to join the modding community. At step 5, it says to refer all Taleworld.*.dll files to your C# project in Visual Studio, but Taleworlds.Native.dll is not written in C# and therefore shows up an error message when readers try to follow the instruction. At step 6, the same situation happens when readers follow the instruction for the Multiplayer module. This commit clarifies these misleading "do this to all, every" instructions by stating that not all files will be referenced properly, therefore the error messages are normal.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the Setting up your Project section, there are a couple of slightly misleading instructions that are not entirely true, causing extra pain points to readers wishing to join the modding community.
At step 5, it says to refer all
Taleworld.*.dllfiles to your C# project in Visual Studio, butTaleworlds.Native.dllis not written in C# and therefore shows up an error message when readers try to follow the instruction.At step 6, the same situation happens when readers follow the instruction for the Multiplayer module.
These two are clearly misleading causing extra pain points to new readers ("it doesn't work in my PC").
This commit clarifies these misleading "do this to all, every" instructions by stating that not all files will be referenced properly, therefore the current error messages are normal.