Title Screen Aqua

[Zerbu 40]

Zerbu Engine Aqua is now cancelled because it's become too much work and I don't really have the time to make it, sorry. This is now a standalone script.

 

 

This script gives you control over the title screen, from customizing its appearance to adding extra options to it.

 

Features:

• Change the window and font options specifically for the title screen.
  
• Change the width and position of the title menu.
  
• Change the font and position of the game title, if you have it displayed.
  
• Randomize the title graphic and/or music.
  
• Add a BGS and/or ME to the title screen.
  
• Add your own custom "New Game" type options to the menu, with different starting positions. Also, unlike the script in the first engine, this one lets you add more than one option.
  
• Construct the title menu with options in the order you choose.
  
• The option not to show the continue option if there are no save files.
  
• Add a radial animation to the title screen, like VX's battle system.
  

 

 

#============================================================================
# ? Title Screen Aqua ?
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# This script gives you control over the title screen, from customizing
# its appearance to adding extra options to it~
#============================================================================

$imported = {} if $imported.nil?
$imported["zeaq_titlescreen"] = true

module ZEAQ
 module TitleScreen

   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ? Appearance Options ?
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # These options configure the appearance of the title screen. You can
   # customize these to make the title screen stand out!
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   # Enable custom appearance?
   # If this setting is false, the font and Windowskin options will remain
   # unchanged from the default.
   CHANGE_APPEARANCE = false

   # Font Options
   FONT_FACE = ["VL Gothic", "Verdana", "Arial", "Courier"] # Font name
   FONT_SIZE = 24       # Font size used on the title screen
   FONT_COL = [255, 255, 255] # The colour of text ([red, blue, green])
   FONT_BOLD = false    # Whether or not text should appear bold
   FONT_ITALIC = false  # Whether or not text should appear italic
   FONT_SHADOW = false  # Whether or not text should have a shadow
   FONT_OUTLINE = true  # Whether or not text should have an outline
   FONT_OUT_COL = [0, 0, 0] # The colour of the outline ([red, blue, green])

   # Window Options
   WINDOWSKIN = "Window" # Windowskin used on the title screen
   OPACITY = 255         # Opacity (how visible) level of the Windowskin
   BACK_OPACITY = 200    # Opacity of the back of the Windowskin
   PADDING = 12          # The padding of text in the Window
   PADDING_BOTTOM = 12   # The bottom padding of text in the Window

   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ? Size and Position Options ?
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # These options configure the position of the window on the title screen.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   # Enable custom size and/or position?
   # If this setting is false, the position of the Window will remain
   # unchanged from the default.
   CHANGE_SIZE_POSITION = false

   # Size Options
   WINDOW_WIDTH = 175  # Window width; if 0, the default will be used

   # Position Options
   WINDOW_X = 20 # Window X position; if -1, the default will be used
   WINDOW_Y = 20 # Window Y position; if -1, the default will be used

   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ? Game Title Options ?
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # These options allow you to customize how the game title will be
   # displayed on the title screen, if you've chosen to display it.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   # Font Options
   NAME_FONT = ["VL Gothic", "Verdana", "Arial", "Courier"] # Font name
   NAME_SIZE = 48      # Font size used on the title screen
   NAME_COL = [255, 255, 255] # The colour of text ([red, blue, green])
   NAME_BOLD = true    # Whether or not text should appear bold
   NAME_ITALIC = true  # Whether or not text should appear italic
   NAME_SHADOW = true  # Whether or not text should have a shadow
   NAME_OUTLINE = true # Whether or not text should have an outline
   NAME_OUT_COL = [0, 0, 0] # The colour of the outline ([red, blue, green])

   # Position Options
   NAME_X = 0     # X movement from position on the screen
   NAME_Y = 68    # Y movement from top of the screen
   NAME_ALIGN = 1 # 0-Left; 1-Middle; 2-Right

   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ? Graphic and Sound Options ?
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # These options allow you to customize the graphic and sound on the title
   # screen using advanced options.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   # Here you can create a list of graphics that can be displayed on the title
   # screen. A random one from the list is shown every time the title screen
   # is shown, so you aren't stuck with just one graphic.
   # The format to use is: ["Title1", "Title2"],
   GRAPHICS = [
           ["Crystal", "Gargoyles"],
           ["CrossedSwords", "Dragons"],
           ["Fountain", ""],
           ["Gates", "Heroes"],
   ]

   # Here you can create a list of music to play on the title screen, and/or
   # add a BGS or ME to the title screen.
   #
   # The format to use is:
   # [["BGM", Volume, Pitch], ["BGS", Volume, "Pitch"], ["ME", Volume, Pitch]]
   #
   # If you don't want to use a BGS, ME or even don't want a BGM, but want
   # other sounds, set the one(s) you don't want to "nil"
   # [["BGM", Volume, Pitch], nil, nil] will produce a BGM only.
   # [["BGM", Volume, Pitch], ["BGS", Volume, "Pitch"], nil] will produce a BGM
   # and BGS.
   SOUNDS = [
           [["Theme2", 100, 100], ["Darkness", 100, 100], ["Shock", 100, 100]],
           [["Theme3", 100, 100], nil, nil],
           [["Theme4", 100, 100], ["Fire", 70, 100], nil],
           [["Theme5", 100, 100], nil, ["Victory2", 100, 100]],
   ]

   # This option sets whether sounds and graphics should be linked together. If
   # this is set to true, the first sound in the sounds list will always play
   # with the first graphic in the graphics list, the second sound with the
   # second graphic, and so on. If this is false, the graphics and sounds will
   # be randomized completely seperate from each other. If you enable this
   # option, you will need to have the same amount of graphics and sounds or
   # else the title screen could appear with no graphic or no sound.
   CONNECT_GRAPHICS_AND_SOUNDS = true

   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ? Title Screen Menu ?
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # This allows you to list the options that will appear on the title
   # screen, in the order they should appear. Scroll further down to define
   # your own custom options.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   MENU_OPTIONS = [
           :new_game,
           :continue,
           #:custom1,
           #:custom2,
           :shutdown,
   ]
   SHOW_CONTINUE = true # Show continue if there are no save files?

   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ? Normal Menu Options ?
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # These are the normal menu options that have their own scripts to run.
   # If you are using a script that is meant to add an option to the title
   # screen, you can add it here.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ID:    The name and method of the option to be called from the option
   #        above. This is also the name of the handler used.
   # Name:  The name to be displayed on the title menu.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   NORMAL_OPTIONS = {
           #--------------------------------#
           # ID        => "Name",           #
           #--------------------------------#
           :new_game   => "New Game",
           :continue   => "Continue",
           :shutdown   => "Shutdown",
   }

   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ? Extra Starting Positions ?
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # This allows you to add your own additional "New Game"-type options
   # where you can choose different starting positions.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ID:    The technical name of the extra option to be called from the
   #        option above.
   # Name:  The name to be displayed on the title menu.
   # Map:   The map where the players start when using this extra option.
   # Map X: The X position on the map.
   # Map Y: The Y position on the map.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   EXTRA_OPTIONS = {
           #---------------------------------------------------#
           # ID        => ["Name",           Map, MapX, MapY], #
           #---------------------------------------------------#
           :custom1    => ["Tutorial",       3,   10,   12  ],
           :custom2    => ["Credits",        4,   4,    2   ],
   }

   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # ? Radial Animation Options ?
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # Here you can create an animation for the title screen background,
   # similar to RPG Maker VX's default battle system.
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   # Enable?
   RADIAL_ANIMATION = false

   # Blur Options
   RADIAL_BLUR_ANGLE = 80 # Radial blur angle
   RADIAL_BLUR_DIVISION = 12 # Radial blur division (smoothness)

   # Wave Options
   WAVE_AMP = 8      # Wave amplitude
   WAVE_LENGTH = 240 # Wave frequency
   WAVE_SPEED = 120  # Wave speed

 end #TitleScreen
