The Allegro Wiki is migrating to github at https://github.com/liballeg/allegro_wiki/wiki

Difference between revisions of "Addon writer's guide"

From Allegro Wiki
Jump to: navigation, search
m (Addon Writers' Guide: link update)
(recategorization)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Addon Writers' Guide=
 
 
 
For now, just some things you definitely should do:
 
For now, just some things you definitely should do:
  
Line 15: Line 13:
 
* If the addon is written in C, which it likely is as Allegro addon - use a proper prefix for all public symbols. This will make name-clashes with other libraries much more unlikely.
 
* If the addon is written in C, which it likely is as Allegro addon - use a proper prefix for all public symbols. This will make name-clashes with other libraries much more unlikely.
  
[[Category:Development]]
+
[[Category:Allegro development]]

Latest revision as of 15:48, August 2, 2007

For now, just some things you definitely should do:

  • Add documentation. It may be some work, and you can argue that reading the .h files provides just as much info, but it makes the addon much more useable.
  • Add at least one example. It just makes evaluating the addon for someone who is not sure if he/she wants to use it much easier - even if the example seems trivial.
  • For file-type addons, provide packfile versions of the load/save routines, so someone reading from .dat or .zip or other archives, or from memory data, will not be left out.
  • For driver/packfile/font addons, try to implement a reasonable amount of the vtable. The more, the better, generally :)
  • If the addon is written in C, which it likely is as Allegro addon - use a proper prefix for all public symbols. This will make name-clashes with other libraries much more unlikely.