Announcement

[Mithran]

Battle Theme Changer Menu Scene v 1.0
by Mithran

Introduction
I saw this request on the boards a while back. I didn't see anything posted, and I've never done a full scene before, so I thought I would give it a shot. Here is the result.

Features
- a menu scene allowing you to play or change the battle themes
- enable or disable selection during play, allowing you to still play your own theme for evented battles while perserving the selection in the menu

How to Use
Install on its own script page in the materials section of the script editor above main and below any custom menus.

Script

» Click to show Spoiler - click again to hide... «

CODE

# Battle Theme Changer Menu Scene
# v 1.0
# By Mitrhan
# Requested by Goldensun9753
# Adds a menu item to allow the player to change the battle theme.
# Allows the creator to enable/disable the menu.
# Allows the creator to choose to use the system's current battle music
# (for evented battles you dont want to change the music in)

# Usage: Set up your battle themes in the customization section.

# Advanced > Script commands

# unlock_battle_theme(n)
# n is either the number index of the song, or its unique name in quotes
# Example -
# unlock_battle_theme("Songs") would unlock the song in index 7 below
# unlock_battle_theme(7) would also unlock the song in the screen.

# enable_bgm_selection
# Enables the use of the music changer scene.

# disable_bgm_selection
# Disables the use of the scene.  Also changes the BGM back to the last system
# bgm (use for evented / boss battle fights with fixed music).
# Be sure to enable afterwards!

# Install: Insert on a seperate page below main.  Install below custom menu scripts.
# (only tested with default menu)
# Please do not redistribute without asking!

#=============================== CUSTOMIZATION =================================

module Mithran
  module BattleMusic
    MENU_NAME = "Fight Tunes"
    # The menu display name.
    
    # Format - ["display name", "file name", enabled?, volume, pitch]
    # "display name" and "file name" are required.
    # enabled? is either true or false.  If true, the song will be selectable
    # at start.  If false, the song will be disabled until unlocked
    # volume is a range from 0 to 100
    # pitch is a range from 50 to 150
    # If omitted, enabled? defaults to true, and pitch and volume default to 100
    # Display names must be unique
    # Duplicate file names can be used if different tempos or volumes are used
    THEMES = [ # DO NOT DELETE
    ["Hey", "Battle1", true], # Index 0
    ["Look", "Battle2", true], # Index 1
    ["I Can", "Battle3", true], # Index 2
    ["Change", "Battle4", true], # Index 3
    ["The", "Battle5", true], # Index 4
    ["Battle", "Battle6", true], # Index 5
    ["Theme", "Battle9", true], # Index 6
    ["Songs", "Battle8"], # Index 7
    ["Go Pitch", "Battle2", true, 100, 150], # Index 8
    ["Slowmo", "Battle2", true, 100, 50], # Index 9
    ["Push Forward", "Battle7", true], # Index 10
    ["Final Battle", "Battle10", true], # Index 11
    ["Hidden 1", "Theme1", false, 100, 100], # Index 12
    ["Hidden 2", "Theme2", false, 100, 100], # Index 13
    ["Hidden 3", "Theme3", false, 100, 100], # Index 14
    ["Hidden 4", "Theme4", false, 100, 100], # Index 15
    
    # ADD MORE HERE OR CHANGE THE ABOVE
    ] # DO NOT DELETE
    
    SELECTION_COLOR = 14
    # The text color from the windowskin based on index.  
    # This is the same color you get when you use the \C[n] command to set the
    # text color in a message.
    
    MASK_DISABLED_SONG = true
    # If set to true, song names for disabled songs will be displayed as ?
    
    INITIAL_ENABLE = true
    # If the menu is initially enabled or not.
    
    KB_HELP_WINDOW = true
    # If set to true, the help window will display what keys should be pressed
    # for the keyboard.  
    # If set to false, they will be controller keys
    
  end
end

#============================= END CUSTOMIZATION ===============================


