source/gles2rice/README

   1 ===============================================================================
   2 -------------------------------------------------------------------------------
   3 Mupen64plus-video-rice README                                              v2.0
   4 -------------------------------------------------------------------------------
   5 ===============================================================================
   6
   7 The latest version of this document can be found online at:
   8 https://code.google.com/p/mupen64plus/wiki/HighResolutionTextures
   9
  10 -------------------------------------------------------------------------------
  11 ABOUT
  12 -------------------------------------------------------------------------------
  13 Mupen64Plus's Rice Video plugin supports a very nice feature which allows the
  14 user to replace all of the original textures used for 3D rendering in a game
  15 with high-resolution replacement textures drawn by graphic artists.
  16
  17 -------------------------------------------------------------------------------
  18 Enable Hi-Res Texture Loading in Rice Video
  19 -------------------------------------------------------------------------------
  20
  21 In order to begin using the hi-resolution texture feature, you must enable it
  22 by editing the Mupen64Plus config file. One option is to find the file and edit
  23 it directly with a text editor. On Linux or OSX, this is located at: "~/.config/
  24 mupen64plus/", and on Windows it is in the "Application Data" sub-folder of
  25 your user folder. On Windows XP and prior, this is "C:\Documents and Settings\
  26 <username>\Application Data\Mupen64Plus\", while on Windows Vista and newer
  27 this is "C:\Users\<username>\AppData\Mupen64Plus". You should find a section in
  28 this file labeled [Video-Rice], and within this section is a parameter called
  29 LoadHiResTextures. Set this to True to enable searching for and loading high-
  30 resolution textures.
  31
  32 Another option to enable this feature is to use the --set option with the
  33 Mupen64Plus command-line user interface. To do this, run a game with a command
  34 similar to this:
  35
  36 ./mupen64plus --set Video-Rice[LoadHiResTextures]=True --saveoptions m64p_test_rom.v64
  37
  38 -------------------------------------------------------------------------------
  39 Installing Hi-Res Texture Files
  40 -------------------------------------------------------------------------------
  41
  42 To install a high-resolution texture pack for a game, all that you need to do
  43 is unzip the archive and put the extracted directory full of images into the
  44 right place. On Linux and OSX, this is usually "/home/<username>/.local/share/
  45 mupen64plus/hires_texture". On Windows it is in the "Application Data" sub-
  46 folder of your user folder. On Windows XP and prior, this is "C:\Documents and
  47 Settings\<username>\Application Data\Mupen64Plus\hires_texture", while on
  48 Windows Vista and newer this is "C:\Users\<username>\AppData\Mupen64Plus\
  49    hires_texture". If this directory doesn't exist, create it and copy the
  50 hi-res texture directory inside.
  51
  52 The folder containing hi-res textures must be named exactly the same as the
  53 ROM's name in the header of the ROM file. Usually this name is short with all
  54 capital letters, like "MARIOKART64" or "SMASH BROTHERS". The command-line UI
  55 prints out this ROM name when running a game, right after the Goodname and
  56 before the MD5.
  57
  58 -------------------------------------------------------------------------------
  59 Running
  60 -------------------------------------------------------------------------------
  61
  62 After setup, just run the game as usual. If using the command-line UI, you should
  63 see a line printed out which says:
  64
  65 Video: Texture loading option is enabled. Finding all hires textures
  66
  67