end #ZEAQ

class Window_TitleCommand < Window_Command
 alias zeaq_titlescreen_initialize initialize
 def initialize
   zeaq_titlescreen_initialize
   if ZEAQ::TitleScreen::CHANGE_APPEARANCE
     self.windowskin     = Cache.system(ZEAQ::TitleScreen::WINDOWSKIN)
     self.opacity        = ZEAQ::TitleScreen::OPACITY
     self.back_opacity   = ZEAQ::TitleScreen::BACK_OPACITY
     self.padding        = ZEAQ::TitleScreen::PADDING
     self.padding_bottom = ZEAQ::TitleScreen::PADDING_BOTTOM
   end
 end
 alias zeaq_titlescreen_draw_item draw_item
 def draw_item(index)
   if ZEAQ::TitleScreen::CHANGE_APPEARANCE
     contents.font.name      = ZEAQ::TitleScreen::FONT_FACE
     contents.font.size      = ZEAQ::TitleScreen::FONT_SIZE
     contents.font.color     = Color.new(ZEAQ::TitleScreen::FONT_COL[0], ZEAQ::TitleScreen::FONT_COL[1], ZEAQ::TitleScreen::FONT_COL[2])
     contents.font.bold      = ZEAQ::TitleScreen::FONT_BOLD
     contents.font.italic    = ZEAQ::TitleScreen::FONT_ITALIC
     contents.font.shadow    = ZEAQ::TitleScreen::FONT_SHADOW
     contents.font.outline   = ZEAQ::TitleScreen::FONT_OUTLINE
     contents.font.out_color = Color.new(ZEAQ::TitleScreen::FONT_OUT_COL[0], ZEAQ::TitleScreen::FONT_OUT_COL[1], ZEAQ::TitleScreen::FONT_OUT_COL[2])
   end
   zeaq_titlescreen_draw_item(index)
 end
 alias zeaq_titlescreen_window_width window_width
 def window_width
   if ZEAQ::TitleScreen::WINDOW_WIDTH != 0 && ZEAQ::TitleScreen::CHANGE_SIZE_POSITION
     return ZEAQ::TitleScreen::WINDOW_WIDTH
   else
     zeaq_titlescreen_window_width
   end
 end
 def update_placement
   if ZEAQ::TitleScreen::WINDOW_X != -1 && ZEAQ::TitleScreen::CHANGE_SIZE_POSITION
     self.x = ZEAQ::TitleScreen::WINDOW_X
   else
     self.x = (Graphics.width - width) / 2
   end
   if ZEAQ::TitleScreen::WINDOW_Y != -1 && ZEAQ::TitleScreen::CHANGE_SIZE_POSITION
     self.y = ZEAQ::TitleScreen::WINDOW_Y
   else
     self.y = (Graphics.height * 1.6 - height) / 2
   end
 end
 def make_command_list
   ZEAQ::TitleScreen::MENU_OPTIONS.each{|n|
     if ZEAQ::TitleScreen::NORMAL_OPTIONS[n]
       if n == :continue && !continue_enabled && ZEAQ::TitleScreen::SHOW_CONTINUE
         add_command(ZEAQ::TitleScreen::NORMAL_OPTIONS[n], n, false)
       else
         add_command(ZEAQ::TitleScreen::NORMAL_OPTIONS[n], n, true)
       end
     end
     if ZEAQ::TitleScreen::EXTRA_OPTIONS[n]
       add_command(ZEAQ::TitleScreen::EXTRA_OPTIONS[n][0], :zeaq_command, true, ZEAQ::TitleScreen::EXTRA_OPTIONS[n])
     end
   }
 end