class Window_BattleMusic < Window_Selectable

  attr_accessor :song_playing
  
  def initialize(x, y, width, height)
    super(x, y, width, height)
    @column_max = 2
    self.index = 0
    refresh
  end
  
  def song
    return $game_system.get_battle_theme(@data[self.index])
  end
  
  def current_song_name
    return @data[self.index]
  end
  
  def include?(song_name)
    return false if song_name.nil?
    return true
  end

  def enable?(song_name)
    return $game_system.theme_enabled?(song_name)
  end

  def refresh
    @data = []
    for song_name in $game_system.battle_theme_names
      song = $game_system.get_battle_theme(song_name)
      next unless include?(song_name)
      @data.push(song_name)
      if song.is_a?(RPG::BGM) && $game_system.battle_bgm.the_same_as?($game_system.get_battle_theme(song_name))
        self.index = @data.size - 1
      end
    end
    @data.push(nil) if include?(nil)
    @item_max = @data.size
    create_contents
    for i in 0...@item_max
      draw_item(i)
    end
  end

  def draw_item(index)
    rect = item_rect(index)
    self.contents.clear_rect(rect)
    song_name = @data[index]
    if song_name != nil
      enabled = enable?(song_name)
      rect.width -= 4
      draw_song_name(song_name, rect.x, rect.y, enabled)
    end
  end
  
  def draw_song_name(song_name, x, y, enabled = true)
    self.contents.font.color = normal_color
    if $game_system.battle_bgm.the_same_as?($game_system.get_battle_theme(song_name))
      self.contents.font.color = text_color(Mithran::BattleMusic::SELECTION_COLOR)
    end
    self.contents.font.color.alpha = enabled ? 255 : 128
    if !enabled && Mithran::BattleMusic::MASK_DISABLED_SONG
      song_name = song_name.clone
      song_name.gsub!(/./i, "?")
    end
    self.contents.draw_text(x + 12, y, 172 + 24, WLH, song_name)
  end
  
  def update_help
    if @song_playing
      if Mithran::BattleMusic::KB_HELP_WINDOW
        @help_window.set_text("Enter = Song Test, A = Set Song, Esc = Stop")
      else
        @help_window.set_text("C = Song Test, X = Set Song, B = Stop")
      end
    else
      if Mithran::BattleMusic::KB_HELP_WINDOW
        @help_window.set_text("Enter = Song Test, A = Set Song, Esc = Stop")
      else
        @help_window.set_text("C = Song Test, X = Set Song, B = Exit")
      end
    end
  end
  
end

class RPG::BGM
  def the_same_as?(song)
    name1 = self.name
    name2 = song.name
    volume1 = self.volume
    volume2 = song.volume
    pitch1 = self.pitch
    pitch2 = song.pitch
    return true if name1 == name2 && volume1 == volume2 && pitch1 == pitch2
    return false
  end
end

class Game_System
  
  attr_writer :battle_theme_selection
  attr_accessor :last_bgm
  attr_accessor :bgm_select_disabled
  
  def bgm_select_disabled
    @bgm_select_disabled ||= !Mithran::BattleMusic::INITIAL_ENABLE
  end
  
  alias battle_bgm_battle_theme_menu battle_bgm
  def battle_bgm
    unless bgm_select_disabled
      return @battle_theme_selection unless @battle_theme_selection.nil?
    end
    return battle_bgm_battle_theme_menu
  end
    
  def battle_theme_names
    result = []
    Mithran::BattleMusic::THEMES.each_index { |i|
    result << Mithran::BattleMusic::THEMES[i][0]
    }
    return result
  end
  
  def get_battle_theme(song_name)
    Mithran::BattleMusic::THEMES.each_index { |i|
    if Mithran::BattleMusic::THEMES[i][0] == song_name
      file = Mithran::BattleMusic::THEMES[i][1]
      volume = Mithran::BattleMusic::THEMES[i][3].nil? ? 100 : Mithran::BattleMusic::THEMES[i][3]
      pitch = Mithran::BattleMusic::THEMES[i][4].nil? ? 100 : Mithran::BattleMusic::THEMES[i][4]
      return RPG::BGM.new(file, volume, pitch)
    end
    }
    return RPG::BGM.new
  end
    
  def theme_enabled?(song_name)
    return enabled_battle_themes.include?(song_name)
  end
  
  def enabled_battle_themes
    create_initial_enabled_theme_cache if @enabled_battle_themes == nil
    return @enabled_battle_themes
  end
  
  def create_initial_enabled_theme_cache
    @enabled_battle_themes = []
    Mithran::BattleMusic::THEMES.each_index { |i|
      name = Mithran::BattleMusic::THEMES[i][0]
      enabled = !!Mithran::BattleMusic::THEMES[i][2]
      @enabled_battle_themes.push(name) if enabled && !@enabled_battle_themes.include?(name)
    }
  end
    
  def enable_theme(name)
    create_initial_enabled_theme_cache if @enabled_battle_themes == nil
    @enabled_battle_themes.push(name) if !@enabled_battle_themes.include?(name)
  end
  
  def disable_theme(name)
    create_initial_enabled_theme_cache if @enabled_battle_themes == nil
    @enabled_battle_themes.delete(name)  
  end
  
