Patches Welcome: Difference between revisions
(Created page with '== License == OpenKore is licensed under GNU General Public License. That basically means that anyone can modify it; and anyone can distribute modified OpenKore as long as all th…') |
|||
| Line 14: | Line 14: | ||
<span style="color:red;">Don't just post your whole OpenKore directory, that most likely will result in deleting your post</span> (unless you're really know what you're doing — in this case, post svn working copy anyway). | <span style="color:red;">Don't just post your whole OpenKore directory, that most likely will result in deleting your post</span> (unless you're really know what you're doing — in this case, post svn working copy anyway). | ||
'''Instead, post a diff | '''Instead, post a diff file and specify a svn revision you've worked with.''' | ||
Benefits: | Benefits: | ||
* Your patch most likely can be applied to subsequent revisions. | * Your patch most likely can be applied to subsequent revisions. | ||
| Line 20: | Line 20: | ||
* People can quickly inspect and understand your modifications and provide more intelligent feedback. | * People can quickly inspect and understand your modifications and provide more intelligent feedback. | ||
* Developers can commit your patch into trunk way more easily. | * Developers can commit your patch into trunk way more easily. | ||
Diff file can be created with svn client from your modified working copy with <code>svn diff</code>. | |||
Diff file can be applied to your OpenKore with <code>patch</code>. | |||
On Windows, TortoiseSVN can be used. | |||
If you're posting a diff file, you can optionally post OpenKore with that patch applied or just changed files. But that is unnecessary. | |||
Revision as of 08:05, 14 October 2010
License
OpenKore is licensed under GNU General Public License. That basically means that anyone can modify it; and anyone can distribute modified OpenKore as long as all the source code included.
Ways of Modification
- Write a plugin. Plugins can use various hooks to alter OpenKore's behavior, and they can be easily (un)installed without modifications of OpenKore itself.
- Make a patch (modify OpenKore source code).
Sharing Plugins
Post your plugin in corresponding forum section, like "Other Plugins". Include instructions of how to use and description.
Sharing Patches
If you're fixing errors or server support, make sure that isn't fixed yet in trunk.
Don't just post your whole OpenKore directory, that most likely will result in deleting your post (unless you're really know what you're doing — in this case, post svn working copy anyway).
Instead, post a diff file and specify a svn revision you've worked with. Benefits:
- Your patch most likely can be applied to subsequent revisions.
- Modified with your patch OpenKore can be updated without disturbing your applied patch.
- People can quickly inspect and understand your modifications and provide more intelligent feedback.
- Developers can commit your patch into trunk way more easily.
Diff file can be created with svn client from your modified working copy with svn diff.
Diff file can be applied to your OpenKore with patch.
On Windows, TortoiseSVN can be used.
If you're posting a diff file, you can optionally post OpenKore with that patch applied or just changed files. But that is unnecessary.