end

class Scene_Title < Scene_Base
 alias zeaq_titlescreen_start start
 def start
   if ZEAQ::TitleScreen::CONNECT_GRAPHICS_AND_SOUNDS
     if ZEAQ::TitleScreen::GRAPHICS.size >= ZEAQ::TitleScreen::SOUNDS.size
       @random_value = rand(ZEAQ::TitleScreen::GRAPHICS.size)
     else
       @random_value = rand(ZEAQ::TitleScreen::SOUNDS.size)
     end
   end
   zeaq_titlescreen_start
 end
 def create_background
   if @random_value
     graphic = ZEAQ::TitleScreen::GRAPHICS[@random_value]
   else
     graphic = ZEAQ::TitleScreen::GRAPHICS[rand(ZEAQ::TitleScreen::GRAPHICS.size)]
   end
   @sprite1 = Sprite.new
   @sprite1.bitmap = Cache.title1(graphic[0])
   if ZEAQ::TitleScreen::RADIAL_ANIMATION
     @sprite1.bitmap.radial_blur(ZEAQ::TitleScreen::RADIAL_BLUR_ANGLE, ZEAQ::TitleScreen::RADIAL_BLUR_DIVISION)
     @sprite1.wave_amp = ZEAQ::TitleScreen::WAVE_AMP
     @sprite1.wave_length = ZEAQ::TitleScreen::WAVE_LENGTH
     @sprite1.wave_speed = ZEAQ::TitleScreen::WAVE_SPEED
   end
   @sprite2 = Sprite.new
   @sprite2.bitmap = Cache.title2(graphic[1])
   center_sprite(@sprite1)
   center_sprite(@sprite2)
 end
 def draw_game_title
   @foreground_sprite.bitmap.font.name = ZEAQ::TitleScreen::NAME_FONT
   @foreground_sprite.bitmap.font.size = ZEAQ::TitleScreen::NAME_SIZE
   @foreground_sprite.bitmap.font.color = Color.new(ZEAQ::TitleScreen::NAME_COL[0], ZEAQ::TitleScreen::NAME_COL[1], ZEAQ::TitleScreen::NAME_COL[2])
   @foreground_sprite.bitmap.font.bold = ZEAQ::TitleScreen::NAME_BOLD
   @foreground_sprite.bitmap.font.italic = ZEAQ::TitleScreen::NAME_ITALIC
   @foreground_sprite.bitmap.font.shadow = ZEAQ::TitleScreen::NAME_SHADOW
   @foreground_sprite.bitmap.font.outline = ZEAQ::TitleScreen::NAME_OUTLINE
   @foreground_sprite.bitmap.font.out_color = Color.new(ZEAQ::TitleScreen::NAME_OUT_COL[0], ZEAQ::TitleScreen::NAME_OUT_COL[1], ZEAQ::TitleScreen::NAME_OUT_COL[2])
   rect = Rect.new(ZEAQ::TitleScreen::NAME_X, ZEAQ::TitleScreen::NAME_Y, Graphics.width, ZEAQ::TitleScreen::NAME_SIZE)
   @foreground_sprite.bitmap.draw_text(rect, $data_system.game_title, ZEAQ::TitleScreen::NAME_ALIGN)
 end
 def play_title_music
   RPG::BGS.stop
   RPG::ME.stop
   if @random_value
     sound = ZEAQ::TitleScreen::SOUNDS[@random_value]
   else
     sound = ZEAQ::TitleScreen::SOUNDS[rand(ZEAQ::TitleScreen::SOUNDS.size)]
   end
   RPG::BGM.stop if !sound[0].nil?
   if !sound[2].nil?
     RPG::ME.new(sound[2][0], sound[2][1], sound[2][2]).play
   end
   if !sound[0].nil?
     RPG::BGM.new(sound[0][0], sound[0][1], sound[0][2]).play
   end
   if !sound[1].nil?
     RPG::BGS.new(sound[1][0], sound[1][1], sound[1][2]).play
   end
 end
 def zeaq_titlescreen_command
   n = @command_window.current_ext
   DataManager.create_game_objects
   $game_party.setup_starting_members
   $game_map.setup(n[1])
   $game_player.moveto(n[2], n[3])
   $game_player.refresh
   Graphics.frame_count = 0
   close_command_window
   fadeout_all
   $game_map.autoplay
   SceneManager.goto(Scene_Map)
 end
 alias zeaq_titlescreen_create_command_window create_command_window
   def create_command_window
   zeaq_titlescreen_create_command_window
   @command_window.set_handler(:zeaq_command, method(:zeaq_titlescreen_command))
 end
 alias zeaq_titlescreen_update update
 def update
   zeaq_titlescreen_update
   if ZEAQ::TitleScreen::RADIAL_ANIMATION
     @sprite1.update
   end
 end
