This wiki is a read-only version of the Stardew Valley Wiki. The official editable wiki maintained by ConcernedApe can be found at stardewvalleywiki.com

Changes

Jump to: navigation, search

Modding:Open source

470 bytes added, 13:42, 14 December 2019
rework page & expand a bit
* better help users with support questions by looking at the code.
The effect can be significant: only 1% of open-source mods broke in when SMAPI 3.0released, compared to '''51%''' of closed-source mods (and that doesn't count closed-source mods that were never updated for recent game releases).
==Common questions==
; ===What if I don't like a proposed change?===: 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.
; ===What is a 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 with Git tracking. You can look up Git tutorials if you want to know more, but don't worry: 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).use it!
; Doesn't ===Does this only apply for SMAPI modscontent packs?===: NopeYep! Although content Content packs aren't compiled, but other modders can't legally make changes without a code license. Note that 'permissions' options on sites like Nexus are legally iffy (e.g. who has copyright on derivatives? Can derivatives be relicensed?), so it's a good idea to have a code license for content packs too. That also lets other modders contribute pull requests and updates. When this page says 'code', it means everything in your content pack including JSON files, images, maps, etc.
==FirstMake your code open-time setupsource=====If your code isn't on GitHub===This looks like a lot of steps, but don't worry: it's pretty straightforward, and you only need to do it once. If you need help, come ask in [[Modding:Community#Discord|#modding on the Stardew Valley Discord]]. :)
===<dl><dt>Create the a Git repository===</dt><dd>First, let's create the public repository which will contain your code.
<ol>
</ol>
That's the hard part done! Now you have a repository on GitHub that's synced with the folder on your computer.</dd>
===<dt>Add the mod files===</dt><dd>Next, let's add your files to the repository.
# Open the repository folder (the destination path you entered in step 5 above).
## Click "Commit".
That's it: all your files will appear on GitHub. Your mod is now open-source!</dd>
==Making <dt>Make changes==</dt><dd>The steps above are all first-time setup. When you want to make changes, it's much easier:
# Edit your code in the repository folder.
# In SourceTree, commit and push your changes (see step 4 in the previous section).
</dd>
</dl>
 
===If your code is already on GitHub===
You're already almost done! You just need to [https://choosealicense.com/ choose an open-source license], and [https://help.github.com/en/github/building-a-strong-community/adding-a-license-to-a-repository add a <tt>LICENSE</tt> file to the repository].
[[Category:Modding]]
Protected, translators
5,421
edits

Navigation menu