Save-Point - HiddenChest (RGSS1-3) Engine

KChangeKeys HC

Sat, 10 Jan 2026 11:04:25 +0000

KChangeKeys HC

by Kyonides

Introduction

Usually, a typical RM game would only let you change your key mappings via pressing the F1 button, and then you would be able to pick a few options for a minimal set of virtual buttons like A or C or R. Later on, mkxp let you set up to 4 different keys for a single target button. These keys can be actual keys or gamepad's buttons or axes or hats. None of those menus look very eye-catching, do they?

Now KChangeKeys HC for HiddenChest version 1.2.06 or higher is a real game changer. Now you CAN CHANGE your key bindings at will using this relatively simple script! Just keep pressing keys or buttons to get impressed by it!

Screenshots

Script for RMXP

Code:
# * KChangeKeys HC for XP * #

#   Scripter : Kyonides

#   2026-01-11

# * This scripts depends on HiddenChest v1.2.06 or higher. * #

# With this scriptlet you are now able to change the keys that are normally

# mapped to any of RMXP's default buttons like A, B, C, etc. without pressing

# the F1, F2 & F12 buttons!

# * Script Call * #

# $scene = KChangeKeys::Scene.new

module KChangeKeys

  BACKDROP = "dwarven mine"

  HELP_BAR = "help bar"

  TARGET_BOX = "target box"

  CURSOR = "cursor"

  HEADING = "Key Bindings"

  CHOOSE_KEY = "Please select a key to edit"

  ENTER_KEY = "Please enter a key now"

# These are the default virtual buttons' names the RM editors have always used,

# but feel free to change them if ever needed.

  TARGETS = %w{Up Down L L2 Left Right R R2 A B C X Y Z}

class Scene

  def main

    setup

    create_sprites

    Graphics.transition

    while @stage

      Graphics.update

      Input.update

      update

    end

    Graphics.freeze

    terminate

  end

  def setup

    Font.default_outline = true

    @stage = :main

    @index = 0

    @col_index = 0

    @gamepad = Input.gamepad

    @bindings = Input.bindings

    @list = @bindings.list

    @target_names = []

    @bind_names = []

    @binds = []

    @key_names = []

    @changes = []

    @sprites = []

    case Graphics.width

    when 544

      @rows = 1

    when 640

      @rows = 2

    when 800

      @rows = 3

    else

      @rows = 4

    end

    @list.each {|bg| @binds += bg.data.take(@rows) }

    @key_names = @binds.map {|b| b.name || "" }

    @init_names = @key_names.dup

    @temp_names = @key_names.dup

    @back_color = Color.new(0, 0, 0, 120)

    @target_color = Color.new(255, 200, 80)

  end

  def create_sprites

    gw = Graphics.width

    fn = BACKDROP + gw.to_s

    @backdrop = Sprite.new

    @backdrop.bitmap = RPG::Cache.title(fn).dup

    b = Bitmap.new(gw, 48)

    b.font.size = 32

    b.draw_text(:rect, HEADING, 1)

    @heading = Sprite.new

    @heading.y = 4

    @heading.bitmap = b

    b = RPG::Cache.picture(HELP_BAR)

    bx = (gw - b.width) / 2

    @help_backdrop = Sprite.new

    @help_backdrop.set_xy(bx, 60)

    @help_backdrop.bitmap = b

    @help_bit = Bitmap.new(gw, 32)

    @help_bit.font.size = 24

    @help_bit.draw_text(:rect, CHOOSE_KEY, 1)

    @help = Sprite.new

    @help.y = 60

    @help.z = 20

    @help.bitmap = @help_bit

    @cursor = Sprite.new

    @cursor.z = 10

    @cursor.bitmap = RPG::Cache.picture(CURSOR)

    sw = gw / 206

    ix = (gw - sw * 206) / 2

    b = RPG::Cache.picture(TARGET_BOX)

    @key_max = TARGETS.size

    @key_max.times do |n|

      sx = ix + n % sw * 206

      sy = 108 + n / sw * @rows * 32

      @backdrop.bitmap.blt(sx + 2, sy - 2, b, b.rect)

      s = Sprite.new

      s.set_xyz(sx, sy, 20)

      s.bitmap = Bitmap.new(80, 28)

      s.bitmap.font.color = @target_color

      s.bitmap.draw_text(:rect, TARGETS[n], 1)

      @target_names << s

      @rows.times {|i| create_button_box(sx + 84, sy + i * 32) }

    end

    s = @bind_names[0]

    @cursor.set_xy(s.x - 4, s.y - 2)

    b.dispose

    @sprites += @target_names + @bind_names

    @sprites += [@heading, @help, @cursor, @help_backdrop, @backdrop]

  end

  def create_button_box(sx, sy)

    name = @temp_names.shift

    s = Sprite.new

    s.set_xyz(sx, sy, 20)

    b = Bitmap.new(112, 28)

    b.draw_text(:rect, name, 1)

    s.bitmap = b

    @bind_names << s

    rect = b.rect.dup

    rect.x = sx

    rect.y = sy

    @backdrop.bitmap.fill_rect(rect, @back_color)

  end

  def terminate

    @sprites.each do |s|

      s.bitmap.dispose

      s.dispose

    end

    @changes = @changes.flatten.compact

    return if @changes.empty?

    Input.save_key_bindings

  end

  def update

    case @stage

    when :main

      update_main

    when :key

      update_key

    end

  end

  def box_index

    @index * @rows + @col_index

  end

  def update_main

    if Input.trigger?(:B)

      $game_system.se_play($data_system.cancel_se)

      $scene = Scene_Map.new

      return @stage = nil

    elsif Input.trigger?(:Up)

      update_cursor(0, -1)

      return

    elsif Input.trigger?(:Down)

      update_cursor(0, 1)

      return

    elsif Input.trigger?(:Left)

      update_cursor(-1, 0)

      return

    elsif Input.trigger?(:Right)

      update_cursor(1, 0)

      return

    elsif Input.trigger?(:Delete)

      $game_system.se_play($data_system.buzzer_se)

      n = box_index

      bind = @binds[n]

      bind.value = 0

      @key_names[n] = ""

      b = @bind_names[n].bitmap

      b.clear

      b.draw_text(:rect, "", 1)

      @changes[n] = true

      return

    elsif Input.trigger?(:C)

      $game_system.se_play($data_system.decision_se)

      Input.keymap_mode!

      Input.update

      n = box_index

      @bind = @binds[n]

      @help_bit.clear

      @help_bit.draw_text(:rect, ENTER_KEY, 1)

      @bind_bit = @bind_names[n].bitmap

      @bind_bit.clear

      @stage = :key

    end

  end

  def update_cursor(m, n)

    $game_system.se_play($data_system.cursor_se)

    @index = (@index + m) % @key_max

    @col_index = (@col_index + n) % @rows

    s = @bind_names[box_index]

    @cursor.set_xy(s.x - 4, s.y - 2)

  end

  def reset_help

    Input.play_mode!

    Input.update

    @bind_bit = @bind = nil

    @help_bit.clear

    @help_bit.draw_text(:rect, CHOOSE_KEY, 1)

    @stage = :main

  end

  def update_key

    if Input.trigger?(:MouseRight)

      $game_system.se_play($data_system.cancel_se)

      name = @key_names[box_index]

      @bind_bit.draw_text(:rect, name, 1)

      reset_help

      return

    elsif Input.trigger_any?

      $game_system.se_play($data_system.decision_se)

      case Input.trigger_type

      when 0

        @bind.value = 0

      when 1

        @bind.value = Input.trigger_last

      else

        @bind.value = Input.trigger_gp_value

      end

      n = box_index

      name = @bind.name

      @key_names[n] = name

      @bind_bit.clear

      @bind_bit.draw_text(:rect, name, 1)

      reset_help

      @changes[n] = true

    end

  end

end

end

Script for RMVX & VX ACE

Code:
# * KChangeKeys HC for VX + ACE * #

#   Scripter : Kyonides

#   2026-01-11

# * This scripts depends on HiddenChest v1.2.06 or higher. * #

# With this scriptlet you are now able to change the keys that are normally

# mapped to any of RMXP's default buttons like A, B, C, etc. without pressing

# the F1, F2 & F12 buttons!

# For VX:

# $scene = KChangeKeys::Scene.new

# For VX ACE:

# SceneManager.call(KChangeKeys::Scene)

module KChangeKeys

  BACKDROP = "dwarven mine"

  HELP_BAR = "help bar"

  TARGET_BOX = "target box"

  CURSOR = "cursor"

  HEADING = "Key Bindings"

  CHOOSE_KEY = "Please select a key to edit"

  ENTER_KEY = "Please enter a key now"

# These are the default virtual buttons' names the RM editors have always used,

# but feel free to change them if ever needed.

  TARGETS = %w{Up Down L L2 Left Right R R2 A B C X Y Z}

class Scene

  def main

    setup

    create_sprites

    Graphics.transition

    while @stage

      Graphics.update

      Input.update

      update

    end

    Graphics.freeze

    terminate

  end

  def setup

    @vx_ace = Game::RGSS_VERSION == 3

    Font.default_outline = true

    @stage = :main

    @index = 0

    @col_index = 0

    @gamepad = Input.gamepad

    @bindings = Input.bindings

    @list = @bindings.list

    @target_names = []

    @bind_names = []

    @binds = []

    @key_names = []

    @changes = []

    @sprites = []

    case Graphics.width

    when 544

      @rows = 1

    when 640

      @rows = 2

    when 800

      @rows = 3

    else

      @rows = 4

    end

    @list.each {|bg| @binds += bg.data.take(@rows) }

    @key_names = @binds.map {|b| b.name || "" }

    @init_names = @key_names.dup

    @temp_names = @key_names.dup

    @back_color = Color.new(0, 0, 0, 120)

    @target_color = Color.new(255, 200, 80)

  end

  def create_sprites

    gw = Graphics.width

    fn = BACKDROP + gw.to_s

    @backdrop = Sprite.new

    @backdrop.bitmap = Cache.system(fn).dup

    b = Bitmap.new(Graphics.width, 48)

    b.font.size = 32

    b.draw_text(:rect, HEADING, 1)

    @heading = Sprite.new

    @heading.y = 4

    @heading.bitmap = b

    b = Cache.picture(HELP_BAR)

    bx = (gw - b.width) / 2

    @help_backdrop = Sprite.new

    @help_backdrop.set_xy(bx, 60)

    @help_backdrop.bitmap = b

    @help_bit = Bitmap.new(gw, 32)

    @help_bit.font.size = 24

    @help_bit.draw_text(:rect, CHOOSE_KEY, 1)

    @help = Sprite.new

    @help.y = 60

    @help.z = 20

    @help.bitmap = @help_bit

    @cursor = Sprite.new

    @cursor.z = 10

    @cursor.bitmap = Cache.picture(CURSOR)

    sw = gw / 206

    ix = (gw - sw * 206) / 2

    b = Cache.picture(TARGET_BOX)

    @key_max = TARGETS.size

    @key_max.times do |n|

      sx = ix + n % sw * 206

      sy = 108 + n / sw * @rows * 32

      @backdrop.bitmap.blt(sx + 2, sy - 2, b, b.rect)

      s = Sprite.new

      s.set_xyz(sx, sy, 20)

      s.bitmap = Bitmap.new(80, 28)

      s.bitmap.font.color = @target_color

      s.bitmap.draw_text(:rect, TARGETS[n], 1)

      @target_names << s

      @rows.times {|i| create_button_box(sx + 84, sy + i * 32) }

    end

    s = @bind_names[0]

    @cursor.set_xy(s.x - 4, s.y - 2)

    b.dispose

    @sprites += @target_names + @bind_names

    @sprites += [@heading, @help, @cursor, @help_backdrop, @backdrop]

  end

  def create_button_box(sx, sy)

    name = @temp_names.shift

    s = Sprite.new

    s.set_xyz(sx, sy, 20)

    b = Bitmap.new(112, 28)

    b.draw_text(:rect, name, 1)

    s.bitmap = b

    @bind_names << s

    rect = b.rect.dup

    rect.x = sx

    rect.y = sy

    @backdrop.bitmap.fill_rect(rect, @back_color)

  end

  def terminate

    @sprites.each do |s|

      s.bitmap.dispose

      s.dispose

    end

    @changes = @changes.flatten.compact

    return if @changes.empty?

    Input.save_key_bindings

  end

  def update

    case @stage

    when :main

      update_main

    when :key

      update_key

    end

  end

  def box_index

    @index * @rows + @col_index

  end

  def update_main

    if Input.trigger?(:B)

      Sound.play_cancel

      $scene = Scene_Map.new

      return @stage = nil

    elsif Input.trigger?(:Up)

      update_cursor(0, -1)

      return

    elsif Input.trigger?(:Down)

      update_cursor(0, 1)

      return

    elsif Input.trigger?(:Left)

      update_cursor(-1, 0)

      return

    elsif Input.trigger?(:Right)

      update_cursor(1, 0)

      return

    elsif Input.trigger?(:Delete)

      Sound.play_buzzer

      n = box_index

      bind = @binds[n]

      bind.value = 0

      @key_names[n] = ""

      b = @bind_names[n].bitmap

      b.clear

      b.draw_text(:rect, "", 1)

      @changes[n] = true

      return

    elsif Input.trigger?(:C)

      @vx_ace ? Sound.play_ok : Sound.play_decision

      Input.keymap_mode!

      Input.update

      n = box_index

      @bind = @binds[n]

      @help_bit.clear

      @help_bit.draw_text(:rect, ENTER_KEY, 1)

      @bind_bit = @bind_names[n].bitmap

      @bind_bit.clear

      @stage = :key

    end

  end

  def update_cursor(m, n)

    Sound.play_cursor

    @index = (@index + m) % @key_max

    @col_index = (@col_index + n) % @rows

    s = @bind_names[box_index]

    @cursor.set_xy(s.x - 4, s.y - 2)

  end

  def reset_help

    Input.play_mode!

    Input.update

    @bind_bit = @bind = nil

    @help_bit.clear

    @help_bit.draw_text(:rect, CHOOSE_KEY, 1)

    @stage = :main

  end

  def update_key

    if Input.trigger?(:MouseRight)

      Sound.play_cancel

      name = @key_names[box_index]

      @bind_bit.draw_text(:rect, name, 1)

      reset_help

      return

    elsif Input.trigger_any?

      @vx_ace ? Sound.play_ok : Sound.play_decision

      case Input.trigger_type

      when 0

        @bind.value = 0

      when 1

        @bind.value = Input.trigger_last

      else

        @bind.value = Input.trigger_gp_value

      end

      n = box_index

      name = @bind.name

      @key_names[n] = name

      @bind_bit.clear

      @bind_bit.draw_text(:rect, name, 1)

      reset_help

      @changes[n] = true

    end

  end