end

 

 

Edited January 12, 2012 by Zerbu

[A. 51]

Just a thought: you end your comments to your script half way down. people who have never used RGSS, ruby or what ever and want to learn wont be able to from your script, because unlike us they might not be able to read code like a book. always comment your code throughout.

[Seiryuki 14]

I actually thought the documentation was really well done. This type of script has a lot of customisations and this form of documentation helps a lot more.

 

Anyways, I like the customisation of this script.

So, the Custom Options leads the player to different maps?......Interesting, and cool. I may definitely use this. Thanks!

Edited January 10, 2012 by Seiryuki

[Balthier99 24]

Excelent script, I'm definitively going to use it!

 

Question: If I add a "New Game Plus" Option, or a "Chapter 2" option to the Title Screen, for example, is there a way for the player to only be able to select it if he finished the first (turned on the final swicth, for example)?

[Zerbu 40]

Excelent script, I'm definitively going to use it!

 

Question: If I add a "New Game Plus" Option, or a "Chapter 2" option to the Title Screen, for example, is there a way for the player to only be able to select it if he finished the first (turned on the final swicth, for example)?

 

Thanks, and sorry but that's not possible as it would require some way to scan through all the save files to get the switch. Maybe I could add a way to do that by putting some kind of marker in the game directory, but that would be insecure and people could cheat to get access to the extra options.

Edited January 10, 2012 by Zerbu

[Azareal 6]

Just a thought: you end your comments to your script half way down. people who have never used RGSS, ruby or what ever and want to learn wont be able to from your script, because unlike us they might not be able to read code like a book. always comment your code throughout.

If you have no coding knowledge then, none of this would make sense to you. Period.

Reading a tutorial to learn how the engine works is a fundamental part of learning how to code such scripts.

 

 

That said, it overall looks like quite a good script and it's documented much better than some of the other scripts I've seen here.

[Zerbu 40]

I've fixed a problem with the alignment of the script (I had it stored in a text editor and didn't realise that it came out wrong when copied and pasted from here into the script editor), I also fixed a bug in calling the SHOW_CONTINUE constant.

[ShinGamix 101]

Is Zerbu Engine something available for VX. Hence it is going to be a full version in Ace since it is too much work.

This is a very handy title script. Just add a few more options from HK animated title and you would have the best tile screen ever, but you are already real close.

 

Any way to use the "Radial Animation" over the battle background to tweak it to look like Chrono Trigger's Final Battle With Lavos?

Edited February 8, 2012 by ShinGamix

[Wendell 81]

Man, very nice script. I'm trying to use it, but when I test the game an error occurs:

 

Script 'Cache' line 108: NoMethodError occurred.

undefined method `empty?' for nil:NilClass

 

what's wrong? I really want to use your script :/

[ShinGamix 101]

I am going to see if I get the same error Wendell and I will get back to you later today in an edit.