Line 1: |
Line 1: |
| ←[[Modding:Index|Index]] | | ←[[Modding:Index|Index]] |
| | | |
− | A mod is '''open-source''' if its code is public and covered by [https://choosealicense.com/ an open-source license]. Open-source is core to a healthy mod ecosystem, and modders are highly encouraged to make their mods open-source (both SMAPI mods and content packs). | + | A mod is '''open-source''' if its code is public and covered by [https://choosealicense.com/ an open-source license]. Modders are highly encouraged to make their mods and content packs open-source. |
| + | |
| + | ==Why is open source important?== |
| + | Open source is important for the long-term health of the modding community, and helps make the player experience smoother. Depending on the open-source license you choose, others can... |
| + | |
| + | * see your code; |
| + | * make changes to a copy of the code; |
| + | * send you proposed updates, changes, and fixes; |
| + | * prepare unofficial updates; |
| + | * better help users with support questions by looking at the code. |
| + | |
| + | The effect can be significant: only 1% of open-source mods broke in SMAPI 3.0, compared to '''51%''' of closed-source mods. |
| | | |
| ==Common questions== | | ==Common questions== |
− | ; What is 'open source'? | + | ; What if I don't like a proposed change? |
− | : Open source means your mod's code is public and others can change ''a copy of it'' subject to a license you choose. You still have full control of your original code and mod pages; nobody can change those without your approval! However, open source lets others create unofficial updates or publish their own versions. | + | : You still have full control of your original code and mod pages; nobody can change those without your approval! You're free to reject a change someone proposes to your mod. |
− | | |
− | ; Do I have to go open-source?
| |
− | : No, but it's strongly recommended. Making mods open-source is important for the long-term health of the modding community — when you're away or lose interest, others can still update your mods for the latest versions. 66% of SMAPI mods have source code available, which contributes to over 90% of tracked SMAPI mods being updated after major game updates.
| |
| | | |
| ; What is Git? What's a repository? | | ; What is Git? What's a repository? |
− | : Git is software that helps track changes to your code, and a ''repository'' is a folder containing your mod files plus special files for Git tracking. You don't really need to know how it works at this point; we'll walk you through getting your code up and making changes (and you can look up Git tutorials if you want to dig deeper). | + | : Git is software that helps track changes to your code, and a repository is a folder containing your mod files with Git tracking. You don't need to know how it works at this point; we'll walk you through getting your code up and making changes (and you can look up Git tutorials if you want to dig deeper). |
| | | |
| ; Doesn't this only apply for SMAPI mods? | | ; Doesn't this only apply for SMAPI mods? |