end

end

KEnterText HC

Wed, 10 Dec 2025 00:27:27 +0000

KEnterText HC

by Kyonides

Introduction

Ever since HiddenChest version 1.1.98 was released, game developers are now able to implement a very simple text input interface in their games.
It heavily depends on the new additions to the Input module to make it work normally.

kyonides Wrote:Running HiddenChest version 1.1.99 is HIGHLY recommended here.

The CapsLock and Shift keys DO alter the outcome while typing a text.

You can delete characters with Backspace or Delete keys if you use my script.

You can count on the basic ASCII characters to enter a name or nickname or even a number. Hyphen -, period ., and space " " are recognized automatically.
WARNING: Accents will be ignored by default. Sorry about that.

Screenshots

RMXP

Code:
# * KEnterText HC for XP * #

#   Scripter : Kyonides

#   2025-12-18

# $scene = KEnter::TextScene.new

module KEnter

class TextBox

  REGEX_INT = /\-?[0-9]/

  REGEX_DBL = /\-?[0-9]+[\.,]?[0-9]?/

  def initialize(bw, bh, color)

    @index = 0

    @char_limit = 1

    @number_mode = nil

    @viewport = Viewport.new(0, 0, bw, bh)

    bitmap = Bitmap.new(bw, bh)

    bitmap.fill_rect(bitmap.rect, color)

    @box = Sprite.new(@viewport)

    @box.bitmap = bitmap

    @bitmap = Bitmap.new(bw - 8, bh - 4)

    @bitmap.font.size = 24

    @bitmap.font.outline = true

    @rect = @bitmap.rect

    @text = Sprite.new(@viewport)

    @text.bitmap = @bitmap

    bitmap = Bitmap.new(20, 28)

    bitmap.font.size = 24

    bitmap.font.outline = true

    bitmap.draw_text(bitmap.rect, "|")

    @cursor = Sprite.new(@viewport)

    @cursor.visible = false

    @cursor.bitmap = bitmap

    @sprites = [@text, @box, @cursor]

  end

  def move2(bx, by, n, lh)

    @viewport.x = bx

    @viewport.y = by + n * lh

    @text.set_xy(4, 2)

    @cursor.set_xy(8, 2)

  end

  def reset_cursor

    @index = @chars.size - 1

    set_cursor(@chars.join)

  end

  def chars=(ary)

    @chars = ary

    @index = ary.size - 1

    refresh

    set_cursor(@chars.join)

  end

  def move_back

    @index -= 1 if @index > 0

    text = @chars[0, @index] || [""]

    set_cursor(text.join)

  end

  def move_forward

    @index += 1 if @index < @chars.size - 1

    text = @chars[0, @index] || [""]

    set_cursor(text.join)

  end

  def process_char

    char = Input.last_char

    return unless char

    case @number_mode

    when :int

      char = char[REGEX_INT]

    when :dbl

      char = char[REGEX_DBL]

    else

      if Input.press?(Input::SHIFT)

        char = Input.capslock_state ? char.downcase : char.upcase

      end

    end

    return unless char

    @index += 1

    if @chars.size == @index

      @chars << char

    else

      @chars[@index, 0] = char

    end

    @chars.compact!

    text = @chars[0, @index]

    refresh

    set_cursor(text.join)

  end

  def delete_prev_char

    if @chars.size - 1 == @index

      @chars.pop

      @index = [@chars.size - 1, 0].max

      text = @chars

    else

      @chars.delete_at(@index)

      @index = [@index - 1, 0].max

      text = @chars[0, @index] || [""]

    end

    refresh

    set_cursor(text.join)

  end

  def delete_next_char

    @chars.delete_at(@index + 1)

    refresh

  end

  def refresh

    @bitmap.clear

    @bitmap.draw_text(@rect, @chars.join)

  end

  def set_cursor(text)

    tw = @bitmap.text_width(text)

    @cursor.x = tw + 8

  end

  def char_max?

    @chars.size == @char_limit

  end

  def integer_only!

    @number_mode = :int

  end

  def double_only!

    @number_mode = :dbl

  end

  def include_all!

    @number_mode = nil

  end

  def dispose

    @sprites.each do |sprite|

      sprite.bitmap.dispose

      sprite.dispose

    end

    @sprites.clear

    @viewport.dispose

  end

  attr_writer :char_limit

  attr_reader :chars, :index, :cursor

end

class TextScene

  CHAR_LIMIT = 18

  NUM_LIMIT = 2

  BACKDROP = "catacombs"

  LABELS = ["Your Name", "Your Nickname", "Your Age"]

  @@texts = Array.new(3) {[]}

  def main

    @stage = :main

    @blink_timer = Graphics.frame_rate / 5

    @blink_state = false

    @index = 0

    @text_sprites = []

    black = Color.new(0, 0, 0)

    @blue = Color.new(80, 80, 255)

    custom = Color.new(255, 255, 40)

    lbit = Bitmap.new(208, 180)

    lbit.font.outline = true

    3.times {|n| lbit.draw_text(16, 78 * n, 220, 24, LABELS[n]) }

    @backdrop = Sprite.new

    @backdrop.bitmap = RPG::Cache.title(BACKDROP)

    @label_sprite = Sprite.new

    @label_sprite.set_xy(16, 12)

    @label_sprite.bitmap = lbit

    make_box_text_sprites

    cb = Bitmap.new(208, 4)

    @main_cursor = Sprite.new

    @main_cursor.set_xy(20, 38)

    @main_cursor.bitmap = cb

    cb.fill_rect(cb.rect, black)

    cb.fill_rect(2, 1, 204, 2, custom)

    @text_cursor = @text_sprites[0].cursor

    Graphics.transition

    while @stage

      Graphics.update

      Input.update

      update

    end

    Graphics.freeze

    cb.dispose

    @main_cursor.dispose

    @text_sprites.each_with_index do |box, n|

      box.dispose

      @@texts[n] = box.chars

    end

    @label_sprite.dispose

    @backdrop.bitmap.dispose

    @backdrop.dispose

  end

  def make_box_text_sprites

    3.times do |n|

      textbox = TextBox.new(n < 2 ? 228 : 116, 32, @blue)

      textbox.move2(16, 48, n, 78)

      textbox.chars = @@texts[n]

      textbox.char_limit = n < 2 ? CHAR_LIMIT : NUM_LIMIT

      textbox.integer_only! if n == 2

      @text_sprites << textbox

    end

  end

  def update

    case @stage

    when :main

      update_index

    when :text_input

      update_text_input

    end

  end

  def update_blink

    @blink_timer -= 1

    if @blink_timer == 0

      @blink_timer = Graphics.frame_rate / 5

      @blink_state = !@blink_state

      @text_cursor.visible = @blink_state

    end

  end

  def update_index

    if Input.trigger?(Input::Escape)

      $game_system.se_play($data_system.cancel_se)

      $scene = Scene_Map.new

      return @sprite = @stage = nil

    elsif Input.trigger?(Input::UP)

      set_index(-1)

      return

    elsif Input.trigger?(Input::DOWN)

      set_index(1)

      return

    elsif Input.trigger?(Input::Enter) or Input.trigger?(Input::Return)

      $game_system.se_play($data_system.decision_se)

      Input.text_input = true

      Input.update

      @stage = :text_input

      @sprite = @text_sprites[@index]

      @blink_timer = Graphics.frame_rate / 5

      @text_cursor.visible = @blink_state = true

    end

  end

  def set_index(n)

    $game_system.se_play($data_system.cursor_se)

    @index = (@index + n) % 3

    @main_cursor.y = 38 + @index * 78

    @text_cursor = @text_sprites[@index].cursor

  end

  def update_text_input

    update_blink

    if Input.trigger?(Input::Left)

      $game_system.se_play($data_system.cursor_se)

      @sprite.move_back

      return

    elsif Input.trigger?(Input::Right)

      $game_system.se_play($data_system.cursor_se)

      @sprite.move_forward

      return

    elsif Input.trigger?(Input::Escape)

      $game_system.se_play($data_system.cancel_se)

      process_text_box_cancel

      return

    elsif Input.trigger?(Input::Enter) or Input.trigger?(Input::Return)

      $game_system.se_play($data_system.decision_se)

      Graphics.screenshot

      process_text_box_cancel

      return

    elsif Input.repeat?(Input::Backspace)

      $game_system.se_play($data_system.buzzer_se)

      @sprite.delete_prev_char

      return

    elsif Input.repeat?(Input::Delete)

      $game_system.se_play($data_system.buzzer_se)

      @sprite.delete_next_char

      return

    elsif Input.trigger_any? and Input.last_key?

      if @sprite.char_max?

        $game_system.se_play($data_system.buzzer_se)

        return

      end

      $game_system.se_play($data_system.equip_se)

      @sprite.process_char

    end

  end

  def process_text_box_cancel

    Input.text_input = false

    Input.clear_text_input

    Input.update

    @sprite.reset_cursor

    @text_cursor.visible = @blink_state = false

    @blink_timer = Graphics.frame_rate / 5

    @stage = :main

  end

end

end

RMVX + RMVX ACE

Code:
# * KEnterText HC for VX + ACE * #

#   Scripter : Kyonides

#   2025-12-18

# For VX:

# $scene = KEnter::TextScene.new

# For VX ACE:

# SceneManager.call(KEnter::TextScene)

module KEnter

