Patches Welcome: Difference between revisions
m (→Patch) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
OpenKore is licensed under the terms of [http://www.gnu.org/licenses/gpl.html GNU General Public License]. In short, it means: | OpenKore is licensed under the terms of [http://www.gnu.org/licenses/gpl.html GNU General Public License]. In short, it means: | ||
* anyone can modify it; | * anyone can modify it; | ||
* as long as full source code is provided | * anyone can distribute modified versions as long as full source code is provided and license is unchanged. | ||
Note that the greater part of OpenKore runs directly from the source (and the other is meant to be compiled right before running). | |||
== Ways of Modification == | == Ways of Modification == | ||
| Line 31: | Line 33: | ||
Use svn client or other tools to create and apply diffs. | Use svn client or other tools to create and apply diffs. | ||
If you're posting a diff file, you can optionally post OpenKore with that patch applied or just changed files. But that is unnecessary. | If you're posting a diff file, you can also optionally post OpenKore with that patch applied or just changed files. But that is unnecessary. | ||
Revision as of 19:34, 5 June 2011
License
OpenKore is licensed under the terms of GNU General Public License. In short, it means:
- anyone can modify it;
- anyone can distribute modified versions as long as full source code is provided and license is unchanged.
Note that the greater part of OpenKore runs directly from the source (and the other is meant to be compiled right before running).
Ways of Modification
Plugin
Plugin is a Perl script OpenKore runs and interacts with via various hooks. As plugins use the same Perl interpreter as OpenKore, they can use its internals and symbolic table manupulation to alter just about anything.
Benefits of plugins over patches:
- Plugins can be easily (un)installed without modifications of OpenKore itself.
- Plugins are independent from OpenKore modifications to some degree, so unless there is really incompatible update, they will keep working.
To share your plugin, post it with description and instructions in corresponding forum section, like "Other Plugins".
Plugins could be added to OpenKore svn, for committing you need to gain write access or ask ones who have it.
Patch
"Patch" is a direct modification of OpenKore source code. That's needed in the first place for fixing bugs in the existing stuff.
To share your patch, don't just post your whole OpenKore directory (bonus points: on a random JavascriptFlashWaitBeforeDownload file hosting), that most likely will result in deleting your post.
Instead, post a diff file and specify a svn revision you've worked with.
Benefits of diffs over wtfs:
- 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.
Use svn client or other tools to create and apply diffs.
If you're posting a diff file, you can also optionally post OpenKore with that patch applied or just changed files. But that is unnecessary.