Ragdoll Mayhem Maker - Game and Level Editor Tutorial

Player Guide

The objective of the game is to launch a ragdoll through a level, interacting with various physics objects to either reach a goal or accumulate points by colliding with objects.

Controls

• Up/Down Arrows: Increase or decrease the launch strength. The strength bar is shown in the top-left corner.
• Left/Right Arrows: Change the angle of the launch arrow.
• Z: Launch the ragdoll! This can only be done once at the start of the level.
• Escape: Open the in-game menu to reset the level or exit.

Game Elements

You will encounter many different objects in the game world:

• Goal: A green box. The level is won if the ragdoll stops completely inside it.
• Fans: These will blow your ragdoll in the direction they are pointing.
• Cogs & Saws: Moving hazards. Contact with them will add points, but they can also block your path.
• Bumpers: Circular, rectangular, or triangular objects that provide a strong bounce, adding points on impact.
• Bombs: Explode on contact, sending your ragdoll flying.
• Gravity Indicators: Touching these will reverse the world's gravity.
• Flippers: These are activated automatically on contact, sending your ragdoll flying, pinball-style!
• Trampolines: A bouncy platform that propels the ragdoll upwards.
• Escalators: A moving conveyor belt made of small spinning circles.

Level Editor Guide

This is where the real creativity happens. The level editor gives you direct access to the level's structure via a JSON (JavaScript Object Notation) file. You can create, modify, and place any object in the game.

The Editor Interface

When you open the editor, the screen is split into two parts:

1. The Level View (Left Side): A visual representation of your level. You can see the placement of all your objects here.
2. The JSON Editor (Right Side): A text editor where you define every element of your level in JSON format. This is where you'll do all your work.

At the bottom right, below the JSON editor, you will find "Save" and "Test" buttons.

• Save (Ctrl+S): Parses the JSON text and refreshes the Level View. If your JSON has errors, a message will appear.
• Test (Ctrl+T): Saves the level and immediately loads it in play mode for you to test. While testing, you can press 'B' to return to the editor.

The Anatomy of a Level File (JSON)

Every level is a single JSON file. The structure consists of an array [ ] containing a single object { }. Inside this object, you define key-value pairs for all the level's properties and objects.

[
  {
    "filename": "my-level.json",
    "points": 500,
    "ragdoll": [
      { "x": 100, "y": 100 }
    ],
    "walls": [
      { "width": 2000, "height": 1800 }
    ],
    "goal": [
      { "x": 1800, "y": 1600, "width": 200, "height": 200 }
    ]
    
    ... (other objects like blocks, saws, fans go here) ...
  }
]
        

Core Level Properties

These are the fundamental properties for any level.

Level Objects Reference

Here is a complete list of all objects you can add to your level. Each object type is a key whose value is an array of objects. You can add multiple objects of the same type.

Using External JSON Editors

While the in-game editor is functional, it's very basic. For a much better experience, we strongly recommend using an external code editor.

Why Use an External Editor?

• Syntax Highlighting: Makes the JSON structure much easier to read.
• Error Checking: Immediately shows you if you've missed a comma or a bracket.
• Auto-Formatting: Can automatically clean up the indentation and layout of your file.
• Find and Replace: Easily change multiple values at once.

Recommended Editors

Any modern text editor will work. Here are some excellent free options:

• Visual Studio Code
• Sublime Text
• Notepad++ (Windows only)

Workflow with an External Editor

1. Create a new level file in the game's root directory (e.g., my-cool-level.json). You can copy the contents of editor.json as a starting template.
2. Open this file in your external editor (like VS Code).
3. Make your changes and save the file.
4. In the game, go to the Main Menu and choose "(E)ditor Levels".
5. Select your new level from the list. It will now open in the in-game level editor.
6. From here, you can use the "Test" button to play it, or continue to make small tweaks in the in-game editor.