~ubuntu-branches/ubuntu/trusty/mupen64plus-video-rice/trusty

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Sven Eckelmann
  • Date: 2013-07-05 22:53:25 UTC
  • mfrom: (1.2.2) (3.1.9 experimental)
  • Revision ID: package-import@ubuntu.com-20130705225325-k0fbb2m44xnrju66
Tags: 2.0-1
* New Upstream Version
* Upload to unstable
* debian/control:
  - Build-Depend on debhelper 9.20130604 for support of parameters when
    detecting targets in dh_auto_*
* debian/rules:
  - Work around new debhelper 9.20130624 dh_auto_{clean,test} behavior
    which is causing a FTBFS by adding an explicit
    override_dh_auto_{clean,test} rule
* debian/watch:
  - Verify new upstream versions using GPG key 954F81B094AA5BB226F5

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
How to use high resolution textures in Rice Video 6.1.0 and after
2
 
 
3
 
1. There are two new options added in Rice Video version 6.1.0 under the "Texture Filters" tab
4
 
   LOAD option: "Loading hi-res textures if available"
5
 
   DUMP option: "Dump textures to files"
6
 
 
7
 
 
8
 
2. Dumping textures
9
 
   a. If DUMP option is enabled, all textures used during the game play will be dumpped 
10
 
      into a folder "[your_emulator_main_folder]\plugin\texture_dump\[current game name]\". 
11
 
 
12
 
      [current game name] refers to N64 game internal name.
13
 
      For example, name for Zelda OoT is "THE LEGEND OF ZELDA". 
14
 
      
15
 
      You can use your N64 emulator to check it. For 1964, the internal name is shown
16
 
      as one of the "Rom Information".
17
 
 
18
 
   b. Textures from different games will be dumpped into different folders. 
19
 
      The plugin will create the folder if the folder does not exist.
20
 
 
21
 
   c. Textures are dumpped in either PNG or BMP format
22
 
      - RGBA, IA (intensity and alpha) textures are dumpped in 3 (or 2) files
23
 
    [filename part 1 - 4]_all.png
24
 
        [filename part 1 - 4]_rgb.png
25
 
    [filename part 1 - 4]_a.png if the alpha channel is not all 0xFF
26
 
 
27
 
        Please read the later section regarding filenameing.
28
 
        *_all.png files are 32bit per pixel PNG files with RGBA channels
29
 
        *_rgb.png files are 24bit per pixel PNG files with RGB channels.
30
 
        *_a.png files are 24bit per pixel PNG files with alpha channel only as intensity.
31
 
 
32
 
      - I (intensity only) textures are dumpped in 2 files, the alpha channel is not needed
33
 
        [filename part 1 - 4]_rgb.png
34
 
    [filename part 1 - 4]_all.png
35
 
 
36
 
      - Color indexed textures are dumpped in 1 file
37
 
        [filename part 1 - 4]_ci.bmp
38
 
        ATTENTION here: the color indexed bmp image is palletted image. If you want to modify
39
 
                        this image, you MUST NOT change the pallettes.
40
 
        These palletted BMP files could have either 16 pallettes or 256 pallettes, depending
41
 
        on the original texture format in the N64 game.
42
 
 
43
 
   d. texture dump option can be enabled/disabled during the game play.
44
 
 
45
 
   e. The plugin keeps tracking all dumpped textures of the current game. Textures
46
 
      will not be redumpped if the texture has been dumpped.
47
 
 
48
 
 
49
 
3. Loading high resolution textures
50
 
   a. If LOAD option is enabled, the plugin will try to load it when corresponding texture is used
51
 
      in the game.
52
 
 
53
 
   b. LOAD option can be enabled/disabled during the game play
54
 
 
55
 
   c. All high resolution textures must be placed under folder:
56
 
      "[your_emulator_main_folder]\plugin\hires_texture\[current game name]\"
57
 
 
58
 
   d. [current game name] must match the N64 game internal name
59
 
 
60
 
   e. Under the [current game name] folder, subfolders can be created and textures can be placed
61
 
      into the subfolders. The plugin will search all the subfolders recursively. Subfolders can help
62
 
      to manage all the textures.
63
 
 
64
 
   f. File files and format:
65
 
      In general, high resolution files to be loaded must follow the same filenames as dumpped.
66
 
 
67
 
      - Color indexed textures must be still in palletted BMP format
68
 
      - For RGBA, IA and I textures, you can provide
69
 
            *_rgb.png, *_a.png   or
70
 
            *_rgb.bmp, *_a.bmp   or
71
 
            *_all.png
72
 
      - Don't provide duplicate files for the same textures. If you provide the *_rgb, *_a files
73
 
        and also *_all.png file, the actually loaded files are not determined.
74
 
 
75
 
4. File naming
76
 
 
77
 
   Example: THE LEGEND OF ZELDA#0A74F78C#4#1_rgb.png
78
 
 
79
 
    [part 1]#[part 2]#[part 3]#[part 4]_[part 5].[extension]
80
 
 
81
 
    part 1: The N64 game internal name
82
 
    part 2: CRC32
83
 
    part 3: Texture format in N64 game
84
 
        0 = RGBA
85
 
        1 = YUV
86
 
        2 = CI
87
 
        3 = IA
88
 
        4 = I
89
 
    part 4: Texture size in N64 game
90
 
        0 = 4 bit
91
 
        1 = 8 bit
92
 
        2 = 16 bit
93
 
        3 = 32 bit
94
 
    part 5: dumpped texture format
95
 
        rgb = 24 bit RGB format
96
 
        a   = 24 bit alpha channel only in 24 bit RGB intensity
97
 
        all = 32 bit RGB format
98
 
        ci  = color indexed (BMP) format
99
 
    extension:
100
 
        PNG
101
 
        BMP
102
 
 
103
 
5. How to make your own hi-rez textures
104
 
   a. The hi-rez texture size could be 2, 3 or 4 times as the orginal N64 texture size
105
 
   b. Don't use other customerized texture sizes
106
 
   c. If the original texture has alpha channel, you MUST also provide the alpha channel by
107
 
      - Use *_all.png 32bit format
108
 
      - use both *_rgb and *_a files to provide RGB and alpha separately
109
 
   d. Color indexed textures must be prepared in color indexed format, not in RGB/A format
110
 
   e. Instead of *_rgb.png and *_a.png, you can provide your textures in *_rgb.bmp and *_a.bmp.
111
 
      BMP files are uncompressed, can be loaded faster
112
 
   f. *_rgb.png, *_a.png, *_rgb.bmp, *_a.bmp must be provided in 24 bit RGB format, not in other
113
 
      formats. Alpha *_a.* files must be 24 bit, only in 2 bit or 8 bit
114
 
   g. Filename must be kept the same as the original dumped texture filenames
 
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