Home Docs Rating

Rating Input

Collect numeric ratings from 1 to 5.

Overview

The rating field type allows players to provide a numeric score on a 1-5 scale. This is perfect for quantifying player satisfaction and preferences.

Best for: Overall game satisfaction, feature ratings, difficulty assessment, or any metric that benefits from a 1-5 star scale.

Field Structure

key
string required

Unique identifier for this field.

label
string required

Display label shown to the player.

type
string required

Must be set to rating

value
number required

Numeric rating value. Must be an integer between 1 and 5 (inclusive).

Rating Scale

The rating scale is designed to be intuitive and familiar to players:

⭐ 1 Poor - Significant issues
⭐⭐ 2 Below Average - Some problems
⭐⭐⭐ 3 Average - Acceptable
⭐⭐⭐⭐ 4 Good - Enjoyable
⭐⭐⭐⭐⭐ 5 Excellent - Outstanding

Example

{
  "key": "overall_rating",
  "label": "How would you rate your overall experience?",
  "type": "rating",
  "value": 5
}

Additional Examples

Graphics Quality

{
  "key": "graphics_rating",
  "label": "Rate the graphics quality",
  "type": "rating",
  "value": 4
}

Difficulty Balance

{
  "key": "difficulty_rating",
  "label": "How well balanced was the difficulty?",
  "type": "rating",
  "value": 3
}

Story Engagement

{
  "key": "story_rating",
  "label": "How engaging was the story?",
  "type": "rating",
  "value": 5
}

Performance

{
  "key": "performance_rating",
  "label": "Rate the game's performance (FPS, loading times)",
  "type": "rating",
  "value": 2
}

Validation Rules

  • Value must be numeric
  • Value must be an integer (whole number)
  • Minimum value: 1
  • Maximum value: 5
  • Decimal values are not allowed (e.g., 3.5 is invalid)
  • Cannot be null or undefined

Common Mistakes: Values like 0, 6, or 3.5 will be rejected. Only integers from 1 to 5 are valid.

Common Use Cases

Overall Satisfaction

Rate overall game experience, enjoyment level, or likelihood to recommend.

Visual & Audio

Graphics quality, art style, sound design, or music quality ratings.

Gameplay Elements

Controls, difficulty balance, level design, or specific feature ratings.

Technical Performance

Frame rate, loading times, stability, or optimization quality.

Why Use Ratings?

Rating fields provide valuable quantifiable data that makes it easy to:

  • Track trends: Monitor how ratings change over time or across game updates
  • Calculate averages: Get quick insights into overall player satisfaction
  • Compare features: See which aspects of your game are performing best
  • Identify issues: Low ratings can highlight areas needing improvement
  • Measure impact: Assess whether changes improved player experience
Previous
Checkbox