class TextBox

  REGEX_INT = /\-?[0-9]/

  REGEX_DBL = /\-?[0-9]+[\.,]?[0-9]?/

  def initialize(bw, bh, color)

    @index = 0

    @char_limit = 1

    @number_mode = nil

    @viewport = Viewport.new(0, 0, bw, bh)

    bitmap = Bitmap.new(bw, bh)

    bitmap.fill_rect(bitmap.rect, color)

    @box = Sprite.new(@viewport)

    @box.bitmap = bitmap

    @bitmap = Bitmap.new(bw - 8, bh - 4)

    @bitmap.font.size = 24

    @bitmap.font.outline = true

    @rect = @bitmap.rect

    @text = Sprite.new(@viewport)

    @text.bitmap = @bitmap

    bitmap = Bitmap.new(20, 28)

    bitmap.font.size = 24

    bitmap.font.outline = true

    bitmap.draw_text(bitmap.rect, "|")

    @cursor = Sprite.new(@viewport)

    @cursor.visible = false

    @cursor.bitmap = bitmap

    @sprites = [@text, @box, @cursor]

  end

  def move2(bx, by, n, lh)

    @viewport.x = bx

    @viewport.y = by + n * lh

    @text.set_xy(4, 2)

    @cursor.set_xy(8, 2)

  end

  def reset_cursor

    @index = @chars.size - 1

    set_cursor(@chars.join)

  end

  def chars=(ary)

    @chars = ary

    @index = ary.size - 1

    refresh

    set_cursor(@chars.join)

  end

  def move_back

    @index -= 1 if @index > 0

    text = @chars[0, @index] || [""]

    set_cursor(text.join)

  end

  def move_forward

    @index += 1 if @index < @chars.size - 1

    text = @chars[0, @index] || [""]

    set_cursor(text.join)

  end

  def process_char

    char = Input.last_char

    return unless char

    case @number_mode

    when :int

      char = char[REGEX_INT]

    when :dbl

      char = char[REGEX_DBL]

    else

      if Input.press?(Input::SHIFT)

        char = Input.capslock_state ? char.downcase : char.upcase

      end

    end

    return unless char

    @index += 1

    if @chars.size == @index

      @chars << char

    else

      @chars[@index, 0] = char

    end

    @chars.compact!

    text = @chars[0, @index]

    refresh

    set_cursor(text.join)

  end

  def delete_prev_char

    if @chars.size - 1 == @index

      @chars.pop

      @index = [@chars.size - 1, 0].max

      text = @chars

    else

      @chars.delete_at(@index)

      @index = [@index - 1, 0].max

      text = @chars[0, @index] || [""]

    end

    refresh

    set_cursor(text.join)

  end

  def delete_next_char

    @chars.delete_at(@index + 1)

    refresh

  end

  def refresh

    @bitmap.clear

    @bitmap.draw_text(@rect, @chars.join)

  end

  def set_cursor(text)

    tw = @bitmap.text_width(text)

    @cursor.x = tw + 8

  end

  def char_max?

    @chars.size == @char_limit

  end

  def integer_only!

    @number_mode = :int

  end

  def double_only!

    @number_mode = :dbl

  end

  def include_all!

    @number_mode = nil

  end

  def dispose

    @sprites.each do |sprite|

      sprite.bitmap.dispose

      sprite.dispose

    end

    @sprites.clear

    @viewport.dispose

  end

  attr_writer :char_limit

  attr_reader :chars, :index, :cursor

end

class TextScene

  CHAR_LIMIT = 18

  BACKDROP = "catacombs"

  LABELS = ["Your Name", "Your Nickname", "Your Age"]

  @@texts = Array.new(3) {[]}

  def main

    @vx_ace = Game::RGSS_VERSION == 3

    @stage = :main

    @blink_timer = Graphics.frame_rate / 5

    @blink_state = false

    @index = 0

    @text_sprites = []

    black = Color.new(0, 0, 0)

    @blue = Color.new(80, 80, 255)

    custom = Color.new(255, 255, 40)

    lbit = Bitmap.new(208, 180)

    lbit.font.outline = true

    3.times {|n| lbit.draw_text(16, 78 * n, 220, 24, LABELS[n]) }

    @backdrop = Sprite.new

    @backdrop.bitmap = Cache.system(BACKDROP)

    @label_sprite = Sprite.new

    @label_sprite.set_xy(16, 12)

    @label_sprite.bitmap = lbit

    make_box_text_sprites

    cb = Bitmap.new(208, 4)

    @main_cursor = Sprite.new

    @main_cursor.set_xy(20, 38)

    @main_cursor.bitmap = cb

    cb.fill_rect(cb.rect, black)

    cb.fill_rect(2, 1, 204, 2, custom)

    @text_cursor = @text_sprites[0].cursor

    Graphics.transition

    while @stage

      Graphics.update

      Input.update

      update

    end

    Graphics.freeze

    cb.dispose

    @main_cursor.dispose

    @text_sprites.each_with_index do |box, n|

      box.dispose

      @@texts[n] = box.chars

    end

    @label_sprite.dispose

    @backdrop.bitmap.dispose

    @backdrop.dispose

  end

  def make_box_text_sprites

    3.times do |n|

      textbox = TextBox.new(n < 2 ? 228 : 116, 32, @blue)

      textbox.move2(16, 48, n, 78)

      textbox.chars = @@texts[n]

      textbox.char_limit = n < 2 ? CHAR_LIMIT : NUM_LIMIT

      textbox.integer_only! if n == 2

      @text_sprites << textbox

    end

  end

  def update

    case @stage

    when :main

      update_index

    when :text_input

      update_text_input

    end

  end

  def update_blink

    @blink_timer -= 1

    if @blink_timer == 0

      @blink_timer = Graphics.frame_rate / 5

      @blink_state = !@blink_state

      @text_cursor.visible = @blink_state

    end

  end

  def update_index

    if Input.trigger?(Input::Escape)

      Sound.play_cancel

      $scene = Scene_Map.new

      return @sprite = @stage = nil

    elsif Input.trigger?(Input::UP)

      set_index(-1)

      return

    elsif Input.trigger?(Input::DOWN)

      set_index(1)

      return

    elsif Input.trigger?(Input::Enter) or Input.trigger?(Input::Return)

      @vx_ace ? Sound.play_ok : Sound.play_decision

      Input.text_input = true

      Input.update

      @stage = :text_input

      @sprite = @text_sprites[@index]

      @blink_timer = Graphics.frame_rate / 5

      @text_cursor.visible = @blink_state = true

    end

  end

  def set_index(n)

    Sound.play_cursor

    @index = (@index + n) % 3

    @main_cursor.y = 38 + @index * 78

    @text_cursor = @text_sprites[@index].cursor

  end

  def update_text_input

    update_blink

    if Input.trigger?(Input::Left)

      $game_system.se_play($data_system.cursor_se)

      @sprite.move_back

      return

    elsif Input.trigger?(Input::Right)

      $game_system.se_play($data_system.cursor_se)

      @sprite.move_forward

      return

    elsif Input.trigger?(Input::Escape)

      Sound.play_cancel

      process_text_box_cancel

      return

    elsif Input.trigger?(Input::Enter) or Input.trigger?(Input::Return)

      @vx_ace ? Sound.play_ok : Sound.play_decision

      Graphics.screenshot

      process_text_box_cancel

      return

    elsif Input.repeat?(Input::Backspace)

      Sound.play_buzzer

      @sprite.delete_char

      return

    elsif Input.repeat?(Input::Delete)

      $game_system.se_play($data_system.buzzer_se)

      @sprite.delete_next_char

      return

    elsif Input.trigger_any? and Input.last_key?

      if @sprite.char_max?

        Sound.play_buzzer

        return

      end

      Sound.play_equip

      @sprite.process_char

    end

  end

  def process_text_box_cancel

    Input.text_input = false

    Input.clear_text_input

    Input.update

    @sprite.reset_cursor

    @text_cursor.visible = @blink_state = false

    @blink_timer = Graphics.frame_rate / 5

    @stage = :main

  end

end

end

Terms & Conditions

The same as HiddenChest's.
That's it!

KGamePad HC

Mon, 24 Nov 2025 06:13:09 +0000

KGamePad HC

by Kyonides

Introduction

This scriptlet shows you how you can easily implement a gamepad disconnection script.

The custom module includes all the methods the modified scene scripts would need to include. I also provide you with some XP's Scene_Title script add-on to allow it to display a gamepad icon based on its current status. This script will show you how easily you can implement the module's contents with very few lines of code.

Just don't forget to include the KGamePad module!

NOTES

The Input.gamepad_update call will return either some :add or :remove symbol. That symbol is first converted to a string and then it is used by my script to define which gamepad icon it should show next.

Screenshots

The Module Script
For RMXP

Code:
# * KGamePad HC for XP * #

#  Scripter : Kyonides

#  2025-11-24

module KGamePad

  GAMEPAD_PIC = "gamepad_black"

  GAMEPAD_XY = [12, 12]

  GAMEPAD_FRAMES = 90

  def create_gamepad_icon

    @gamepad_timer = 0

    @gamepad = Sprite.new

    @gamepad.set_xy(*GAMEPAD_XY)

    @gamepad.z = 10000

    @gamepad.visible = false

    @gamepad.bitmap = Bitmap.new(32, 32)

  end

  def dispose_gamepad_icon

    @gamepad.bitmap.dispose

    @gamepad.dispose

  end

  def update_gamepad_status

    return if Input.gamepad_updates.empty?

    type = Input.gamepad_update.to_s

    @gamepad.bitmap.dispose

    @gamepad.bitmap = RPG::Cache.picture(GAMEPAD_PIC + "_" + type)

    @gamepad.visible = true

    @gamepad_timer = GAMEPAD_FRAMES

    @gamepad_pause = true

  end

  def update_gamepad_timer

    return unless @gamepad_pause

    @gamepad_timer -= 1

    @gamepad_pause = @gamepad_timer > 0

    @gamepad.bitmap.clear unless @gamepad_pause

  end

end

For RMVX & RMVX ACE

Code:
# * KGamePad HC for VX & ACE * #

#  Scripter : Kyonides

#  2025-11-24

module KGamePad

  GAMEPAD_PIC = "gamepad_black"

  GAMEPAD_XY = [12, 12]

  GAMEPAD_FRAMES = 90

  def create_gamepad_icon

    @gamepad_timer = 0

    @gamepad = Sprite.new

    @gamepad.set_xy(*GAMEPAD_XY)

    @gamepad.z = 10000

    @gamepad.visible = false

    @gamepad.bitmap = Bitmap.new(32, 32)

  end

  def dispose_gamepad_icon

    @gamepad.bitmap.dispose

    @gamepad.dispose

  end

  def update_gamepad_status

    return if Input.gamepad_updates.empty?

    type = Input.gamepad_update.to_s

    @gamepad.bitmap.dispose

    @gamepad.bitmap = Cache.picture(GAMEPAD_PIC + "_" + type)

    @gamepad.visible = true

    @gamepad_timer = GAMEPAD_FRAMES

    @gamepad_pause = true

  end

  def update_gamepad_timer

    return unless @gamepad_pause

    @gamepad_timer -= 1

    @gamepad_pause = @gamepad_timer > 0

    @gamepad.bitmap.clear unless @gamepad_pause

  end

end

Scene_Title Add-On
Works on RMXP, RMVX & RMVX ACE

Code:
class Scene_Title

  include KGamePad

  alias :kyon_gamepad_scn_ttl_main :main

  alias :kyon_gamepad_scn_ttl_up :update

  def main

    create_gamepad_icon unless $BTEST

    kyon_gamepad_scn_ttl_main

    dispose_gamepad_icon unless $BTEST

  end

  def update

    update_gamepad_status

    update_gamepad_timer

    kyon_gamepad_scn_ttl_up

  end

end

FileIni HC

Tue, 15 Jul 2025 06:24:18 +0000

FileIni HC

by Kyonides

Introduction

This is a scripting tool that allows you to read or write or comment out entries in Windows INI files using Ruby 2.7 syntax.
It is totally cross-platform due to using pure Ruby code only.

The Basics

This script differs from the typical Win32API calls that let you access the INI files.
Instead of opening the file every single time you want to read or write an entry to the file, opening the INI file first is a mandatory step here.

There are 2 ways to open the file:

Code:
handle = FileIni.new("File.ini")

handle2 = FileIni.open("Some.ini")

