Flashlight exploration system for Ren'Py

Turn exploration into an interactive experience.

Flashlight Exploration System is a system designed for dark environments, exploration scenes and mystery/horror games.

Explore environments using a standard flashlight or UV light, discover clues and interact with objects directly inside the scene.

Main Features

Standard flashlight exploration
UV flashlight mode
Interactive clues and objects
Inventory system
Usable battery system
Easy to integrate and customize

The system is designed to serve as a foundation that you can adapt to your own environments, artwork and game mechanics.

Made for Ren'Py developers.

HOW TO USE IT

Inside the flashlightMinigame folder, you can find flashlight_example.rpy, which shows a simple example of how to use the system. There are three main functions:

• fm_new: creates and defines the scene.
• fm_define_item: defines an object that will be stored in the inventory once it is found.
• fm_add_pickup: adds the coordinates of the area where the object can be found.
• fm_count: Checks if the player has already found the object.
• After that just call the label 

Complete example:

label flashlight_example:

    $ fm_new("flashlightMinigame/assets/example_room.png", battery=78, protagonist="Alex")

    $ fm_define_item("old_key", "Rusty key", "An old key. It might open the wardrobe.", "flashlightMinigame/assets/old_key.png")

    $ fm_define_item("medicine", "Medicine bottle", "The contents still appear usable.", "flashlightMinigame/assets/medicine.png")

    $ fm_define_item("battery", "Battery", "Restores 35% of the flashlight charge.", "flashlightMinigame/assets/battery_item.png", use_kind="battery", power=35)

    $ fm_define_item("note", "Stained note", "Someone wrote a warning in a great hurry.", "flashlightMinigame/assets/note.png")

    $ fm_add_pickup("desk_key", (1090, 620, 245, 105), "old_key", sparkle=(1210, 665), popup_message="You found a rusty key inside the drawer.")

    $ fm_add_pickup("left_battery", (420, 610, 210, 170), "battery", sparkle=(540, 690), popup_message="You found a spare battery.")

    $ fm_add_pickup("wardrobe_battery", (1430, 470, 220, 310), "battery", sparkle=(1535, 620), popup_message="There was another battery behind the old clothes.")

    $ fm_add_pickup("medicine_box", (1080, 350, 260, 150), "medicine", sparkle=(1225, 420))

    $ fm_add_comment("crooked_picture", (930, 310, 115, 160), "That landscape... my mother had an identical one in the hallway.")

    $ fm_add_comment("boarded_window", (620, 190, 320, 390), "The boards were nailed from the inside. Whoever lived here did not want to leave.")

    $ fm_add_comment("old_clock", (1790, 205, 95, 140), "The clock stopped at 2:17. That does not seem like a coincidence.")

    $ fm_add_uv_clue("uv_warning", (860, 725, 330, 220), "Under UV light, footprints appear leading toward the wardrobe.", stain_pos=(850, 720))

    $ fm_add_uv_clue("wardrobe_uv_stains", (1430, 390, 300, 390), stain_image=Transform(FM_ASSET + "uv_stain.png", xysize=(350, 197)), stain_pos=(1400, 470))

    $ fm_add_pickup("hidden_note", (1500, 590, 190, 170), "note", light="uv", sparkle=(1595, 675), popup_message="You found a hidden note beside the wardrobe.")

    call screen flashlight_minigame

    if fm_count("old_key"):

        "You left the room with the rusty key."

    else:

        "You left the room without finding the key."

    return