Module: RgssDb::Strings::StrAppEntryPoint

Included in:: EntryPoint

Defined in:: lib/rgss_db/model/strings.rb

Overview

Application information CLI strings

Constant Summary collapse

CLI_INVALID_CALL_MSG = Message shown when the app call is invalid Returns: (String)

<<~INVALID_CALL
  Please provide a RPG Maker database directory!
  Use 'rgss-db --help' to get more information
INVALID_CALL

CLI_VERSION = App version message String contains a “%s” flag to insert the app version Returns: (String)

"rgss-db version %s installed"

CLI_BANNER = App banner contents Returns: (String)

<<~BANNER
  SYNOPSIS
    rgss-db is a tool for developers to export and/or import the database files of a game made in RPG Maker

    This tool works on any RPG Maker editor based on RGSS:
      - RPG Maker XP
      - RPG Maker VX
      - RPG Maker VX Ace

  USAGE
  rgss-db data_directory [options]

  DESCRIPTION
    You can simply use this tool by calling the rgss-db command and supplying a RPG Maker data path:
      # Opens the current directory
      rgss-db .

    The path needs to be the data folder where all binary database files are stored, otherwise the app won't work

    This will open the application's menu where you can manually perform the desired action.

    The application has a number of options that allow you to customize the behavior and output, for example:
      # You can set the application's debug mode with the following option
      # A log file will be created inside the application's working directory
      rgss-db . --debug 0 # Disables debug functionality (default)
      rgss-db . --debug 1 # Enables debug error level
      rgss-db . --debug 2 # Enables debug warning level
      rgss-db . --debug 3 # Enables debug info level

      # You can disable the automatic backup creation with the flag
      rgss-db . --no-backup

      # Sets the application's working directory (used for exporting and importing)
      rgss-db . -d "./custom_path/from/the data folder"

      # Sets the application's file format (used for exporting and importing)
      rgss-db . -t json
      rgss-db . -t yaml
      rgss-db . -t binary # Auto. selects the appropiate binary format

      # Sets a list of data files that will be affected by the action
      # If not provided, it will consider all data files
      rgss-db . -f Items.rvdata2 Weapons.rvdata2 Map001.rvdata2 # Selects "Items", "Weapons" and "Map001" files

      # Sets a list of objects that will be affected by an action (per data file)
      # This option only works for data files that supports this behavior (Actors, Items, States...)
      # The ids that you can provide match the IDs in the database.
      # If not provided it will consider all objects
      rgss-db . -f Items.rvdata2 -i 10 122 # This will consider the items with ID: 10 and 122

      # You can also set the list for each data file (if there is more than one)
      # The object IDs list parameter can be repeated for each data file specified
      rgss-db . -f Actors.rvdata2 Items.rvdata2 -i 10 -i 200 300 # 10 for Actors, 200 and 300 for Items


      You can skip the application's CLI menu completely if you supply a supported action.

      The application will start and perform the action, using the given files and object IDs (if any) and close itself when the action finishes

      These are the possible actions:
      - export: Exports RPG Maker database
      - export_custom: Exports specific objects from the RPG Maker database
      - import: Imports external data into the RPG Maker database
      - import_custom: Imports custom external data into the RPG Maker database (merge)

      Here's a few examples with the action option using the default application directory:
      # Opens the current directory and export all data
      rgss-db . -a export

      # Opens the current directory and import all data
      rgss-db . -a import

      # Opens the current directory and export only the Items file
      rgss-db . -a export -f Items.rvdata2

      # Opens the current directory and export only the object with ID: 100 from the Items file
      rgss-db . -a export_custom -f Items.rvdata2 -i 100

      # Opens the current directory and export only the object with ID: 100 from the Items file to a JSON file
      rgss-db . -a export_custom -f Items.rvdata2 -i 100 -t json

  OPTIONS
BANNER

CLI_OPTION_BACK_UP = App option back up mode info Returns: (String)

"Sets the back up mode"

CLI_OPTION_DEBUG_MODE = App option debug mode info Returns: (String)

"Sets the debug mode"

CLI_OPTION_WORKING_DIR = App option working directory info Returns: (String)

"Sets the working directory"

CLI_OPTION_ACTION = App option action info Returns: (String)

"Sets the action to perform"

CLI_OPTION_FORMAT_TYPE = App option file format type info Returns: (String)

"Specifies the file format type to use"

CLI_OPTION_FILE_ENTRIES = App option file entries info Returns: (String)

"Sets a list of files affected by the action"

CLI_OPTION_IDS = App option object IDs info Returns: (String)

"Sets a list of object IDs that will be affected per file"