{"id":1840,"date":"2019-11-27T19:19:09","date_gmt":"2019-11-27T18:19:09","guid":{"rendered":"https:\/\/www.codemotion.com\/magazine\/uncategorized\/making-of-sandox-the-cryengine-game-editor\/"},"modified":"2020-01-10T16:16:20","modified_gmt":"2020-01-10T15:16:20","slug":"making-of-sandox-the-cryengine-game-editor","status":"publish","type":"post","link":"https:\/\/www.codemotion.com\/magazine\/frontend\/gamedev\/making-of-sandox-the-cryengine-game-editor\/","title":{"rendered":"Making of Sandox, the Cryengine Game Editor"},"content":{"rendered":"\n

If you are a game developer<\/span><\/strong>, you are probably aware that there are many game engines<\/span><\/strong> out there. However, only a few of them made the history of game development<\/span>. Among them, there are software<\/span> like Unreal Engine<\/span>, Unity<\/span> or Source Engine<\/span> that have been used in a plethora of games. Another great game engine<\/span> is Cryengine<\/span><\/strong>, developed<\/span> by Crytek<\/span> and used for the development of a great video game<\/span> like Far Cry<\/span> and Crysis<\/span>.<\/p>\n\n\n\n

While the game engine<\/span> is one of the most important components, developing<\/span> good games also requires proper tools and, in particular, game editors have a crucial role. During Codemotion Rome 2019<\/strong>, Alessandro Osima<\/strong>, Tools Engineer at Crytek<\/span>, delivered a speech about the development of Sandbox<\/span><\/strong>, the game editor for Cryengine<\/span>. In this article we will provide an overview about such a game editor, starting from the history of its development and highlighting some of the crucial choices taken by the Sandbox<\/span> development team, based on the story narrated by Osima during his talk.<\/p>\n\n\n\n

Overview of Sandbox<\/h2>\n\n\n\n

Sandbox<\/span> was originally created<\/span> 15 years ago, with the specific goal of supporting the development of Far Cry<\/span>. From its origin, it has continuously evolved and many games were created<\/span> with it, ranging from Crysis<\/span><\/strong> to VR games such as The Climb<\/strong>.<\/p>\n\n\n\n

As with many other game editors, Sandbox<\/span> is coded mostly in C++<\/span><\/strong> and offers a set of WYSIWYG<\/span> tools like material editor<\/strong>, trackview<\/strong> (used to create cutscenes), particle editor<\/strong> and many others. In addition to this, Sandbox<\/span> also offers an extensive set of Python<\/span> bindings<\/strong> that tech artists can use to script<\/span> simple tools.<\/p>\n\n\n\n

In general, every tool that is included in Sandbox<\/span> is actually a plugin<\/span>, making such an editor highly modular<\/strong>. The Core API<\/span> implements basic things like Asset Management, Windowing, Serialization and Plugin Management. Then, at startup, the engine<\/span> loads all the plugins. This design choice allow developers and game teams to easily create their own plugins, with an extremely flexible approach<\/strong>.<\/p>\n\n\n\n

Sandbox<\/span> is available along with Cryengine<\/span> from the official website<\/a><\/u>, where you can find both the executable files (for Windows<\/span> 64-bit and 32-bit) and the full source code<\/span>.<\/p>\n\n\n\n

\"\"\/<\/figure><\/div>\n\n\n\n

Development of Sandbox<\/h3>\n\n\n\n

During his talk, Osima discussed how Sandbox<\/span> has been developed, starting from the first publicly available version of it, released in 2004. As already stated, it was developed in C++, based on the Microsoft Foundation Classes<\/span><\/strong> (MFC<\/span><\/strong>), forming a simple, monolithic level editor with basic tools. In this first release, the game engine<\/span>, the editor and the game code were all in the same directory tree.<\/p>\n\n\n\n

\"\"\/<\/figure><\/div>\n\n\n\n

After the success of Far Cry, Cryengine<\/span> was significantly revised and readapted for Crysis. New tools were added, including primitive versions of the material editor, flowgraph, trackview and character editor. All these tools proved to be extremely useful to support designers and developers working on Crysis.<\/p>\n\n\n\n

\"\"\/<\/figure><\/div>\n\n\n\n

From Crysis 2<\/span> onward, Sandbox<\/span> was available only as a modding tool for Crysis and Far Cry. We had to wait until 2011, when a free SDK for non-commercial games was released<\/strong> by Crytek<\/span>.<\/p>\n\n\n\n

The development model was based on improving on the previous version of the game editor (as well as the engine<\/span>) and kept going on through many games.<\/p>\n\n\n\n

\"\"\/<\/figure><\/div>\n\n\n\n

By the end of the development cycle that ended with the release of Cryengine<\/span> 3, the Sandbox<\/span> team started focusing on the main critical issues to be improved. They thus identified two main areas of improvement:<\/p>\n\n\n\n

  • User Experience<\/strong> (UX<\/strong>): the team noted a quite steep learning curve<\/strong>, due to difficulties in following the workflow<\/li>
  • API<\/strong>: due to the growth of tools, API did not scale. The consequence was low stability<\/strong>, performance<\/strong> issues and also some inconsistent data handling, resulting in fragmented tools development over the years<\/li><\/ul>\n\n\n\n

    To address these issues, Osima explained that the first main choice was to focus on UX, by introducing a new UX-driven development process<\/strong>. It consisted of translating any request for a new feature or improvement in a short-term or long-term development task. Then, a UX<\/span> team evaluates potential solutions to the described problem, designing them and finally transferring them to the development team.<\/p>\n\n\n\n

    The second fundamental choice was to update the UI<\/span><\/strong>. The main problems derived from Microsoft\u2019s choice of not developing MFC<\/span> anymore. Moreover, MFC<\/span> was complicated to programme and did not lead to consistent visual appearance. Finally, MFC<\/span> only allows us to develop applications<\/span> for Windows<\/span>, which translates into a significant difficulty in supporting an eventual cross-platform<\/span> implementation of Sandbox<\/span>.<\/p>\n\n\n\n

    On the other hand, MFC<\/span> was performant and could handle lots of data<\/span>. It also provides many assets and widgets, which make it extensible and stylable.<\/p>\n\n\n\n

    The solution tackled by the Sandbox<\/span> team was to opt for Qt<\/span><\/strong>, one of the most common open source<\/span> C++<\/span> frameworks for GUI<\/span> development. Qt<\/span> is indeed a modern and multiplatform<\/span> framework, easier than MFC<\/span>, as well as very well documented and widely used in many applications<\/span>. In addition, the team<\/span> also developed<\/span> a MFCToolsPlugin<\/strong>, aimed at supporting tools already developed<\/span> with MFC<\/span>. This choice was crucial in order to support an incremental switch<\/span> from MFC<\/span> to Qt<\/span><\/strong>. For instance, the material editor is still written in MFC<\/span>, and has been included in Cryengine<\/span> V, thanks to the MFCToolsPlugin, thus being embedded in a Qt<\/span> window.<\/p>\n\n\n\n

    \"\"\/<\/figure><\/div>\n\n\n\n

    Takeaways<\/h2>\n\n\n\n

    The current versions of Cryengine<\/span> and Sandbox<\/span> are embedding the results of all the aforementioned design choices. Analysing them in the context of the development process<\/span> is useful to illustrate how such big projects are managed. Two aspects are particularly interesting here. First, incorporating UX<\/span> evaluation in the development process<\/span><\/strong> allows us to include developers<\/span>\u2019 preferences in identifying new features and required improvements, which can significantly reduce the gradient of the learning curve, thus easing game development<\/span>. Second, using a modern UI<\/span> framework<\/strong> might be not enough; something that is good today may become obsolete after one, two or three years. The crucial choice is not just in the ability of replacing obsolete components<\/span>, but in doing it by allowing incremental transitions<\/strong> between old and new components<\/span>. The development of the MFCToolsPlugin is a great example of this, representing a winning choice for the Sandbox development team.<\/p>\n\n\n\n