end
    

class Scene_BattleMusic < Scene_Base
  def initialize(return_index = 0)
    @return_index = return_index
  end
  
  def start
    super
    save_bgm
    create_menu_background
    @viewport = Viewport.new(0, 0, 544, 416)
    @help_window = Window_Help.new
    @help_window.viewport = @viewport
    @song_window = Window_BattleMusic.new(0, 56, 544, 360)
    @song_window.viewport = @viewport
    @song_window.help_window = @help_window
    @song_window.active = true
  end

  def terminate
    super
    dispose_menu_background
    @viewport.dispose
    @help_window.dispose
    @song_window.dispose
    recall_bgm
  end

  def save_bgm
    $game_system.last_bgm = RPG::BGM.last
  end

  def recall_bgm
    if $game_system.last_bgm != nil && $game_system.last_bgm != RPG::BGM.last
      $game_system.last_bgm.play
    end
  end
  
  def return_scene
    $scene = Scene_Menu.new(@return_index)
  end

  def update
    super
    update_menu_background
    @help_window.update
    @song_window.update
    if @song_window.active
      update_song_selection
    end
  end

  def update_song_selection
    if @song_window.song_playing && Input.trigger?(Input::B)
      RPG::BGM.stop
      @song_window.song_playing = false
      @song_window.update_help
    elsif Input.trigger?(Input::B)
      Sound.play_cancel
      return_scene
    elsif Input.trigger?(Input::C)
      song_name = @song_window.current_song_name
      song = @song_window.song
      if $game_system.theme_enabled?(song_name)
        song.play
        @song_window.song_playing = true
        @song_window.update_help
      else
        Sound.play_buzzer
      end
    elsif Input.trigger?(Input::X)
      song_name = @song_window.current_song_name
      song = @song_window.song
      if $game_system.theme_enabled?(song_name)
        Sound.play_decision
        $game_system.battle_theme_selection = song
        @song_window.refresh
      else
        Sound.play_buzzer
      end
    end
  end

end

class Scene_Menu < Scene_Base
  alias create_command_window_battle_theme_menu create_command_window
  def create_command_window
    create_command_window_battle_theme_menu
    if @battle_themes_index == nil
      @command_window.make_extra_command(Mithran::BattleMusic::MENU_NAME)
      @battle_themes_index = @command_window.item_max - 1
      @command_window.index = @menu_index
      if $game_system.bgm_select_disabled
        @command_window.draw_item(@battle_themes_index, false)
      end
    end
  end
  
  alias update_command_selection_battle_theme_menu update_command_selection
  def update_command_selection
    if Input.trigger?(Input::C)
      case @command_window.index
      when @battle_themes_index
        if $game_system.bgm_select_disabled then Sound.play_buzzer; return; end
        Sound.play_decision
        $scene = Scene_BattleMusic.new(@command_window.index)
        return
      end
    end
    update_command_selection_battle_theme_menu
  end
  
end

class Window_Command < Window_Selectable
  def make_extra_command(text)
    @commands.push(text)
    @item_max = @commands.size
    self.height += WLH
    self.bottom_row = @item_max - 1
    create_contents
    refresh
  end
  
end

class Game_Interpreter
  def unlock_battle_theme(data)
    if data.is_a?(String)
      $game_system.enable_theme(data)
    else
      return if Mithran::BattleMusic::THEMES[data].nil?
      name = Mithran::BattleMusic::THEMES[data][0]
      $game_system.enable_theme(name) unless name.nil?
    end
  end
  
  def disable_bgm_selection
    $game_system.bgm_select_disabled = true
  end
  
  def enable_bgm_selection
    $game_system.bgm_select_disabled = false
  end

end

FAQ
Q: How do I add more songs?
A: First, you need to import them in to the BGM folder using the import manager. Somewhere after line in the "THEMES = [ # DO NOT CHANGE" and before the ] "# DO NOT CHANGE" lines, either copy paste an existing line or edit one of the avaiable ones. Simply change the names inside the first quote section to the display name of the song, and the second quoted section to the exact name of the imported file. Set the remaining options in the brackets according to the instructions in the module.

Credit and Thanks
- by Mithran
- requested by Goldensun9753

Author's Notes
Let me know what you think. Please do not redistribute without asking.

