Skip to main content

Introduction

What is Yumon?​

Yumon is creating a network of competitive games where players enjoy ad-free sessions while progressing across the games and competing against each other to earn real-life rewards. As a studio, create your core gameplay with our turnkey solutions and publish it within our game network, making it available to 500k+ competitive MAU.

Our pioneering game, Chill Ride, was developed using the comprehensive Yumon Template, fully featured for our competitive gaming network with social login, leaderboard systems, real-life rewards, and more. Given the complexity of these features and their reliance on our backend services, we've crafted a lightweight version for simpler integration of your core gameplay - The Yumon Lite Template.

Yumon Lite Template​

The Yumon Lite Template simplifies your pathway to Yumon. It retains the essential game loop structure and event requirements of the full Yumon Template without the weightier features to ease your development journey and focus on your core gameplay.

Please note that full-feature testing isn't possible with the Lite Template. But don't worry, the Yumon team will handle the integration with the full template. Your role is to implement the required events and methods, and we'll ensure your gameplay flawlessly fits within the comprehensive framework.

Key Terms​

Before delving into your objectives and the specifics of the Yumon Lite Template, let's familiarize ourselves with some key terms and concepts used throughout this document:

States​

  1. Gameplay: This is the state during which the player engages with the core gameplay. This state begins when the OnLevelStart event is raised and ends when the EndLevel() method is called.
  2. End Game: This is the state following the completion of a gameplay session. It begins when the OnLevelEnd event is raised.
  3. Home: This is the default state of the game, showcasing the home screen. It begins when the OnReturnToHome event is raised.

Events​

  1. OnLevelStart: This event is triggered to signify the beginning of the Gameplay state.
  2. OnLevelEnd: This event is triggered to signify the beginning of the End Game state.
  3. OnReturnToHome: This event is triggered to signify the beginning of the Home state.

Methods​

  1. EndLevel(): The method you will call to end a gameplay session and transition to the End Game state.

Your Objective​

Your primary objective is to focus on developing and integrating your game's core gameplay within the Yumon Lite Template. Your core gameplay should operate seamlessly within the "Gameplay" state of the game loop structure, adhering to the event and method requirements outlined in this documentation.

Here are the key areas you should concentrate on:

  1. Core Gameplay: Your primary task is to develop an engaging and fun core gameplay. This includes creating game mechanics, character behaviors, scoring system, and level design. Your core gameplay mechanics should come to life when the OnLevelStart event is raised and ends when you call the EndLevel() method.
  2. End Game Feedback: While the "End Game" state is primarily handled by the Yumon team, you can contribute by implementing gameplay-specific feedbacks (such as animations or special effects) when the OnLevelEnd event is raised (by the EndLevel() method).
  3. Game Reset: When the OnReturnToHome event is raised, you need to ensure that all game components return to their initial states, ready for the next session. Note that the scene is not reloaded, so you should handle this manually.

Your focus should remain on the Gameplay and, to some extent, the End Game states. UI or logic for the Home and End Game states are managed by the Yumon team and not your responsibility. The Sample Scene provided in this template is basic but enough to mimic the full template’s structure.

By using our template, you can focus on what you do best: create an exciting gaming experience, and enjoy a robust competitive gaming framework ready to use. Let's work together to make this happen!