Once it has been opened, you can call the read, write and comment_out methods at will.

Code:
handle.read("Section1", "Entry1", "Default1")

handle.write("Section2", "Entry10", "NewValue")

handle.comment_out("Section3", "Entry20", "Default")

There is no need to close the target file because the script only access it via new or open and when it is writing a new or old entry to that file.

If the file does not exist at all, you will be able to read an error message like the following:

Code:
YourFile.ini file could not be found!

A new INI file will be created!

Backtrace:

FileIni:in 'initialize'

FileIni:in 'exist?'

The Script

Code:
# * FileIni Class - HC Version * #

#  Scripter : Kyonides

#  2025-07-15

# This scripting tool lets you open, cache and write contents to INI files.

class FileIni

  class NoError

    def initialize

      @message = "Everything is working fine."

      @backtrace = []

    end

    attr_accessor :message

    attr_reader :backtrace

  end

  class NoFileError < NoError

    def set(filename)

      @message = filename + " file could not be found!\n" +

                "A new INI file will be created!"

      if @backtrace.empty?

        @backtrace << "Backtrace:"

        @backtrace << "FileIni:in 'initialize'"

        @backtrace << "FileIni:in 'exist?'"

      end

    end

  end

  class Section

    def initialize(name)

      @name = name

      @keys = []

      @values = []

      @lines = []

    end

    attr_reader :name, :keys, :values, :lines

  end

  @@last = nil

  @@last_error = NoError.new

  attr_reader :filename, :section_names

  def initialize(filename)

    @filename = filename

    @section_names = []

    @sections = []

    @@last = self

    if File.exist?(filename)

      lines = File.readlines(filename)

    else

      @@last_error = NoFileError.new

      @@last_error.set(filename)

      version = Game::RGSS_VERSION

      if version == 3

        msgbox set_error_str

      else

        print set_error_str

      end

      File.open(filename, "w") {}

      return

    end

    section = nil

    lines.size.times do |n|

      line = lines[n]

      key, value = line.split(/[\s]{0,}=[\s]{0,}/i)

      if !value and !line[/=/]

        name = key.gsub(/\[|\]/, "").chomp

        @section_names << name

        @sections << section = Section.new(name)

        next

      end

      section.keys << key

      section.values << (value ? value.chomp : "")

      section.lines << line

    end

  end

  def self.open(filename)

    FileIni.new(filename)

  end

  def self.last

    unless @@last

      raise "Failed to load INI data!\n" +

            "Did you forget to open that file first?"

      return

    end

    @@last.filename

  end

  def self.get_last_error

    set_error_str

  end

  def self.flush_error

    @@last_error = NoError.new

  end

  def read(section_name, key, default)

    n = @section_names.index(section_name)

    section = @sections[n]

    n = section.keys.index(key)

    value = section.values[n]

    value&.empty? ? default : value

  rescue

    default

  end

  def write(section_name, key, value)

    section = find_section(section_name)

    keys = section.keys

    n = find_key_index(section.keys, key, false)

    section.keys[n] = key

    section.values[n] = value.to_s

    section.lines[n] = key + "=#{value}\r\n"

    write_all_entries

    return value.size

  rescue => @@last_error

    return 0

  end

  def comment_out(section_name, key, default)

    section = find_section(section_name)

    keys = section.keys

    n = find_key_index(section.keys, key, true)

    section.keys[n] = ";" + key

    value = section.values[n] || default.to_s

    section.values[n] = value

    section.lines[n] = ";#{key}=#{value}\r\n"

    write_all_entries

    return value.size

  rescue => @@last_error

    return 0

  end

  private

  def set_error_str

    msg = "#{@@last_error.class}\n#{@@last_error.message}\n"

    msg += @@last_error.backtrace.join("\n")

    msg

  end

  def find_section(section_name)

    n = @section_names.index(section_name)

    section = @sections[n]

    unless section

      section = Section.new(section_name)

      @sections << section

    end

    section

  end

  def find_key_index(keys, key, commented)

    this_key = commented ? ";" + key : key

    n = keys.index(this_key)

    unless n

      this_key = commented ? key : ";" + key

      n = keys.index(this_key) || keys.size

    end

    n

  end

  def write_all_entries

    File.open(@filename, "w") do |f|

      @sections.each do |section|

        f.puts "[#{section.name}]"

        f.puts section.lines

      end

    end

  end

end

Basic Online Help File Now Available on hiddenchest/extras/help.

Terms & Conditions

The same as HiddenChest Engine's.

KPointsLotto HC

Sun, 15 Sep 2024 06:51:49 +0000

KPointsLotto HC

by Kyonides

Introduction

This is a short script that will let you configure two kinds of twin skills, an HP or an SP alias MP regeneration skill. What's new here? It will let you set the points percent your hero might earn or lose! That's pretty much why I say it's a good skill for bosses!

HiddenChest and mkxp Version (XP only)

Code:
# * KPointsLotto HiddenChest

#   Scripter : Kyonides Arkanthes

#   2019-10-25

# This scriptlet will let you define skills that might heal or damage its

# target or recover or burn its mana depending on luck alone!

# It might be some good skills for boss battles...

module KPLotto

  LIFE_SKILL_ID = 3

  MANA_SKILL_ID = 4

  LIFE_RANGE = -40..25 # Percent you can lose or earn

  MANA_RANGE = -35..10 # Percent you can lose or earn

end

# HiddenChest and mkxp

class Game_Battler

  alias :kyon_plotto_gm_battler_se :skill_effect

  def skill_effect(user, skill)

    result = kyon_plotto_gm_battler_se(user, skill)

    if result

      if KPLotto::LIFE_SKILL_ID == skill.id

        @damage = @hp * rand(KPLotto::LIFE_RANGE) / 100

        self.hp += @damage

      elsif KPLotto::MANA_SKILL_ID == skill.id

        @damage = @sp * rand(KPLotto::MANA_RANGE) / 100

        self.sp += @damage

      end

    end

    result

  end

end

Terms & Conditions

You must include my nickname and the current website's URL in your game credits.
I don't know if this scriptlet should be 100% free or not so stay tune!
Give me a free copy of your completed game if you include at least 2 of my scripts!

BGM No Loop

Thu, 06 Jun 2024 05:32:22 +0000

BGM No Loop

HiddenChest Exclusive!

XP Related

by Kyonides

Introduction

This is a simple scriplet that will let RMXP users play one BGM after another based on which map ID's are included in the MAP_BGM array.

There still is one important detail you must know: Audio.bgm_loop is set to true, meaning that all the other maps will keep playing the same old song.

Warning

You need to be using HiddenChest version 1.1.81 or later!

Script for RMXP Editor

Code:
# * BGM No Loop XP * #

#   Scripter : Kyonides Arkanthes

#   2024-06-13

# This scriptlet allows you to prevent the game from playing the same old song

# over and over again. Now you can define a list of BGMs for specific maps!

module BgmNoLoop

  WAIT = 20

  VOLUME = 60

  MAP_BGM = {}

  MAP_BGM[1] = ["015-Theme04", "017-Theme06"]

end

class Game_Map

  alias :kyon_bgm_no_loop_gm_map_setup :setup

  def setup(map_id)

    check_bgm_loop(map_id)

    kyon_bgm_no_loop_gm_map_setup(map_id)

  end

  def check_bgm_loop(map_id)

    Audio.bgm_loop = !BgmNoLoop::MAP_BGM.has_key?(map_id)

    puts "Check Loop in Map ##{map_id}: " + Audio.bgm_loop.to_s

  end

  def map_bgm

    @map.bgm

  end

  def find_bgms

    bgm = @map.bgm

    $game_system.bgm_volume = bgm.volume

    bgms = []

    bgms << bgm unless bgm.name.empty?

    bgms + BgmNoLoop::MAP_BGM[@map_id]

  end

end

class Game_System

  alias :kyon_bgm_no_loop_gm_sys_init :initialize

  alias :kyon_bgm_no_loop_gm_sys_up :update

  def initialize

    kyon_bgm_no_loop_gm_sys_init

    reset_bgm_timer

    reset_bgm_volume

    @bgm_index = 0

  end

  def reset_bgm_timer

    @bgm_timer = BgmNoLoop::WAIT

  end

  def reset_bgm_volume

    @bgm_volume ||= BgmNoLoop::VOLUME

  end

  def update

    kyon_bgm_no_loop_gm_sys_up

    return if $game_temp.in_battle or Audio.bgm_playing?

    return if Audio.bgm_loop

    if @bgm_timer > 0

      @bgm_timer -= 1

      return

    end

    reset_bgm_timer

    bgms = $game_map.find_bgms

    @bgm_index ||= 0

    @bgm_index = (@bgm_index + 1) % bgms.size

    bgm = bgms[@bgm_index]

    bgm = RPG::AudioFile.new(bgm) if bgm.is_a?(String)

    bgm_play(bgm) if bgm != nil

  end

  def bgm_play(bgm)

    reset_bgm_volume

    @playing_bgm = bgm

    if bgm != nil and bgm.name != ""

      Audio.bgm_play("Audio/BGM/" + bgm.name, @bgm_volume, bgm.pitch)

    else

      Audio.bgm_stop

    end

    Graphics.frame_reset

  end

  attr_accessor :bgm_volume

end

PrintScene HC

Mon, 27 May 2024 22:24:48 +0000

PrintScene HC

HiddenChest Exclusive!

XP + VX ACE Related

by Kyonides

This script emulates the behavior of a system's popup window in the maker while running on HiddenChest!

You can click on the red box or the OK button to close it or even move the sprite around!

Warning!
The only caveat here is that you gotta move it slowly while pressing the left button on top of the title bar.

Script Call

Code:
dialog_box("As many", "lines", "as possible")

The Script

Code:
# * PrintScene HC * #

#  Scripter : Kyonides Arkanthes

#  2024-05-27

# * Script Dependency: ClickableWindow

# This script mimicks what the popup windows do, including letting you move them

# around. The only issue I have found so far is that you need to move it slowly.

# Script Call: dialog_box("As many", "lines", "as possible")

module Kernel

  def dialog_box(*lines)

    scene = PrintScene.new(lines)

    scene.main

  end

end

class PrintSprite < Sprite

  WIDTH = 320

  BUTTON_OK = "OK"

  def initialize(messages, w=WIDTH, vp=nil)

    super(vp)

    @messages = messages

    lines = @messages.size

    h = lines * 32 + 64

    self.x = (Graphics.width - w) / 2

    self.y = (Graphics.height - h) / 2

    self.bitmap = Bitmap.new(w, h)

    @margin_x = 16

    @margin_y = 32

    @mouse_x = Input.mouse_x

    @mouse_y = Input.mouse_y

    @width, @height = Graphics.dimensions

  end

  def titlebar_color=(color)

    @titlebar_color = color

    w = src_rect.width

    @area << rect = Rect.new(0, 0, w, 24,)

    self.bitmap.fill_rect(rect, color)

    @area << rect = Rect.new(w - 22, 2, 20, 20)

    red = Color.new(220, 40, 40)

    self.bitmap.fill_rect(rect, red)

    icon_name = Game::ICON

    if FileInt.exist?(icon_name)

      icon = Bitmap.new(icon_name)

    else

      icon = Bitmap.new("app_logo", nil)

    end

    rect = Rect.new(4, 4, 16, 16)

    self.bitmap.stretch_blt(rect, icon, icon.rect)

    self.bitmap.font.size = 16

    self.bitmap.draw_text(0, 0, w, 24, Game::TITLE, 1)

  end

  def message_box_color=(color)

    r = src_rect

    rect = Rect.new(@margin_x, r.height - 24, 80, 28)

    self.bitmap.fill_rect(0, 24, r.width, r.height - 24, color)

  end

  def ok_box_color=(color)

    r = src_rect

    cx = (r.width - 80) / 2

    @area << rect = Rect.new(cx, r.height - 36, 80, 28)

    self.bitmap.fill_rect(rect, color)

    self.bitmap.font.size = 16

    self.bitmap.draw_text(cx, r.height - 36, 80, 28, BUTTON_OK, 1)

  end

  def refresh

    w = src_rect.width

    @messages.size.times do |n|

      self.bitmap.draw_text(12, @margin_y + n * 20, w - 24, 18, @messages[n])

    end

    @messages.clear

  end

  def display

    self.bitmap.font.size = 15

  end

  def update

    super

    if Input.trigger?(Input::B) or Input.trigger?(Input::C)

      PrintScene.running = nil

    elsif Input.left_click? or Input.right_click?

      1.upto(2) do |n|

        next unless click_area?(n)

        PrintScene.running = nil

        break

      end

    elsif Input.press?(Input::MouseLeft)

      if click_area?(0)

        mx = Input.mouse_x - @mouse_x

        my = Input.mouse_y - @mouse_y

        self.x += mx.clamp(-@width, @width * 2)

        self.y += my.clamp(-@height, @height * 2)

      end

    end

    @mouse_x = Input.mouse_x

    @mouse_y = Input.mouse_y

  end

  attr_reader :titlebar_color

  attr_writer :margin_x, :margin_y

