charset_wrapper function library

Dependencies:

Description

Contains the single function charset_wrapper, an SFO wrapper for HANDLE_CHARSETS.

Public functions

charset_wrapper(from_utf8:b=1, overwrite:b, verbose:b, silent:b, tra_path:s, iconv_path:s, setup_tra:s="setup", load:s, default_language:s="english", extra_tra_folders:s)=(out_path:s) action

Wrapper for HANDLE_CHARSETS. Copies files over to weidu_external/lang/MOD_FOLDER, whether or not conversion is required. Makes sure all tra are present by using default-language ones if preferred-language ones aren't available.

Inputs:

  • from_UTF8 (default=1): set to 0 if your tra files aren't in UTF8
  • overwrite (default=0): set to 1 if you want to regenerate the converted files every run
  • verbose (default=0): set to 1 to get more feedback from HANDLE_CHARSETS
  • silent (default=0): set to 1 if you don't want to be warned when tra files from a folder in the extra_tra_folders list overlap with the main list
  • tra_path (default=""): set to where your tra files are (with or without 'MOD_FOLDER'), if they're not in MOD_FOLDER/tra or MOD_FOLDER/lang or MOD_FOLDER/languages
  • iconv_path (default=""): set to wherever your iconv.exe file is (with or without 'MOD_FOLDER'), if it's not in MOD_FOLDER/%tra_path%/iconv
  • setup_tra (default="setup"): set to whatever you're keeping your WEIDU installation strings in
  • load (default=""): set to a space-separated list of any tra files you want loaded automatically
  • default_language (default="english"): set to whatever language you wrote the mod in.
  • extra_tra_folder (default=""): set to a space-separated list of any additional folders (relative to MOD_FOLDER) containing TRA files.

The returned variable out_path is where the language files are copied to (hardcoded to weidu_external/lang/MOD_FOLDER).