The Game Object Oriented Framework Introduction
The Game Object Oriented Framework (GOOF) is a game engine (GOOF Engine) and a world editor (GOOF Editor) for Ogre3D.
Table of contents
The GOOF Engine is built on top of existing scene managers and can work with any Ogre scene manager. Its purpose is to provide various game systems such as object partitioning, serialization, level of detail on any type of object, input management, sound management, user interface and game state management, and various types of built in game objects for speeding up game development. All of these systems are implemented using a plugin framework so that new systems and game objects can be plugged in easily.
The GOOF Editor is an editor framework that can be used as a container for content creation tools for your production pipeline. Simply put, it's a framework for tools you build for your game using a nice plugin framework, and includes two plugins : a terrain editor plugin for the Paging Scene Manager, and a world editor plugin that builds scenes that can be used in the GOOF Engine. In fact, the GOOF Engine runs right inside the GOOF Editor, so it's really WYSIWYG - and includes all of the features of the Engine right inside the Editor.
GOOF started out as a generic object handling framework that provided a system for managing game objects. Clay Larabie (Falagard) is the primary contributor and maintainer of this project.
See this forum thread for ongoing discussion of the GOOF Engine and GOOF Editor:
GOOF is currently available in ogreaddons as an early pre-alpha version and is being updated daily. Click below to follow instructions on how to install GOOF.
Game Object Oriented Framework Installation
Game Object Oriented Framework Design
Todo - describe the major systems in detail here
Above you can see some of primary classes in GOOF for dealing with GameObjects.
Above you can see the editor framework, which includes plugin systems for tools.
Input Controllers are used for controlling the camera and possibly other objects such as Players.
Manipulators are used to manipulate anything in the scene. This may include GameObjects, but is not specifically tied to GameObjects since the actual translation, rotation, etc. of the currently selected object is handled through callbacks. For example, other editor plugins could use manipulators to move their own types of objects.
Here is a list of some of the game objects currently included in GOOF, as well as partitions.
Game systems currently implemented in GOOF. SoundGameSystem is currently in the process of being added.
Out of Date Information
Some of the following information below is out of date but is being left in until it can be updated.
The core functionality provided by GOOF includes:
- Saving and loading serialization system. Includes the ability for custom objects to serialize their own properties. A generic "metadata" system to share data across objects of the same type, which speeds up loading time, lowers disk space requirements, lowers memory requirements, and allows you to alter all objects saved in your world by just modifying one .meta file.
- Update management system so that objects can receive update events
- Editor Framework with plugin system for tools. Editor can be compiled standalone or embedded directly into a game, sharing code between the editor and the game.
- Custom level of detail system that can be used by any type of object (such Particle Systems which stop emitting particles after a specific distance, Sound objects which only play sounds when within a distance, etc.) Automatic level of detail selection based on object size. Distances can be configured within a configuration file or updated dynamically.
- Space partitioning and paged loading of objects so that only objects that are within a partitioned distance are loaded. Example: Terrain pages, or other custom space partitioning schemes (imagine loading objects by room or sector in an indoor manager).
- Implementation of category browsing and object enumeration using a simple file system browser. By creating folders and placing .meta files in those folders which describe objects, the CoreGameObjectManager will return categories for the folders, and objects within the categories by searching the file system.
- Dynamic properties - the ability to assign properties within .meta files which are then automatically added to the property enumeration and are saved/loaded with the serialization system. This allows you to take an existing object type and add custom properties to it without creating a new object type, if desired. (An example would be to take the MarkerGameObject and use it for a custom purpose in your game, such as a player start point).
- Simulation start and end events which are passed down to all objects. This allows objects to know the difference between when they are being edited, versus when they are actually supposed to behave as real objects in-game. No one wants their explosive objects to explode in the editor and kill all the nearby NPCs, while you're still editing the world!
- StaticGeometry merging of entities.
Editor specific functionality is provided by exposing a set of functions in the GameObjectManager that may be used by an editor application. An example is a function which rotates a set of selected objects, called rotateObjects( vector<GameObject*>& objects, Radian rad, const Vector3& axis ). This function would be called by the editor, and internally the GameObjectManager determines the center of the objects and rotates them about their combined center by the rad amount, along the axis provided.
- Select multiple objects
- Move/rotate/delete multiple objects
- Link parent, unlink parent to create hierachies in the scene
- Ability to query an object manager for a list of available categories, and objects in each category, and an object factory system for creating objects based on the ID returned from one of the queries. Abstracted to allow an object manager to implement any type of mechanism for storing these objects, such as xml, file system, or database driven object storage. This is good for editor applications. Example, you can have a Meshes category, with Trees, Rocks, Folliage, Characters, etc. sub categories. The default implementation is to just use folders under the app directory, they are enumerated at runtime and displayed as categories. Objects are defined by creating .meta files in the folders (meta data description files) that describe your objects, including the object type, name, and default property values of your object. This functionality can be easily extended to have a data driven system from a database.
- Property enumeration functionality to query an object for properties and assign values to the properties. This is good for an editor application (such as the PLM2 MapEditor) which can modify properties on objects without needing to know anything about the object. An editor can enumerate available properties and display them in a dynamically created form, allowing you to define any properties you want and edit them in the editor. Supported types are currently: String, Float, Int, Vector, Boolean.
- Start Simulation/End Simulation allows objects to perform custom operations. Example, the particle system object doesn't actually emit particles until the Start Simulation button is clicked.
- MeshGameObject - an object that handles the loading of entities, including background thread loading of entities. Only loads the required entity based on the current level of detail. If a MeshGameObject is loaded and is far away from the camera, depending on its size it may either not load an entity at all, or load its lowest detail entity.
- ParticleSystemGameObject - a particle system which supports level of detail to only emit particle when the camera is close. Emits particles while in simulation mode.
- LightGameObject - supports any of the Ogre light types.
- SoundGameObject - supports playing a sound, and level of detail to only play sounds within a certain distance. Plays while in simulation mode.
- MarkerGameObject - a simple object that can be used in conjunction with dynamic properties for various game specific purposes.
- TreeGameObject - a special tree rendering object.
- Compound objects. Create a hierarchy of objects using the link functionality mentioned above, then save them out as a "Compound" object which can then be inserted as many times as you want with hierarchy intact. An example is a water fountain mesh with a particle system attached to it. Save it out as a Compound, then it becomes available as an insertable object.
A partitioning system allows arbitrary space partitioning. A GridPartitionManager is built into GOOF which performs grid based partitioning, and it is planned to create a interior partitions for dealing with room to room connections as well.
Player Movement, Collision Detection and Camera System
An ActorGameObject has been created which represents a character in the game and includes a movement and collision system. A mesh/mesh collision and player movement system has been implemented using OpCode, and a 3rd person camera has been created. This includes the ability to walk on the terrain, slide along walls, jump up on objects. This class will be improved upon, adding animation synching with actions.
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
- "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
- "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
- "Licensor" means the individual or entity that offers the Work under the terms of this License.
- "Original Author" means the individual or entity who created the Work.
- "Work" means the copyrightable work of authorship offered under the terms of this License.
- "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
- "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.
2. Fair Use Rights
Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.
3. License Grant
Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
- to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
- to create and reproduce Derivative Works;
- to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
- to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
- For the avoidance of doubt, where the work is a musical composition:
- Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
- Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
- Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).
The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.
The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
- You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
- You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
- If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.
5. Representations, Warranties and Disclaimer
UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
6. Limitation on Liability.
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
- This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
- Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
- Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
- Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
- If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
- No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
- This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.