[acrox999]

Oh man! Sweet! There is a script kinda same but for XP.

[Garkago]

I'll be glad to give my first post to this script, it's awesome thanks a bunch

[Takami Daisuke]

With this script is it possible change battele theme with script command?

[piejamas]

With this script is it possible change battele theme with script command?

You can do it with an event command lol

Change Battle BGM, page 3

[Timmah]

Very nice job as always Mithran, your scripting skills have proven once again to be outstanding.

There's one problem I'd like to ask about though. When using this with Yanfly's Menu Redux, I noticed that the menu appears twice, once in the assigned position and again under the last item in the menu. Just wondering if you would happen to know if there's any way to fix this.

Thanks once again for sharing this lovely script with us and have a nice day.

[Mithran]

Very nice job as always Mithran, your scripting skills have proven once again to be outstanding.

There's one problem I'd like to ask about though. When using this with Yanfly's Menu Redux, I noticed that the menu appears twice, once in the assigned position and again under the last item in the menu. Just wondering if you would happen to know if there's any way to fix this.

Thanks once again for sharing this lovely script with us and have a nice day.

Comment out this part of the script to prevent it from autoadding to the menu (select the text in the script, press Ctrl +Q). Its toward the end:

Spoiler:

CODE

class Scene_Menu < Scene_Base
  alias create_command_window_battle_theme_menu create_command_window
  def create_command_window
    create_command_window_battle_theme_menu
    if @battle_themes_index == nil
      @command_window.make_extra_command(Mithran::BattleMusic::MENU_NAME)
      @battle_themes_index = @command_window.item_max - 1
      @command_window.index = @menu_index
      if $game_system.bgm_select_disabled
        @command_window.draw_item(@battle_themes_index, false)
      end
    end
  end
  
  alias update_command_selection_battle_theme_menu update_command_selection
  def update_command_selection
    if Input.trigger?(Input::C)
      case @command_window.index
      when @battle_themes_index
        if $game_system.bgm_select_disabled then Sound.play_buzzer; return; end
        Sound.play_decision
        $scene = Scene_BattleMusic.new(@command_window.index)
        return
      end
    end
    update_command_selection_battle_theme_menu
  end
  
end

[Takami Daisuke]

You can do it with an event command lol

Change Battle BGM, page 3

With event command pag 3 only can change event battle music.
I'd like to change music for normal battle but without opening this music change window.
For example, in forest duneon sound battle BGM1, in mine dungeon sound battle BGM2, etc.
I'd like control battle bgm depending on the dungeon.
Is it possible with this script??

[Mithran]

With event command pag 3 only can change event battle music.
I'd like to change music for normal battle but without opening this music change window.
For example, in forest duneon sound battle BGM1, in mine dungeon sound battle BGM2, etc.
I'd like control battle bgm depending on the dungeon.
Is it possible with this script??

The event command "Change Battle BGM" changes the BGM for all battles initiated after this point to the selected BGM, evented or otherwise. Simply place the event as an autorun + erase event at the entrances to your dungeons. This should not be confused with "Change BGM", which changes the currently playing BGM.

This point of this script is that it allows the player to decide which theme to play (in most situations).

[Takami Daisuke]

The event command "Change Battle BGM" changes the BGM for all battles initiated after this point to the selected BGM, evented or otherwise. Simply place the event as an autorun + erase event at the entrances to your dungeons. This should not be confused with "Change BGM", which changes the currently playing BGM.

This point of this script is that it allows the player to decide which theme to play (in most situations).

Thank you to replay me.
I didn't know change bgm of event command is to change all normal battle bgm beacuse I never use it (because I have other bgm change script, and with that script bgm change command hasn't effect)Thank you to expalin.

[SweetyGirly]

I have here problem.. the Quest log do not appear in my status ... and if i run it with scrip scene the game crushes down.. and a message appears...

please help .. thanks

[Mithran]

I have here problem.. the Quest log do not appear in my status ... and if i run it with scrip scene the game crushes down.. and a message appears...
please help .. thanks

This script does not overwrite, it simply appends another option onto the end of the menu. As for the script crashing down, this is an issue with trying to create a bitmap that is too big (most commonly when you have a Window with over 670 or so selections), too small (0 pixels is not a valid size), or for an invalid file type (empty bitmap, etc.). My script does not mess with any of this in any quest scripts, so please seek help on the script support forum or in the author's thread.

[SweetyGirly]

thanks for the tipp mithran^^