end

class PrintScene

  def self.running=(state)

    @@running = state

  end

  def initialize(lines)

    @@running = true

    @messages = lines.map {|line| line.to_s.split("\n") }

    @messages = @messages.flatten.compact

  end

  def main

    Graphics.freeze

    start

    Graphics.transition

    update_loop

    Graphics.freeze

    terminate

  end

  def start

    @backdrop = Sprite.new

    @backdrop.bitmap = Graphics.snap_to_gray_bitmap.dup

    @print = PrintSprite.new(@messages)

    @print.z = 1000

    black = Color.new(0, 0, 0)

    gray = Color.new(80, 80, 80)

    @print.titlebar_color = black

    @print.message_box_color = gray

    @print.ok_box_color = black

    @print.refresh

  end

  def update_loop

    while @@running

      Graphics.update

      Input.update

      update

    end

  end

  def update

    @print.update

    if Input.trigger?(Input::SHIFT)

      Graphics.screenshot

    end

  end

  def terminate

    @print.bitmap.dispose

    @print.dispose

    @backdrop.bitmap.dispose

    @backdrop.dispose

  end

end

ClickableWindows

Mon, 27 May 2024 22:16:34 +0000

ClickableWindows

HiddenChest Exclusive!

XP + VX + ACE Related

by Kyonides

Warning!

Other scripts of mine like PrintScene HC depend on this one.

These scriptlets allow you to click on the usual menu window options!

As long as you click on the area defined by the blinking cursor, you will be fine.

It does not fully support all windows but only child classes of Window_Selectable and a few others.

The Caveats

They are based on XP's and VX ACE's default scripts. There is no warranty they will work with custom ones.

Some scenes forced me to add calls like Input.double_left_click? or Input.right_click? to make them work properly.

Script Section

Script for the RMXP Editor

Code:
# * ClickableWidget XP * #

#   Scripter : Kyonides Arkanthes

#   2026-01-11

# This is a script demo that shows you how it is now possible to click once on

# a menu window to choose an option while ignoring the surrounding area.

# Normally, you would have to add some calls to Input.left_click? or

# Input.right_click? or even Input.middle_click? to your target scenes to make

# this work.

class Sprite

  alias :kyon_click_sprite_sprite_up :update

  def update

    kyon_click_sprite_sprite_up

    # Added Draggable Window Check

    check_draggable

    check_mouse_inside

  end

  def check_draggable

    return unless draggable?

    if Input.press_left_click?

      if Mouse.no_target?

        if mouse_inside_color? and drag_color?

          Mouse.target = self

          @mouse_x = Mouse.x

          @mouse_y = Mouse.y

        end

      elsif Mouse.target?(self)

        self.x += Mouse.x - @mouse_x

        self.y += Mouse.y - @mouse_y

        @mouse_x = Mouse.x

        @mouse_y = Mouse.y

      end

      return

    elsif Mouse.target?(self)

      Mouse.target = nil

    end

  end

  def hover_can_change?

    return false if @hover_changed

    return false if @base_name.nil? or @base_name.empty?

    return false if @hover_name.nil? or @hover_name.empty?

    @hover_filetype != nil

  end

  def check_mouse_inside

    return if Mouse.target?(self)

    if mouse_inside?

      if hover_can_change?

        set_hover_bitmap

        @hover_changed = true

        return

      end

    elsif @hover_changed

      self.bitmap.dispose

      set_base_bitmap

      @hover_changed = false

    end

  end

  def set_hover_bitmap

    filetype = @hover_filetype.to_sym

    case filetype

    when :battler 

      self.bitmap = RPG::Cache.battler(@hover_name, @hover_hue)

    when :character

      self.bitmap = RPG::Cache.character(@hover_name, @hover_hue)

    when :icon

      self.bitmap = RPG::Cache.icon(@hover_name)

    when :picture

      self.bitmap = RPG::Cache.picture(@hover_name)

    end

  end

  def set_base_bitmap

    filetype = @hover_filetype.to_sym

    case filetype

    when :battler 

      self.bitmap = RPG::Cache.battler(@base_name, @hover_hue)

    when :character

      self.bitmap = RPG::Cache.character(@base_name, @hover_hue)

    when :icon

      self.bitmap = RPG::Cache.icon(@base_name)

    when :picture

      self.bitmap = RPG::Cache.picture(@base_name)

    end

  end

end

class Window_Base

  def update

    super

    if $game_system.windowskin_name != @windowskin_name

      @windowskin_name = $game_system.windowskin_name

      self.windowskin = RPG::Cache.windowskin(@windowskin_name)

    end

    # Added Draggable Window Check

    check_draggable

  end

  def check_draggable

    return unless draggable?

    if Input.press_left_click?

      if Mouse.no_target? and mouse_inside?

        Mouse.target = self

        @mouse_x = Mouse.x

        @mouse_y = Mouse.y

      elsif Mouse.target?(self)

        self.x += Mouse.x - @mouse_x

        self.y += Mouse.y - @mouse_y

        @mouse_x = Mouse.x

        @mouse_y = Mouse.y

      end

      return

    elsif Mouse.target?(self)

      Mouse.target = nil

    end

  end

end

class Window_Selectable

  def one_click_selection

    # Set Index to invisible if clicked outside this window

    self.index = -1

    # Check each area - a list of Rect's

    @area.size.times do |n|

      next unless mouse_inside?(n)

      self.index = n

      break

    end

  end

  def update

    super

    return unless self.active

    return if @item_max == 0

    # Added Left Click Check

    if Input.left_click?

      one_click_selection

      return

    end

    if mouse_inside?

      if Mouse.scroll_y?(:UP)

        $game_system.se_play($data_system.cursor_se)

        self.index = (@index - @column_max) % @item_max

        return

      elsif Mouse.scroll_y?(:DOWN)

        $game_system.se_play($data_system.cursor_se)

        self.index = (@index + @column_max) % @item_max

        return

      end

    end

    if Input.repeat?(Input::DOWN)

      if (@column_max == 1 and Input.trigger?(Input::DOWN)) or

         @index < @item_max - @column_max

        $game_system.se_play($data_system.cursor_se)

        @index = (@index + @column_max) % @item_max

      end

    end

    if Input.repeat?(Input::UP)

      if (@column_max == 1 and Input.trigger?(Input::UP)) or

         @index >= @column_max

        $game_system.se_play($data_system.cursor_se)

        @index = (@index - @column_max + @item_max) % @item_max

      end

    end

    if Input.repeat?(Input::RIGHT)

      if @column_max >= 2 and @index < @item_max - 1

        $game_system.se_play($data_system.cursor_se)

        @index += 1

      end

    end

    if Input.repeat?(Input::LEFT)

      if @column_max >= 2 and @index > 0

        $game_system.se_play($data_system.cursor_se)

        @index -= 1

      end

    end

    if Input.repeat?(Input::R)

      if self.top_row + (self.page_row_max - 1) < (self.row_max - 1)

        $game_system.se_play($data_system.cursor_se)

        @index = [@index + self.page_item_max, @item_max - 1].min

        self.top_row += self.page_row_max

      end

    end

    if Input.repeat?(Input::L)

      if self.top_row > 0

        $game_system.se_play($data_system.cursor_se)

        @index = [@index - self.page_item_max, 0].max

        self.top_row -= self.page_row_max

      end

    end

    if self.active and @help_window != nil

      update_help if @index >= 0

    end

    update_cursor_rect

  end

  def get_area_rect(n)

    rw = self.width / @column_max - 32

    rx = 8 + n % @column_max * (rw + 32)

    ry = n / @column_max * 32 - self.oy

    Rect.new(rx, ry, rw, 32)

  end

end

class Window_Command

  def draw_item(n, color)

    @area[n] ||= get_area_rect(n)

    c = self.contents

    c.font.color = color

    rect = Rect.new(4, 32 * n, c.width - 8, 32)

    c.fill_rect(rect, Color.new(0, 0, 0, 0))

    c.draw_text(rect, @commands[n])

  end

end

class Window_MenuStatus

  def refresh

    self.contents.clear

    @item_max = $game_party.actors.size

    for i in 0...$game_party.actors.size

      x = 64

      y = i * 116

      @area[i] ||= Rect.new(0, i * 116, self.width - 32, 96)

      actor = $game_party.actors[i]

      draw_actor_graphic(actor, x - 40, y + 80)

      draw_actor_name(actor, x, y)

      draw_actor_class(actor, x + 144, y)

      draw_actor_level(actor, x, y + 32)

      draw_actor_state(actor, x + 90, y + 32)

      draw_actor_exp(actor, x, y + 64)

      draw_actor_hp(actor, x + 236, y + 32)

      draw_actor_sp(actor, x + 236, y + 64)

    end

  end

end

class Window_Target

  def refresh

    self.contents.clear

    for i in 0...$game_party.actors.size

      x = 4

      y = i * 116

      @area[i] ||= Rect.new(0, i * 116, self.width - 32, 96)

      actor = $game_party.actors[i]

      draw_actor_name(actor, x, y)

      draw_actor_class(actor, x + 144, y)

      draw_actor_level(actor, x + 8, y + 32)

      draw_actor_state(actor, x + 8, y + 64)

      draw_actor_hp(actor, x + 152, y + 32)

      draw_actor_sp(actor, x + 152, y + 64)

    end

  end

end

class Window_EquipRight

  def initialize(actor)

    super(272, 64, 368, 192)

    @click_width = width - 32

    self.contents = Bitmap.new(@click_width, height - 32)

    @actor = actor

    create_areas

    refresh

    self.index = 0

  end

  def create_areas

    5.times {|n| @area << Rect.new(4, 32 * n, @click_width, 32) }

  end

end

class Window_SaveFile

  alias :kyon_click_win_win_svfl_init :initialize

  def initialize(file_index, filename)

    kyon_click_win_win_svfl_init(file_index, filename)

    @area << self.contents.rect

  end

end

class Window_Message

  alias :kyon_click_win_win_mess_init :initialize

  def initialize

    kyon_click_win_win_mess_init

    self.pause_x = self.width - 80

  end

end

