Development: Difference between revisions
Jump to navigation
Jump to search
| (37 intermediate revisions by 14 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{Kodi_development_nav}} | ||
{{ | {{mininav}} | ||
__TOC__ | __TOC__ | ||
{{-}} | {{-}} | ||
== Topics == | |||
{{see also|Category:Development}} | |||
{{development links}} | |||
== | == Source code == | ||
* | * See: https://github.com/xbmc/xbmc | ||
== | == Development Tools == | ||
* [http://www.stack.nl/~dimitri/doxygen/ Doxygen] - Source code documentation generator tool. | |||
* | |||
== | == People who can help you with specific development areas of Kodi == | ||
Your first point of call is to post on the forum in the development section. This will attract the attention of the developer knowledgeable in the field you are working on. | |||
==Other tools and resources== | == Other tools and resources == | ||
Though any other tools or resources are not required they can possibly help in development. | Though any other tools or resources are not required they can possibly help in development. | ||
* | * Eclipse CDT Setup For XBMC Development | ||
* [http://www.stack.nl/~dimitri/doxygen/ Doxygen] - Source code documentation generator tool. | * [http://www.stack.nl/~dimitri/doxygen/ Doxygen] - Source code documentation generator tool. | ||
* [http://valgrind.org Valgrind] (for Linux) - a free Linux programming tool for memory debugging, memory leak detection, and profiling. | * [http://valgrind.org Valgrind] (for Linux) - a free Linux programming tool for memory debugging, memory leak detection, and profiling. | ||
* [http://www.daimi.au.dk/~sandmann/sysprof/ Sysprof] (for Linux) - a free System-wide Linux Profiler for tracking CPU usage. Sysprof is a sampling CPU profiler for Linux that uses a kernel module to profile the entire system, not just a single application. Sysprof handles shared libraries, and applications do not need to be recompiled. In fact they don't even have to be restarted. Just insert the kernel module and start sysprof. | * [http://www.daimi.au.dk/~sandmann/sysprof/ Sysprof] (for Linux) - a free System-wide Linux Profiler for tracking CPU usage. Sysprof is a sampling CPU profiler for Linux that uses a kernel module to profile the entire system, not just a single application. Sysprof handles shared libraries, and applications do not need to be recompiled. In fact they don't even have to be restarted. Just insert the kernel module and start sysprof. | ||
= | == General guidelines == | ||
* Code documentation (DocBook, rst, or [http://www.doxygen.org doxygen] for the code documentation steps, preferably the latter, [http://www.doxygen.org doxygen]) | |||
* Self-containment - Kodi should be as little dependent as possible on operating-system and third-party services/daemons/libraries | |||
** Kodi should for example contain all file-system and network-client (like samba) support built-into the XBMC package | |||
* Modular design - independent modules made up by localized/isolated code libraries without dependencies | |||
** Kodi should still compile and run if a non-essential module/library is disabled or removed | |||
* Aim for the GUI/interface to run smoothly on a low spec computer (single core with less than 1Ghz) | |||
* | ** 3D graphic controller (GPU) will always be required hardware for Kodi so try to utilize the GPU as much as possible | ||
* | * Avoid hard-disk trashing (excess read/write/erase cycles), so no hard-drive paging, (utilize RAM memory instead). | ||
* | ** End-users will be running Kodi and the operating-system on solid-State memory as a [http://en.wikipedia.org/wiki/LiveDistro Live CD (LiveDistro)] of a USB-key | ||
* | * Fast load and boot times for end-user perception (other things can still run/start in the background without the user knowledge) | ||
* | ** 15-seconds or less from when the end user press the power-button on the computer till he/she can browse the GUI | ||
* | |||
* | |||
= | == Code guidelines and formatting conventions == | ||
[[Official:Code_guidelines_and_formatting_conventions|Official: Code guidelines and formatting conventions]] | |||
== Contact methods == | |||
* IRC: [irc://irc.libera.chat:6697/kodi-dev #kodi-dev on LiberaChat] ([https://libera.chat/ LiberaChat]) focused on Kodi development | via [https://web.libera.chat/#kodi-dev Kodi-dev on Libera Webchat] | Generic Kodi support via IRC: [irc://irc.libera.chat:6697/kodi #kodi on LiberaChat]. | |||
* Forum: [https://forum.kodi.tv/forumdisplay.php?fid=93 Kodi Development Community Forum] | |||
* [[HOW-TO:Submit_a_patch]] (where and how to submit source code) | |||
[[Category:Development | [[Category:Development]] | ||
[[Category:Skin | [[Category:Skin development]] | ||
Latest revision as of 10:55, 4 December 2021
Development:
|
|
 Development
|
Topics
See also: Category:Development
| Kodi development | |
|---|---|
| Specific topics | |
| Skinning | |
| Add-ons | |
Source code
Development Tools
- Doxygen - Source code documentation generator tool.
People who can help you with specific development areas of Kodi
Your first point of call is to post on the forum in the development section. This will attract the attention of the developer knowledgeable in the field you are working on.
Other tools and resources
Though any other tools or resources are not required they can possibly help in development.
- Eclipse CDT Setup For XBMC Development
- Doxygen - Source code documentation generator tool.
- Valgrind (for Linux) - a free Linux programming tool for memory debugging, memory leak detection, and profiling.
- Sysprof (for Linux) - a free System-wide Linux Profiler for tracking CPU usage. Sysprof is a sampling CPU profiler for Linux that uses a kernel module to profile the entire system, not just a single application. Sysprof handles shared libraries, and applications do not need to be recompiled. In fact they don't even have to be restarted. Just insert the kernel module and start sysprof.
General guidelines
- Code documentation (DocBook, rst, or doxygen for the code documentation steps, preferably the latter, doxygen)
- Self-containment - Kodi should be as little dependent as possible on operating-system and third-party services/daemons/libraries
- Kodi should for example contain all file-system and network-client (like samba) support built-into the XBMC package
- Modular design - independent modules made up by localized/isolated code libraries without dependencies
- Kodi should still compile and run if a non-essential module/library is disabled or removed
- Aim for the GUI/interface to run smoothly on a low spec computer (single core with less than 1Ghz)
- 3D graphic controller (GPU) will always be required hardware for Kodi so try to utilize the GPU as much as possible
- Avoid hard-disk trashing (excess read/write/erase cycles), so no hard-drive paging, (utilize RAM memory instead).
- End-users will be running Kodi and the operating-system on solid-State memory as a Live CD (LiveDistro) of a USB-key
- Fast load and boot times for end-user perception (other things can still run/start in the background without the user knowledge)
- 15-seconds or less from when the end user press the power-button on the computer till he/she can browse the GUI
Code guidelines and formatting conventions
Official: Code guidelines and formatting conventions
Contact methods
- IRC: #kodi-dev on LiberaChat (LiberaChat) focused on Kodi development | via Kodi-dev on Libera Webchat | Generic Kodi support via IRC: #kodi on LiberaChat.
- Forum: Kodi Development Community Forum
- HOW-TO:Submit_a_patch (where and how to submit source code)