{"id":2014,"date":"2019-12-10T17:05:12","date_gmt":"2019-12-10T16:05:12","guid":{"rendered":"https:\/\/www.codemotion.com\/magazine\/uncategorized\/game-unity3d-data-driven-modding\/"},"modified":"2020-01-21T23:49:54","modified_gmt":"2020-01-21T22:49:54","slug":"game-unity3d-data-driven-modding","status":"publish","type":"post","link":"https:\/\/www.codemotion.com\/magazine\/frontend\/gamedev\/game-unity3d-data-driven-modding\/","title":{"rendered":"How Unity3D and Data Driven Modding Created an Award Winning Urban Survival Game"},"content":{"rendered":"

If you dream of a better society, a computer game<\/span> about the reality of urban poverty and homelessness is just for you. It not only raising awareness of street life, but provides the opportunity for people to be a game content creator, at least for a day thanks to Unity3D<\/span>.\u00a0<\/p>\n

The survival game is called Hard Times<\/a> and was created by Ivan Preziosi<\/a>. He presented a talk this year at Codemotion Rome<\/a>, about the Data Driven Modding<\/strong> paradigm and how his game was created with Unity 3D<\/span><\/strong>.\u00a0<\/p>\n

The Opportunity of Developing With Unity3D<\/h2>\n

Unity3D<\/span> is a complete IDE<\/span> engine<\/span>, a development environment<\/span>, that you can try for free and is available for both MacOS and Windows<\/span>. It can deliver builds for all of the most popular gaming platforms.<\/em><\/p>\n

Hard Times is an urban survival computer game<\/span><\/strong>, where we are put in a homeless person’s shoes facing the brutal challenges of daily survival, made worse by an indifferent society and the frenetic pace of business life. The game invites us to reflect on the marginalization of poverty and feeling of indifference experienced by the homeless.<\/p>\n

\"inside<\/picture>\n
Hard Times developed with Unity3D<\/span><\/figcaption>\n<\/figure>\n

Ivan describes himself as a \u201chobbyist”, but he aims high, bringing his game beyond the borders of Italy<\/span>. He participates in many gaming events, arousing the interest of local institutions.\u00a0He has created a game with a strong social message, effective retro style graphics, and the possibility of future game extensions.<\/p>\n

The Architecture\u00a0<\/h3>\n

How can we become a game content creator? The secret is in how the game flow will be influenced by the data layer. Ivan chose the Data Driven Paradigm to model the game flow with a benefit: simplicity.\u00a0<\/p>\n

This allows us to modify and extend to the game only by writing some text file in a format: JSON<\/span>.\u00a0<\/p>\n

A paradigm can be described as a set of patterns and methods that are commonly accepted by members of a scientific community<\/span>.\u00a0<\/em><\/p>\n

Hard Times was envisioned from the beginning as a core moddable engine<\/span><\/strong> running a base default mod, called \u201cVanilla\u201d representing the base default gameplay<\/span>. This structure was designed to make possible the easy addition of more user generated content<\/span>, in the form of additional mod packages. Entities\u2019 behaviour and properties are then described using a relational data structure created on top of a JSON<\/span> file structure.\u00a0\u00a0<\/p>\n

JSON<\/span> is a human-readable data format that is used very much in REST<\/span> architectures for exchanging data between services that use the Internet<\/span>.\u00a0<\/em><\/p>\n

The Value of Data-Driven Modding<\/strong><\/h2>\n

At Codemotion Rome 2019 Ivan demonstrated how the game could be extended, with customisable content thanks to modding by anyyone, even if you aren’t an expert.\u00a0 He offered some insights into Data-Driven Modding, <\/strong>noting it is not his intention to get into the complexity of unnecessary software architectures.\u00a0<\/p>\n

The next step is the Functional-Driven Modding<\/strong>. Here, the game modifications are more complex than previously, because you have to get some minimum requirements, such as knowledge of some scripting language (JavaScript<\/span>, LUA, C, etc.).\u00a0<\/p>\n

Data Driven Programming is a paradigm software architecture where the data control the flow of the business logic<\/span>, only by changing the data-layer without touching the source code<\/span>.\u00a0<\/em><\/p>\n

Hard Times wants a society to be accessible to everyone<\/strong> regardless of money, gender or ability. Ivan wants a modding system more usable by the players<\/strong> and to transform them into creators of the game itself.\u00a0 Thanks to these design choices we get:\u00a0<\/p>\n

\u25cf EASY TO IMPLEMENT<\/u>: short, strategic steps;\u00a0<\/p>\n

\u25cf SECURITY<\/u>: the possibility of injecting malicious logic into\u00a0the source code<\/span> is avoided ;\u00a0<\/p>\n

\u25cf USE<\/u>: changing or adding original content to the game is a\u00a0simple operation without the need for advanced technical skills;\u00a0<\/p>\n

\u25cf ZERO ENVIRONMENT<\/u>: the system is based on .json<\/span>, .png and .ogg\u00a0 files, a notepad and free editors like Gimp or Audacity are enough;\u00a0<\/p>\n

\u25cf DISTRIBUTION<\/u>: mods are auto contained in a\u00a0zip.\u00a0<\/p>\n

Implementation\u00a0<\/h2>\n

Hard Times uses the Full Serializer library, a more powerful tool than the built-in serializer code in C#.\u00a0<\/p>\n

In Ivan’s design, each game entity which has an effect on our player stats is mediated by a \u201cplayer effect\u201d<\/strong>, a json described entity, who will directly affect character\u2019s stats, such as stamina, life, hunger or smell. This makes it possible to extend and create new player effects in order to modify the behaviour of any given game entity.<\/p>\n

To create a change, we must respect the conventions of the structure of our folders, files and JSON<\/span> themselves.<\/p>\n

\"Schema<\/picture>\n
An example of JSON<\/span> file with relations<\/figcaption>\n<\/figure>\n

Each object has an \u201cid\u201d (identification like relation id table) reference just like an entity of a relational database, allowing us to define game mechanics and relationships between all the various game entities.\u00a0<\/p>\n

The various entities of the game (items, furniture, doors, scenes, etc.) each have a Manager class that will handle the creation and modification of the relevant data structure (resembling the organisation of tables in a database).\u00a0<\/p>\n

Data loading order is important due to Hard Times’ additive approach<\/strong>, where the data contained in the JSON<\/span> – when possible – is merged with that previously loaded<\/strong>.\u00a0<\/p>\n

\"Schema<\/picture>\n
Mod Engine<\/span> \u2013 How module loaded at game bootstrap<\/figcaption>\n<\/figure>\n
\"Schema<\/picture>\n
Mod Engine<\/span> \u2013 Additive module loading phase<\/figcaption>\n<\/figure>\n

For game dynamics in which control must be predictable<\/strong> and not lead to anomalies, such as the control of weather, Ivan instead opted for the substitute<\/strong> approach. In this case, we would not have an additive behaviour, but a complete replacement of the properties.\u00a0<\/p>\n

\"Schema<\/picture>\n
Mod Engine<\/span> \u2013 Substitute module loading phase<\/figcaption>\n<\/figure>\n

The Steps to Publishing<\/h2>\n

Mods publishing and distribution, between creators and users, need an appropriate platform. There are various free solutions for the distribution of your code, each with their own characteristics and potential pitfalls (such as the security of the uploaded material).\u00a0<\/p>\n

While more tailored adhoc solutions are possible, they require time, money and extensive experience to manage problems related to:\u00a0<\/p>\n

    \n
  • Security;\u00a0<\/li>\n
  • API additions;\u00a0<\/li>\n
  • Data processing.\u00a0<\/li>\n<\/ul>\n

    With limited resources and time, you should rely on a mod repository service such as:\u00a0<\/p>\n

      \n
    • Steam;\u00a0<\/li>\n
    • Mod.io;\u00a0<\/li>\n
    • ModDB.\u00a0<\/li>\n<\/ul>\n

      In conclusion, with thoughtful design and software choices, it is possible to create easily moddable video games using Unity3D, which enjoy an extended lifespan, a more active and committed community<\/span> and the possibility to benefit from final users\u2019 creativity and talent, providing a creative and rewarding experience which goes far from the simple work initially developed by the game creator.<\/p>\n

      Hard Times was selected as an Indie Prize Finalist at Codemotion Rome 2019 and earned a dev scholarship to fly to the GameDaily Connect 2019 in Los Angeles to showcase among other finalists from all over the world.<\/em><\/p>\n