class Scene_Title

  LOGO = "icon_sound"

  def load_database

    $data_actors        = load_data("Data/Actors.rxdata")

    $data_classes       = load_data("Data/Classes.rxdata")

    $data_skills        = load_data("Data/Skills.rxdata")

    $data_items         = load_data("Data/Items.rxdata")

    $data_weapons       = load_data("Data/Weapons.rxdata")

    $data_armors        = load_data("Data/Armors.rxdata")

    $data_enemies       = load_data("Data/Enemies.rxdata")

    $data_troops        = load_data("Data/Troops.rxdata")

    $data_states        = load_data("Data/States.rxdata")

    $data_animations    = load_data("Data/Animations.rxdata")

    $data_tilesets      = load_data("Data/Tilesets.rxdata")

    $data_common_events = load_data("Data/CommonEvents.rxdata")

    $data_system        = load_data("Data/System.rxdata")

  end

  def reset_game_system

    $game_system = Game_System.new

  end

  def start

    create_backdrop

    create_command_window

    create_title

    create_extras

    check_continue

    setup_audio

  end

  def create_backdrop

    @sprite = Sprite.new

    @sprite.bitmap = RPG::Cache.title($data_system.title_name)

  end

  def create_command_window

    s1 = "New Game"

    s2 = "Continue"

    s3 = "Shutdown"

    @command_window = Window_Command.new(192, [s1, s2, s3])

    @command_window.back_opacity = 160

    @command_window.x = 320 - @command_window.width / 2

    @command_window.y = 288

    @command_window.draggable = true

  end

  def create_title

    @title = Sprite.new

    @title.set_xyz(0, 60, 100)

    @title.bitmap = b = Bitmap.new(Graphics.width, 60)

    font = b.font

    font.size = 52

    font.outline = true

    font.outline_size = 4

    b.draw_text(b.rect, Game::TITLE, 1)

  end

  def create_extras

    @logo = Sprite.new

    @logo.set_xyz(24, 24, 100)

    @logo.drag_condition = :color

    @logo.base_name = LOGO

    @logo.hover_name = LOGO + "2"

    @logo.hover_filetype = :picture

    @logo.set_base_bitmap

    @day_index = 0

    @days = %w{Sunday Monday Tuesday Wednesday Thursday Friday Saturday}

    # Make day of the week graphic

    @block = Sprite.new

    @block.set_xyz(12, Graphics.height - 40, 100)

    @bitmap = Bitmap.new(200, 36)

    font = @bitmap.font

    font.size = 32

    font.outline = true

    font.outline_size = 2

    @bitmap.draw_text(@bitmap.rect, @days[@day_index], 1)

    @block.bitmap = @bitmap

  end

  def check_continue

    @continue_enabled = Dir["Save*.rxdata"].any?

    if @continue_enabled

      @command_window.index = 1

    else

      @command_window.disable_item(1)

    end

  end

  def setup_audio

    $game_system.bgm_play($data_system.title_bgm)

    Audio.me_stop

    Audio.bgs_stop

  end

  def terminate

    @command_window.dispose

    @bitmap.dispose

    @block.dispose

    @logo.bitmap.dispose

    @logo.dispose

    @title.bitmap.dispose

    @title.dispose

    @sprite.bitmap.dispose

    @sprite.dispose

  end

  def main

    if $BTEST

      battle_test

      return

    end

    load_database

    reset_game_system

    start

    Graphics.transition

    loop do

      Graphics.update

      Input.update

      update

      break if $scene != self

    end

    Graphics.freeze

    terminate

  end

  def update

    @logo.update

    @command_window.update

    # Added Right Click Check

    if Input.right_click?

      $game_system.se_play($data_system.cursor_se)

      if @command_window.index < 2

        @command_window.index = 2

        Audio.bgm_pause

      else

        @command_window.index = -1

        Audio.bgm_resume

      end

    # Added Left Click Check

    elsif Input.trigger?(Input::C) or Input.double_left_click?

      case @command_window.index

      when 0  # New game

        command_new_game

      when 1  # Continue

        command_continue

      when 2  # Shutdown

        command_shutdown

      end

    elsif Input.repeat?(Input::KeyD) or Input.repeat_right_click?

      $game_system.se_play($data_system.cursor_se)

      @day_index = (@day_index + 1) % 7

      @bitmap.clear

      @bitmap.draw_text(@bitmap.rect, @days[@day_index], 1)

    elsif Input.trigger?(Input::LeftShift)

      $game_system.se_play($data_system.equip_se)

      Graphics.screenshot

    end

  end

end

class Scene_Map

  def update

    loop do

      $game_map.update

      $game_system.map_interpreter.update

      $game_player.update

      $game_system.update

      $game_screen.update

      break unless $game_temp.player_transferring

      transfer_player

      break if $game_temp.transition_processing

    end

    @spriteset.update

    @message_window.update

    if $game_temp.gameover

      $scene = Scene_Gameover.new

      return

    end

    if $game_temp.to_title

      $scene = Scene_Title.new

      return

    end

    if $game_temp.transition_processing

      $game_temp.transition_processing = false

      if $game_temp.transition_name == ""

        Graphics.transition(20)

      else

        Graphics.transition(40, "Graphics/Transitions/" +

          $game_temp.transition_name)

      end

    end

    if Input.trigger?(Input::KeyP)

      $game_system.se_play($data_system.shop_se)

      Graphics.screenshot

      return

    end

    return if $game_temp.message_window_showing

    if $game_player.encounter_count == 0 and $game_map.encounter_list != []

      unless $game_system.map_interpreter.running? or

             $game_system.encounter_disabled

        n = rand($game_map.encounter_list.size)

        troop_id = $game_map.encounter_list[n]

        if $data_troops[troop_id] != nil

          $game_temp.battle_calling = true

          $game_temp.battle_troop_id = troop_id

          $game_temp.battle_can_escape = true

          $game_temp.battle_can_lose = false

          $game_temp.battle_proc = nil

        end

      end

    end

    # Added Right Click Check

    if Input.trigger?(Input::B) or Input.double_right_click?

      unless $game_system.map_interpreter.running? or

             $game_system.menu_disabled

        $game_temp.menu_calling = true

        $game_temp.menu_beep = true

      end

    end

    if $DEBUG and Input.press?(Input::F9)

      $game_temp.debug_calling = true

    end

    unless $game_player.moving?

      if $game_temp.battle_calling

        call_battle

      elsif $game_temp.shop_calling

        call_shop

      elsif $game_temp.name_calling

        call_name

      elsif $game_temp.menu_calling

        call_menu

      elsif $game_temp.save_calling

        call_save

      elsif $game_temp.debug_calling

        call_debug

      end

    end

  end

end

class Scene_Menu

  def main

    start

    Graphics.transition

    loop do

      Graphics.update

      Input.update

      update

      if $scene != self

        break

      end

    end

    Graphics.freeze

    terminate

  end

  def start

    create_command_window

    create_windows

    Mouse.set_xy(80, 28 + @menu_index * 32)

  end

  def create_command_window

    s1 = $data_system.words.item

    s2 = $data_system.words.skill

    s3 = $data_system.words.equip

    s4 = "Status"

    s5 = "Save"

    s6 = "End Game"

    @command_window = Window_Command.new(160, [s1, s2, s3, s4, s5, s6])

    @command_window.index = @menu_index

    if $game_party.actors.size == 0

      @command_window.disable_item(0)

      @command_window.disable_item(1)

      @command_window.disable_item(2)

      @command_window.disable_item(3)

    end

    if $game_system.save_disabled

      @command_window.disable_item(4)

    end

  end

  def create_windows

    @playtime_window = Window_PlayTime.new

    @playtime_window.x = 0

    @playtime_window.y = 224

    @steps_window = Window_Steps.new

    @steps_window.x = 0

    @steps_window.y = 320

    @gold_window = Window_Gold.new

    @gold_window.x = 0

    @gold_window.y = 416

    @status_window = Window_MenuStatus.new

    @status_window.x = 160

    @status_window.y = 0

  end

  def terminate

    @command_window.dispose

    @playtime_window.dispose

    @steps_window.dispose

    @gold_window.dispose

    @status_window.dispose

  end

  def update_command

    # Added Right Click Check

    if Input.trigger?(Input::B) or Input.double_right_click?

      $game_system.se_play($data_system.cancel_se)

      $scene = Scene_Map.new

      return

    end

    # Added Left Click Check

    if Input.trigger?(Input::C) or Input.double_left_click?

      if $game_party.actors.size == 0 and @command_window.index < 4

        $game_system.se_play($data_system.buzzer_se)

        return

      end

      case @command_window.index

      when 0  # item

        $game_system.se_play($data_system.decision_se)

        $scene = Scene_Item.new

      when 1  # skill

        $game_system.se_play($data_system.decision_se)

        @command_window.active = false

        @status_window.active = true

        @status_window.index = 0

        Mouse.set_xy(@command_window.width + 120, 28)

      when 2  # equipment

        $game_system.se_play($data_system.decision_se)

        @command_window.active = false

        @status_window.active = true

        @status_window.index = 0

        Mouse.set_xy(@command_window.width + 120, 28)

      when 3  # status

        $game_system.se_play($data_system.decision_se)

        @command_window.active = false

        @status_window.active = true

        @status_window.index = 0

        Mouse.set_xy(@command_window.width + 120, 28)

      when 4  # save

        if $game_system.save_disabled

          $game_system.se_play($data_system.buzzer_se)

          return

        end

        $game_system.se_play($data_system.decision_se)

        $scene = Scene_Save.new

      when 5  # end game

        $game_system.se_play($data_system.decision_se)

        $scene = Scene_End.new

      end

      return

    end

  end

  def update_status

    # Added Double Right Click Check

    if Input.trigger?(Input::B) or Input.double_right_click?

      $game_system.se_play($data_system.cancel_se)

      @command_window.active = true

      @status_window.active = false

      @status_window.index = -1

      mx = @command_window.x + 80

      my = 28 + @command_window.index * 32

      Mouse.set_xy(mx, my)

      return

    end

    # Modified OK Button Functionality

    if Input.trigger?(Input::C)

      process_status

      return

    # Added Double Left Click Check

    elsif Input.double_left_click?

      return unless @status_window.mouse_inside?(@status_window.index)

      process_status

    end

  end

  def process_status

    case @command_window.index

    when 1  # skill

      if $game_party.actors[@status_window.index].restriction >= 2

        $game_system.se_play($data_system.buzzer_se)

        return

      end

      $game_system.se_play($data_system.decision_se)

      $scene = Scene_Skill.new(@status_window.index)

    when 2  # equipment

      $game_system.se_play($data_system.decision_se)

      $scene = Scene_Equip.new(@status_window.index)

    when 3  # status

      $game_system.se_play($data_system.decision_se)

      $scene = Scene_Status.new(@status_window.index)

    end

  end

end

class Scene_Item

  alias :kyon_click_win_scn_item_up_item :update_item

  def update_item

    kyon_click_win_scn_item_up_item

    # Added Double Right Click Check

    if Input.double_right_click?

      $game_system.se_play($data_system.cancel_se)

      $scene = Scene_Menu.new(0)

      return

    end

  end

end

class Scene_Equip

  alias :kyon_click_win_scn_equip_up_right :update_right

  def update_right

    kyon_click_win_scn_equip_up_right

    if Input.double_right_click?

      $game_system.se_play($data_system.cancel_se)

      $scene = Scene_Menu.new(2)

      return

    elsif Input.double_left_click?

      n = @right_window.index

      if !@right_window.mouse_inside?(n) or @actor.equip_fix?(n)

        $game_system.se_play($data_system.buzzer_se)

        return

      end

      $game_system.se_play($data_system.decision_se)

      @right_window.active = false

      @item_window.active = true

      @item_window.index = 0

      return

    end

  end

end

class Scene_File

  alias :kyon_click_win_scn_fl_up :update

  def update

    kyon_click_win_scn_fl_up

    if Input.double_right_click?

      on_cancel

      return

    elsif Input.double_left_click?

      @savefile_windows.each_with_index do |win, n|

        next unless win.mouse_inside?(0)

        choose_file(n)

        on_decision(make_filename(n))

        $game_temp.last_file_index = n

        break

      end

      return

    elsif Input.left_click?

      @savefile_windows.each_with_index do |win, n|

        next unless win.mouse_inside?(0)

        choose_file(n)

        break

      end

      return

    end

  end

  def choose_file(n)

    @savefile_windows[@file_index].selected = false

    @savefile_windows[n].selected = true

    @file_index = n

  end

end

class Scene_End

  def main

    s1 = "To Title"

    s2 = "Shutdown"

    s3 = "Cancel"

    @command_window = Window_Command.new(192, [s1, s2, s3])

    @command_window.x = 320 - @command_window.width / 2

    @command_window.y = 240 - @command_window.height / 2

    @command_window.draggable = true

    Graphics.transition

    loop do

      Graphics.update

      Input.update

      update

      break if $scene != self

    end

    Graphics.freeze

    @command_window.dispose

    if $scene.is_a?(Scene_Title)

      Graphics.transition

      Graphics.freeze

    end

  end

  def update

    @command_window.update

    # Added Right Click Check

    if Input.trigger?(Input::B) or Input.double_right_click?

      $game_system.se_play($data_system.cancel_se)

      $scene = Scene_Menu.new(5)

      return

    # Added Left Click Check

    elsif Input.trigger?(Input::C) or Input.double_left_click?

      case @command_window.index

      when 0  # to title

        command_to_title

      when 1  # shutdown

        command_shutdown

      when 2  # quit

        command_cancel

      end

      return

    end

  end

