68
edits
Difference between revisions of "HOWTO-Engines"
Jump to navigation
Jump to search
→Steps: Update the "configure" instruction. typos.
(Describe common function wrappers, types and random sources) |
Salty-horse (talk | contribs) (→Steps: Update the "configure" instruction. typos.) |
||
| Line 18: | Line 18: | ||
# Add <tt>engines/quux/quux.h</tt> and <tt>engines/quux/quux.cpp</tt>; this will contain your Engine subclass (or at least parts of it). It will also contain the plugin interface code (more on that in the next section). | # Add <tt>engines/quux/quux.h</tt> and <tt>engines/quux/quux.cpp</tt>; this will contain your Engine subclass (or at least parts of it). It will also contain the plugin interface code (more on that in the next section). | ||
# Modify <tt>engines/module.mk</tt> by adding your engine. It should be clear what to do by looking at what is done for the other engines there. | # Modify <tt>engines/module.mk</tt> by adding your engine. It should be clear what to do by looking at what is done for the other engines there. | ||
# Modify <tt>configure</tt> | # Modify <tt>configure</tt> by adding a new add_engine line. Again, just check out what is done for the existing engines. | ||
# Modify <tt>base/plugins.cpp</tt>; in particular, you have to add your engine to the list in PluginManager::loadPlugins. | # Modify <tt>base/plugins.cpp</tt>; in particular, you have to add your engine to the list in PluginManager::loadPlugins. | ||
| Line 26: | Line 26: | ||
=== File name conventions === | === File name conventions === | ||
Since of the course of its | Since of the course of its existence, many people will have to deal with the source code of a given engine (be it to fix bugs in it, modify it to still compile after changes made to tbe backend code, or to simply add new functionality), it is useful to adhere to various conventions used throughout all engines. Besides source code conventions (see [[Code Formatting Conventions]]), this affects filenames. We suggest you use the following names for specific parts of your engine: | ||
{| border="1" cellpadding="2" width=100% | {| border="1" cellpadding="2" width=100% | ||
| Line 54: | Line 54: | ||
TODO: At the very least, describe the plugin interface: I.e. which functions *must* be implemented, and what they are supposed to do. Once again, sample code would be nice. | TODO: At the very least, describe the plugin interface: I.e. which functions *must* be implemented, and what they are supposed to do. Once again, sample code would be nice. | ||
Important: If you're using the ScummVM GUI (g_gui and stuff) you have always to call g_gui.handleScreenChanged() if you | Important: If you're using the ScummVM GUI (g_gui and stuff) you have always to call g_gui.handleScreenChanged() if you received a OSystem::EVENT_SCREEN_CHANGED event, else it could be that your gui looks strange or even crashes ScummVM. | ||
=== Infrastructure services === | === Infrastructure services === | ||