Lightning Talk: JSON Schema

by Enrico Teotti

In this Lightning Talk presented at the Rocky Mountain Ruby 2013 event, Enrico Teotti discusses a project centered around creating a gaming framework designed specifically for memory games. The talk explores how the challenges set by game designers, who were accustomed to using scripting languages, were addressed using JSON Schema. Teotti outlines several key points regarding the project and the implementation of JSON Schema.

Key Points Discussed:

Introduction to JSON Schema: Teotti highlights the significance of JSON Schema, which allows for the definition of a JSON format description, making it easier for game designers to specify their requirements and input necessary data efficiently.
Data Structuring: Initially, the team considered using database tables for data organization but found JSON Schema to be a more suitable solution for their needs.
Implementation: They created an application using Sinatra that enabled intuitive data entry through a simple web form. This included setting parameters like game modes and frame rates.
Integration with Ruby: The game logic was facilitated by the Oxford JSON Schema gem for Ruby, which is recommended due to its current updates and better documentation compared to alternatives like Google's JSON Schema library.
Client-Side Applications: Additionally, the integration of Open Document General Schema was mentioned, which allows a corresponding JavaScript library to consume the same schema, enhancing versatility in development.
Real-World Example: Teotti presented a JSON Schema example called 'Mirror,' which specifies game channels and modes, demonstrating how structured documents are created to provide messages based on defined properties and constraints.

Conclusion and Takeaways:

Teotti's talk emphasizes the utility of JSON Schema in efficiently structuring game design data for better integration with client-side frameworks. He expresses hope that attendees may find this approach beneficial for their future projects, particularly in gaming or similar fields. Overall, the session underscores the importance of using effective data modeling techniques to fulfill design requirements in software development.

00:00:00.480 Hello everyone, I am Enrico Teotti, and I'm excited to be here today.

00:00:09.559 I’m going to talk about a project I worked on, where we built a gaming framework specifically for memory games. We had to address the requirements set by the game designers, who were accustomed to using scripting languages.

00:00:17.340 To facilitate this, we needed to create a system that allowed them to input all the necessary data, which would then be processed by a client-side gaming framework. Initially, we considered structuring this data within database tables, but we then discovered JSON Schema.

00:00:34.980 How many of you have already used JSON Schema? Can you please raise your hand? Not too many. The speaker before me briefly mentioned what JSON Schema is. JSON Schema allows you to define a JSON description of your data format. This meant our game designer could specify their requirements, and we could create an interface to help them enter this data efficiently.

00:01:07.140 For instance, we implemented a simple system where a game mode and frame rate could be set within a form. This is part of the Sinatra application that handled the data via parameters.

00:01:29.880 The game logic utilizes one of the available JSON Schema gems for Ruby, Oxford JSON Schema. There are two prominent options, and while the other is from Google, it lacks sufficient documentation, so I wouldn't recommend using it. Oxford JSON Schema is more current and has recently released updates associated with JSON Schema revisions.

00:01:41.759 Moreover, Open Document General Schema is also implemented client-side, allowing you to use a corresponding JavaScript library to consume the same schema. It’s quite a versatile solution.

00:02:08.300 To conclude, I want to quickly show you a real-world example. This is a JSON Schema that specifies the channels and game modes of the game. The example is called 'Mirror,' and it demonstrates how to create structured documents effectively.

00:02:35.040 Essentially, it provides messages based on the properties you define as constraints. I hope some of you will find this useful in your future projects. That’s all from me.

00:03:08.300 Thank you for your attention.