end

Script for RM VX Editor

Code:
# * ClickableWindow VX * #

#   Scripter : Kyonides Arkanthes

#   2026-01-11

# This is a script demo that shows you how it is now possible to click once on

# a menu window to choose an option while ignoring the surrounding area.

# Normally, you would have to add some calls to Input.left_click? or

# Input.right_click? or even Input.middle_click? to your target scenes to make

# this work.

class Window_Selectable

  def one_click_selection

    # Set Index to invisible if clicked outside this window

    self.index = -1

    # Check each area - a list of Rect's

    @area.size.times do |n|

      next unless mouse_inside?(n)

      self.index = n

      Sound.play_cursor

      break

    end

  end

  def cursor_movable?

    return false if !visible or !active

    return false if @item_max == 0 or @opening or @closing

    return true

  end

  def update

    super

    if cursor_movable?

      last_index = @index

      # Added Left Click Check

      if Input.left_click?

        one_click_selection

        return

      end

      if mouse_inside?

        if Mouse.scroll_y?(:UP)

          Sound.play_cursor

          self.index = (@index - @column_max) % @item_max

          return

        elsif Mouse.scroll_y?(:DOWN)

          Sound.play_cursor

          self.index = (@index + @column_max) % @item_max

          return

        end

      end

      if Input.repeat?(Input::DOWN)

        cursor_down(Input.trigger?(Input::DOWN))

      end

      if Input.repeat?(Input::UP)

        cursor_up(Input.trigger?(Input::UP))

      end

      if Input.repeat?(Input::RIGHT)

        cursor_right(Input.trigger?(Input::RIGHT))

      end

      if Input.repeat?(Input::LEFT)

        cursor_left(Input.trigger?(Input::LEFT))

      end

      if Input.repeat?(Input::R)

        cursor_pagedown

      end

      if Input.repeat?(Input::L)

        cursor_pageup

      end

      if @index != last_index

        Sound.play_cursor

      end

    end

    update_cursor

    call_update_help

  end

end

class Window_Command

  def draw_item(n, enabled = true)

    rect = @area[n] ||= item_rect(n)

    rect.x += 4

    rect.width -= 8

    self.contents.clear_rect(rect)

    self.contents.font.color = normal_color

    self.contents.font.color.alpha = enabled ? 255 : 128

    self.contents.draw_text(rect, @commands[n])

  end

end

class Scene_Title

  def update

    super

    @command_window.update

    # Added Left Click Check

    if Input.trigger?(Input::C) or Input.double_left_click?

      case @command_window.index

      when 0    #New game

        command_new_game

      when 1    # Continue

        command_continue

      when 2    # Shutdown

        command_shutdown

      end

    # Added Right Click Check

    elsif Input.right_click?

      $game_system.se_play($data_system.cursor_se)

      if @command_window.index < 2

        @command_window.index = 2

      end

    end

  end

end

class Scene_Map

  def update_call_menu

    if Input.trigger?(Input::B) or Input.double_right_click?

      return if $game_map.interpreter.running?

      return if $game_system.menu_disabled

      $game_temp.menu_beep = true

      $game_temp.next_scene = "menu"

    end

  end

end

class Scene_Menu

  def update_command_selection

    if Input.trigger?(Input::B) or Input.double_right_click?

      Sound.play_cancel

      $scene = Scene_Map.new

    elsif Input.trigger?(Input::C) or Input.double_left_click?

      if $game_party.members.size == 0 and @command_window.index < 4

        Sound.play_buzzer

        return

      elsif $game_system.save_disabled and @command_window.index == 4

        Sound.play_buzzer

        return

      end

      Sound.play_decision

      case @command_window.index

      when 0      # Item

        $scene = Scene_Item.new

      when 1,2,3  # Skill, equipment, status

        start_actor_selection

      when 4      # Save

        $scene = Scene_File.new(true, false, false)

      when 5      # End Game

        $scene = Scene_End.new

      end

    end

  end

end

class Scene_End

  def update

    super

    update_menu_background

    @command_window.update

    if Input.trigger?(Input::B) or Input.double_right_click?

      Sound.play_cancel

      return_scene

    elsif Input.trigger?(Input::C) or Input.double_left_click?

      case @command_window.index

      when 0  # to title

        command_to_title

      when 1  # shutdown

        command_shutdown

      when 2  # quit

        command_cancel

      end

    end

  end

end

Script for RM VX ACE Editor

Code:
# * ClickableWindow ACE * #

#   Scripter : Kyonides Arkanthes

#   2025-01-11

# This is a script demo that shows you how it is now possible to click once on

# a menu window to choose an option while ignoring the surrounding area.

# Normally, you would have to add some calls to Input.left_click? or

# Input.right_click? or even Input.middle_click? to your target scenes to make

# this work.

class Window_Selectable

  def process_cursor_move

    return unless cursor_movable?

    last_index = @index

    if Input.left_click?

      # Set Index to invisible if clicked outside this window

      self.index = -1

      # Check each area - a list of Rect's

      @area.size.times do |n|

        next unless mouse_inside?(n)

        self.index = n

        Sound.play_cursor

        break

      end

      return

    end

    cursor_down (Input.trigger?(:DOWN))  if Input.repeat?(:DOWN)

    cursor_up   (Input.trigger?(:UP))    if Input.repeat?(:UP)

    cursor_right(Input.trigger?(:RIGHT)) if Input.repeat?(:RIGHT)

    cursor_left (Input.trigger?(:LEFT))  if Input.repeat?(:LEFT)

    cursor_pagedown   if !handle?(:pagedown) && Input.trigger?(:R)

    cursor_pageup     if !handle?(:pageup)   && Input.trigger?(:L)

    Sound.play_cursor if @index != last_index

  end

  def process_handling

    return unless open? && active

    return process_ok       if ok_enabled? && Input.double_left_click?

    return process_cancel   if cancel_enabled? && Input.double_right_click?

    return process_ok       if ok_enabled?        && Input.trigger?(:C)

    return process_cancel   if cancel_enabled?    && Input.trigger?(:B)

    return process_pagedown if handle?(:pagedown) && Input.trigger?(:R)

    return process_pageup   if handle?(:pageup)   && Input.trigger?(:L)

  end

end

class Window_Command

  def draw_item(n)

    rect = @area[n] ||= item_rect_for_text(n)

    change_color(normal_color, command_enabled?(n))

    draw_text(rect, command_name(n), alignment)

  end

end

class Window_MenuCommand

  def select_last

    select_symbol(@@last_command_symbol)

    Mouse.set_xy(80, 20 + @index * 24)

  end

end

class Window_SaveFile

  alias :kyon_click_win_win_svfl_init :initialize

  def initialize(height, index)

    kyon_click_win_win_svfl_init(height, index)

    @area << self.contents.rect

  end

end

class Scene_File

  def update_savefile_selection

    if Input.double_left_click?

      @savefile_windows.each_with_index do |win, n|

        next unless win.mouse_inside?

        choose_file(n)

        on_savefile_ok

        break

      end

      return

    elsif Input.left_click?

      @savefile_windows.each_with_index do |win, n|

        next unless win.mouse_inside?

        choose_file(n)

        break

      end

      return

    elsif Input.double_right_click?

      on_savefile_cancel

      return

    end

    return on_savefile_ok     if Input.trigger?(:C)

    return on_savefile_cancel if Input.trigger?(:B)

    update_cursor

  end

  def choose_file(n)

    @savefile_windows[@index].selected = false

    @savefile_windows[n].selected = true

    @index = n

    ensure_cursor_visible

  end

end

KSoundFontMenu

Fri, 24 May 2024 05:04:26 +0000

KSoundFontMenu

HiddenChest Exclusive!

XP + VX + ACE Related

by Kyonides

This scriptlet allows you to actually play a specific MIDI melody AND change the current synthesizer's SoundFont!

All of these scripts will only work by running the HiddenChest binary executable.

There are certain consideration to take in consideration before using it:

The MIDI file should be playing BEFORE you proceed to call Setup.choose_soundfont(index)
Otherwise the change would be ignored by the internal system.
Some scenes might take advantage of setting the current soundfont again, no filename change involved here, to make sure it will be using the selected soundfont.
Yet, it is not mandatory because this apparent issue could have been caused by using some soundfonts with similar sound sets.
The change may take a couple of seconds to take effect.
That is why I added the "Processing New SF..." label to the KSoundFont module.

Extra Step

Add the following lines to your Game.ini file:

Code:
SoundFontWin=C:/Audio/SF2/GMGSx.sf2

SoundFontLnx=/home/user/Maker/GMGSx.sf2

SoundFontPathWin=C:/Music/SF2

SoundFontPathLnx=/home/user/Music/SF2

These lines will allow the HiddenChest engine find your custom SoundFonts on both Windows & Linux!
Keep in mind that HiddenChest has always been a cross-platform engine.

Script Calls

Open the KSoundFont::Menu Scene depending on your RM Editor:

Code:
$scene = KSoundFont::Menu.new

SceneManager(KSoundFont::Menu)

Select Your Favorite SoundFont - All Versions:

Code:
Game.choose_soundfont(index)

Getting and Saving the Index of Your Favorite SoundFont

Code:
$game_system.soundfont_index

$game_system.soundfont_index = Number

Getting a SoundFont (Full Path) Based on its Current Position:

Code:
Game.soundfonts[index]

Default SoundFont (if it Exists):

Code:
System::SOUNDFONT

Default SoundFont Directory (It Should Exist if you ever pretend to add 2+ SoundFonts):

Code:
System::SOUNDFONT_DIR

Scripts Section

Script For RMXP Editor

Code:
# * KSoundFontMenu XP * # 

#   Scripter : Kyonides Arkanthes

#   2024-06-03

# Note: It seems like the MIDI file should be playing BEFORE you proceed to call

#       Game.choose_soundfont while loading a save game. Otherwise, the MIDI

#       synthetizer might ignore your request at that specific point.

#       Calling the same method at the beginning of KSoundFont::Menu ensures it

#       will always play the MIDI using the chosen soundfont.

# * Script Call * #

# $scene = KSoundFont::Menu.new

module KSoundFont

  START_SF = [0]

  TITLE = "Select a SoundFont"

  THIS_SOUNDFONT = "Current SoundFont"

  DELAY_MESSAGE = "Processing New SF..."

  NO_SOUNDFONT = "No SoundFont"

  TRANSPARENT = Color.new(0, 0, 0, 0)

class PathsWindow < Window_Command

  def initialize(w, paths)

    @paths = paths

    commands = paths.map {|fn| fn.split(/[\/|\\]/)[-1].sub(".sf2", "") }

    super(w, commands)

  end

  def path

    @paths[@index]

  end

  def name

    @commands[@index]

  end

end

class SmallInfoWindow < Window_Base

  def initialize(wx, wy, w, h)

    super

    self.contents = Bitmap.new(w - 32, h - 32)

    contents.font.color = system_color

    contents.draw_text(0, 0, w - 32, 32, THIS_SOUNDFONT, 1)

    contents.font.color = normal_color

  end

  def set_text(text)

    contents.fill_rect(0, 32, width - 32, 32, TRANSPARENT)

    contents.draw_text(0, 32, width - 32, 32, text, 1)

  end

end

class Menu

  def main

    @timer = 0

    pos = $game_system.soundfont_index

    Game.choose_soundfont(pos)

    soundfonts = Game.soundfonts

    gs_indexes = $game_system.soundfont_indexes

    if gs_indexes.any?

      @indexes = gs_indexes.sort

      if @indexes.size < soundfonts.size

        soundfonts = @indexes.map{|n| soundfonts[n] }

      end

    end

    @total = soundfonts.size

    @full_list = Game.soundfonts.size == @total

    soundfont = soundfonts[pos]

    dialog_box soundfont

    if soundfonts.any?

      soundfont = soundfont.split(/[\/|\\]/)[-1].sub(".sf2", "")

    else

      soundfont = NO_SOUNDFONT

    end

    @help_window = Window_Help.new

    @help_window.set_text(TITLE, 1)

    @command_window = PathsWindow.new(192, soundfonts)

    @command_window.y = 64

    @command_window.index = pos

    @info_window = SmallInfoWindow.new(192, @command_window.y, 240, 96)

    @info_window.set_text(soundfont)

    Graphics.transition

    loop do

      Graphics.update

      Input.update

      update

      break if $scene != self

    end

    Graphics.freeze

    @info_window.dispose

    @command_window.dispose

    @help_window.dispose

  end

  def update

    if @timer > 0

      @timer -= 1

      if @timer == 0

        @info_window.set_text(@command_window.name)

      end

      return

    end

    @command_window.update

    if Input.trigger?(Input::B) or Input.double_right_click?

      $game_system.se_play($data_system.cancel_se)

      $scene = Scene_Map.new

      return

    elsif Input.trigger?(Input::C) or Input.double_left_click?

      if @total < 2

        $game_system.se_play($data_system.buzzer_se)

        return

      end

      $game_system.se_play($data_system.decision_se)

      n = @command_window.index

      n = @indexes[n] unless @full_list

      $game_system.soundfont_index = n

      @info_window.set_text(DELAY_MESSAGE)

      @timer = Graphics.frame_rate * 2

    elsif Input.trigger?(Input::SHIFT)

      $game_system.se_play($data_system.cursor_se)

      Graphics.screenshot

    end

  end

end

end

class Game_System

  alias :kyon_soundfont_menu_gm_sys_init :initialize

  def initialize

    kyon_soundfont_menu_gm_sys_init

    self.soundfont_index = find_soundfont_index

    @soundfont_indexes = KSoundFont::START_SF.dup

  end

  def find_soundfont_index

    Game.soundfont_index || 0

  end

  def soundfont_index

    @soundfont_index ||= find_soundfont_index

  end

  def soundfont_index=(n)

    Game.choose_soundfont(n)

    @soundfont_index = n

  end

  def soundfont_indexes

    @soundfont_indexes ||= []

  end

end

class Scene_Load

  alias :kyon_soundfont_menu_scn_ld_rsd :read_save_data

  def read_save_data(file)

    kyon_soundfont_menu_scn_ld_rsd(file)

    $game_system.bgm_play($game_system.playing_bgm)

    Game.choose_soundfont($game_system.soundfont_index)

  end

end

Script for RMVX Editor

Code:
# * KSoundFontMenu VX * # 

#   Scripter : Kyonides Arkanthes

#   2024-06-03

# Note: It seems like the MIDI file should be playing BEFORE you proceed to call

#       Game.choose_soundfont while loading a save game. Otherwise, the MIDI

#       synthetizer might ignore your request at that specific point.

#       Calling the same method at the beginning of KSoundFont::Menu ensures it

#       will always play the MIDI using the chosen soundfont.

# * Script Call * #

# $scene = KSoundFont::Menu.new

module KSoundFont

  START_SF = [0]

  TITLE = "Select a SoundFont"

  THIS_SOUNDFONT = "Current SoundFont"

  DELAY_MESSAGE = "Processing New SF..."

  NO_SOUNDFONT = "No SoundFont"

  TRANSPARENT = Color.new(0, 0, 0, 0)

class PathsWindow < Window_Command

  def initialize(w, paths)

    @paths = paths

    commands = paths.map {|fn| fn.split(/[\/|\\]/)[-1].sub(".sf2", "") }

    super(w, commands)

  end

  def path

    @paths[@index]

  end

  def name

    @commands[@index]

  end

end

class SmallInfoWindow < Window_Base

  def initialize(wx, wy, w, h)

    super

    self.contents = Bitmap.new(w - 32, h - 32)

    contents.font.color = system_color

    contents.draw_text(0, 0, w - 32, 32, THIS_SOUNDFONT, 1)

    contents.font.color = normal_color

  end

  def set_text(text)

    contents.fill_rect(0, 32, width - 32, 32, TRANSPARENT)

    contents.draw_text(0, 32, width - 32, 32, text, 1)

  end

end

class Menu

  def main

    @timer = 0

    pos = $game_system.soundfont_index

    Game.choose_soundfont(pos)

    soundfonts = Game.soundfonts

    gs_indexes = $game_system.soundfont_indexes

    if gs_indexes.any?

      @indexes = gs_indexes.sort

      if @indexes.size < soundfonts.size

        soundfonts = @indexes.map{|n| soundfonts[n] }

      end

    end

    @total = soundfonts.size

    @full_list = Game.soundfonts.size == @total

    soundfont = soundfonts[pos]

    if soundfonts.any?

      soundfont = soundfont.split(/[\/|\\]/)[-1].sub(".sf2", "")

    else

      soundfont = NO_SOUNDFONT

    end

    @help_window = Window_Help.new

    @help_window.set_text(TITLE, 1)

    hwy = @help_window.height

    @command_window = PathsWindow.new(192, soundfonts)

    @command_window.y = hwy

    @command_window.index = pos

    @info_window = SmallInfoWindow.new(192, hwy, 240, 96)

    @info_window.set_text(soundfont)

    Graphics.transition

    loop do

      Graphics.update

      Input.update

      update

      break if $scene != self

    end

    Graphics.freeze

    @info_window.dispose

    @command_window.dispose

    @help_window.dispose

  end

  def update

    if @timer > 0

      @timer -= 1

      if @timer == 0

        @info_window.set_text(@command_window.name)

      end

      return

    end

    @command_window.update

    if Input.trigger?(Input::B) or Input.double_right_click?

      Sound.play_cancel

      $scene = Scene_Map.new

      return

    elsif Input.trigger?(Input::C) or Input.double_left_click?

      return Sound.play_buzzer if @total < 2

      Sound.play_decision

      n = @command_window.index

      n = @indexes[n] unless @full_list

      $game_system.soundfont_index = n

      @info_window.set_text(DELAY_MESSAGE)

      @timer = Graphics.frame_rate * 2

    elsif Input.trigger?(Input::SHIFT)

      Sound.play_cursor

      Graphics.screenshot

    end

  end

end

end

class Game_System

  alias :kyon_soundfont_menu_gm_sys_init :initialize

  def initialize

    kyon_soundfont_menu_gm_sys_init

    self.soundfont_index = find_soundfont_index

    @soundfont_indexes = KSoundFont::START_SF.dup

  end

  def find_soundfont_index

    Game.soundfont_index || 0

  end

  def soundfont_index

    @soundfont_index ||= find_soundfont_index

  end

  def soundfont_index=(n)

    Game.choose_soundfont(n)

    @soundfont_index = n

  end

  def soundfont_indexes

    @soundfont_indexes ||= []

  end

end

class Scene_File

  alias :kyon_soundfont_menu_scn_fl_rsd :read_save_data

  def read_save_data(file)

    kyon_soundfont_menu_scn_fl_rsd(file)

    @last_bgm.play

    Game.choose_soundfont($game_system.soundfont_index)

  end

end

Script for RMVX ACE Editor

Code:
# * KSoundFontMenu ACE * # 

#   Scripter : Kyonides Arkanthes

#   2024-06-03

# Note: It seems like the MIDI file should be playing BEFORE you proceed to call

#       Game.choose_soundfont while loading a save game. Otherwise, the MIDI

#       synthetizer might ignore your request at that specific point.

#       Calling the same method at the beginning of KSoundFont::Menu ensures it

#       will always play the MIDI using the chosen soundfont.

# * Script Call * #

# SceneManager(KSoundFont::Menu)

module KSoundFont

  START_SF = [0]

  TITLE = "Select a SoundFont"

  THIS_SOUNDFONT = "Current SoundFont"

  DELAY_MESSAGE = "Processing New SF..."

  NO_SOUNDFONT = "No SoundFont"

  TRANSPARENT = Color.new(0, 0, 0, 0)

class HelpWindow < Window_Help

  def set_text(text, align)

    return if text == @text and align == @align

    @text = text

    @align = align

    refresh

  end

  def refresh

    contents.clear

    draw_text(contents.rect, @text, @align)

  end

end

class PathsWindow < Window_Selectable

  def initialize(w, paths)

    @paths = paths

    @commands = paths.map {|fn| fn.split(/[\/|\\]/)[-1].sub(".sf2", "") }

    @item_max = @commands.size

    h = @item_max * line_height + line_height

    super(0, 0, w, h)

    return if @item_max == 0

    refresh

    self.active = true

  end

  def draw_all_items

    @item_max.times do |n|

      rect = @area[n] ||= item_rect_for_text(n)

      draw_text(rect, @commands[n])

    end

  end

  def process_handling

  end

  def path

    @paths[@index]

  end

  def name

    @commands[@index]

  end

  attr_reader :item_max

end

class SmallInfoWindow < Window_Base

  def initialize(wx, wy, w, h)

    super

    self.contents = Bitmap.new(w - 32, h - 32)

    contents.font.color = system_color

    contents.draw_text(0, 0, w - 32, 32, THIS_SOUNDFONT, 1)

    contents.font.color = normal_color

  end

  def set_text(text)

    contents.fill_rect(0, 32, width - 32, 32, TRANSPARENT)

    contents.draw_text(0, 32, width - 32, 32, text, 1)

  end

end

class Menu < Scene_Base

  def start

    super

    @timer = 0

    pos = $game_system.soundfont_index

    Game.choose_soundfont(pos)

    soundfonts = Game.soundfonts

    gs_indexes = $game_system.soundfont_indexes

    if gs_indexes.any?

      @indexes = gs_indexes.sort

      if @indexes.size < soundfonts.size

        soundfonts = @indexes.map{|n| soundfonts[n] }

      end

    end

    @total = soundfonts.size

    @full_list = Game.soundfonts.size == @total

    soundfont = soundfonts[pos]

    if soundfonts.any?

      soundfont = soundfont.split(/[\/|\\]/)[-1].sub(".sf2", "")

    else

      soundfont = NO_SOUNDFONT

    end

    @help_window = HelpWindow.new

    @help_window.set_text(TITLE, 1)

    hwy = @help_window.height

    @command_window = PathsWindow.new(192, soundfonts)

    @command_window.y = hwy

    @command_window.index = pos

    @info_window = SmallInfoWindow.new(192, hwy, 240, 96)

    @info_window.set_text(soundfont)

  end

  def update

    Graphics.update

    Input.update

    if @timer > 0

      @timer -= 1

      if @timer == 0

        @info_window.set_text(@command_window.name)

      end

      return

    end

    @command_window.update

    if Input.trigger?(:B) or Input.double_right_click?

      Sound.play_cancel

      SceneManager.return

      return

    elsif Input.trigger?(:C) or Input.double_left_click?

      return Sound.play_buzzer if @total < 2

      Sound.play_ok

      n = @command_window.index

      n = @indexes[n] unless @full_list

      $game_system.soundfont_index = n

      @info_window.set_text(DELAY_MESSAGE)

      @timer = Graphics.frame_rate * 2

    elsif Input.trigger?(:SHIFT)

      Sound.play_cursor

      Graphics.screenshot

    end

  end

end

end

class Game_System

  alias :kyon_soundfont_menu_gm_sys_init :initialize

  alias :kyon_soundfont_menu_gm_sys_on_after_load :on_after_load

  def initialize

    kyon_soundfont_menu_gm_sys_init

    self.soundfont_index = find_soundfont_index

    @soundfont_indexes = KSoundFont::START_SF.dup

  end

  def find_soundfont_index

    Game.soundfont_index || 0

  end

  def soundfont_index

    @soundfont_index ||= find_soundfont_index

  end

  def soundfont_index=(n)

    Game.choose_soundfont(n)

    @soundfont_index = n

  end

  def soundfont_indexes

    @soundfont_indexes ||= []

  end

  def on_after_load

    kyon_soundfont_menu_gm_sys_on_after_load

    Game.choose_soundfont($game_system.soundfont_index)

  end

end

Screenshots

3 Snapshots

Terms & Conditions

Free for any kind of game running on the HiddenChest engine.
Due credit is mandatory.
Don't post the contents of this topic anywhere else!
You better paste a link to this thread and make them come here instead.
That's it!

ksoundfont_vx001.jpg (Size: 40.18 KB / Downloads: 475)

ksoundfont_ace001.jpg (Size: 32.63 KB / Downloads: 452)