C O M R E D 3DS: Difference between revisions

From GameBrew
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Infobox-3DS-Homebrews
{{Infobox 3DS Homebrews
| title = C_O_M_R_E_D
|title=C_O_M_R_E_D
| image = https://dlhb.gamebrew.org/3dshomebrew/C_O_M_R_E_D.jpg|250px
|image=Comred2.png
| type = Other Apps
|description=A theme-able comic reader for the 3DS.
| version=v0.1a
|author=BEPISMAN2
| lastupdated = 2016/10/04
|lastupdated=2016/10/04
| licence = Mixed
|type=Other Apps
| author = BEPISMAN2
|version=alpha 0.1
| website = https://github.com/BEPISMAN2/C_O_M_R_E_D
|license=Mixed
| download = https://dlhb.gamebrew.org/3dshomebrew/C_O_M_R_E_D.rar
|download=https://dlhb.gamebrew.org/3dshomebrews/comred.7z
| source = https://github.com/BEPISMAN2/C_O_M_R_E_D
|website=https://github.com/BEPISMAN2/C_O_M_R_E_D
|source=https://github.com/BEPISMAN2/C_O_M_R_E_D
}}
}}
<youtube>4tj7KhKPMg8</youtube>
C_O_M_R_E_D is an open source theme-able comic reader for the 3DS. The project is no longer in development and only a test theme is loaded from the SD Card.


== C_O_M_R_E_D ==
==Features==
* Read a folder full of images as a comic (supported extensions are .jpg, .png, and .bmp).
* Orientation options: Hold the 3DS Upright and Sideways (Left- and Right-Hand Support).
* Zooming.
* Page Selection (jump to a certain page in the comic).
* Partial theme support.


Open source theme-able comic reader for the 3DS.
==Installation==
Available in CIA and 3DSX formats.
* 3DSX - Put it in your /3ds/ folder and launch with Homebrew Launcher.
* CIA - Install it using a CIA installer of your choice.


In it's current state, this homebrew is incomplete. Only a theme named &quot;test&quot; is loaded from the SD Card (and it has totally unstylish design choices). Do NOT expect this to be a release of any sort at this point in time. Be sure to put the /data/ folder at the root of your SD Card.
Copy the /data/ folder and put it at the root of your SD Card. Your comics/mangas should go in /data/C_O_M_R_E_D/comics/. Setup is similar to Manga Reader:
* Create a directory, and make sure the images are in numerical order.
* The number of zeroes and file extensions in a directory are auto-detected.  
* Make sure all images have the same number of zeroes in front of them, or else the images won't be detected.
* However, the images can have a different file format and still work fine.


==Currently Implemented Features:==
==User guide==
===How to use===
To switch the 3DS Orientation you're in while reading, press the icon next to the Next Page Icon.


* Read a folder full of images as a comic (supported extensions are .jpg, .png, and .bmp)
In the Default theme, this should look like a DS Icon.
* Orientation options: Hold the 3DS Upright and Sideways (Left- and Right-Hand Support)
* Zooming
* Page Selection (jump to a certain page in the comic)
* Partial theme support - see &quot;Themes&quot;


==Planned Features:==
===Creating a Theme===
Replace the images in /data/C_O_M_R_E_D/themes/test/ with your own.


* .cbz / .cbr support
Make sure the images are the right dimensions, and that they use the PNG format.
* Comic/manga downloading feature
* A working options menu
* Automatic re-scaling of images (see &quot;Known Issues&quot;)
* Default Orientation Loading (no need to switch before reading!)
* Better Icons (seriously, the app is ugly af right now)


==screenshots==
Buttons that are displayed at the main menu (53x30px):
https://dlhb.gamebrew.org/3dshomebrew/scr_22_MERGED.png
* read_btn
https://dlhb.gamebrew.org/3dshomebrew/scr_23_MERGED.png
* download_btn
* options_btn
* exit_btn


==How to use==
The image displayed on the top screen when in the main menu and sub-menus (400x240px):
If you're using the 3DSX Build, download the 3DSX and put it in your /3ds/ folder. If you're using the CIA Build, download the CIA and install using a CIA installer of your choice.
* mm_top_scr_bg
* opt_top_scr_bg


Take the /data/ folder from the .zip file and put it at the root of your SD Card. Your comics/mangas should go in /data/C_O_M_R_E_D/comics/. Setup is pretty similar to Manga Reader: create a directory, and make sure the images are in numerical order. The number of zeroes and file extensions in a directory are auto-detected. '''Make sure all images have the same number of zeroes in front of them, or else the images won't be detected.''' However, the images can have a different file format and still work fine.
Same as above, but with the bottom screen instead (320x240px):
* mm_bot_scr_bg
* opt_bot_scr_bg


To switch the 3DS Orientation you're in while reading, press the icon next to the "Next Page" Icon. In the Default theme, this should look like a DS Icon.
Buttons that perform their respective functions while reading (35x35px):
* zoom_in
* zoom_out
* next_pg
* prev_pg
* switch_pg
* menu


==Creating a Theme==
Font used in sub-menus, make sure it's in .ttf format:
Yeah, I know. The Default Theme sucks. Fortunately, you can create your own! Just replace the images in /data/C_O_M_R_E_D/themes/test/ with your own! Make sure the images are the right dimensions, and that they use the PNG format:
* font.ttf


*read_btn/download_btn/options_btn/exit_btn
Specifies the colors used in sub-menus, as well as other info:
These are the buttons that are displayed at the main menu. (53x30px)
* theme.txt
 
*mm_top_scr_bg/opt_top_scr_bg
The image displayed on the top screen when in the main menu and sub-menus, respectively. (400x240px)
 
*mm_bot_scr_bg/opt_bot_scr_bg
Same as above, but with the bottom screen instead. (320x240px)
 
*zoom_in/zoom_out/next_pg/prev_pg/switch_pg/menu
Buttons that perform their respective functions while reading a comic/manga. (35x35px)
 
In addition to the above images, you will also need the following for your theme:
 
*font.ttf
Font used in sub-menus. Make sure it's in the .ttf format.
 
*theme.txt
Specifies the colors used in sub-menus, as well as other info.


===More on theme===
===More on theme===
"theme.txt" uses "headers" to denote the type of info being read. Below each header should contain the content to be used by the program. Here are the following headers used by C_O_M_R_E_D:
theme.txt uses headers to denote the type of info being read. Below each header should contain the content to be used by the program. Here are the following headers used by C_O_M_R_E_D:
*[themeName]
* [themeName]
*[themeDescription]
* [themeDescription]
*[themeCreator]
* [themeCreator]
*[topScreenFontColor]
* [topScreenFontColor]
*[bottomScreenFontColor]
* [bottomScreenFontColor]
*[selectionFontColor]
* [selectionFontColor]


The names should be self-explanatory. The font colors are used in the sub-menus.
The names should be self-explanatory. The font colors are used in the sub-menus.
* [themeName], [themeDescription], and [themeCreator] should have simple text strings on the next line after the header. These strings should take up exactly one line in the file.
* [topScreenFont], [bottomScreenFont], and [selectionFontColor] should have the R, G, and B values directly after the header, in that order. Each line should have the corresponding color value, in hexadecimal.


[themeName], [themeDescription], and [themeCreator] should have simple text strings on the next line after the header. These strings should take up exactly one line in the file.
Here's an example of a valid theme.txt:
[bottomScreenFontColor]
0x00
0x00
0x00
[themeName]
Test
[themeDescription]
Test theme
[themeCreator]
B_E_P_I_S_M_A_N
[topScreenFontColor]
0x00
0xFF
0x00
[selectionFontColor]
0x80
0x80
0x80


[topScreenFont], [bottomScreenFont], and [selectionFontColor] should have the R, G, and B values directly after the header, in that order. Each line should have the corresponding color value, in hexadecimal.
==Screenshots==
https://dlhb.gamebrew.org/3dshomebrews/comred3.png
https://dlhb.gamebrew.org/3dshomebrews/comred4.png


Here's an example of a valid "theme.txt":
==Known issues==
<code>
There's a slight bug with the page selection that will kick you out of the comic if you jump to the last page.
[bottomScreenFontColor]
0x00
0x00
0x00


[themeName]
Due to the limitations of the 3DS, images larger than 1024x1024px will load up distorted. You can use [http://www.fotosizer.com Fotosizer] to manually resize your images.
Test


[themeDescription]
(CIA Release only) If you try to exit by closing the app from the Home Menu, the 3DS will freeze. This is probably due to the fact that the RSF is unoptimized.
Test theme


[themeCreator]
Slight bug with zeroes. Make sure each page has exactly the same number of zeroes, disregarding the number of digits in front.
B_E_P_I_S_M_A_N


[topScreenFontColor]
==Credits==
0x00
Everyone on the 3DS Hacking Discord for helping me with this project's development.
0xFF
* @MarcusD for his File System Wrapper.  
0x00
* @Kartik for granting permission to use code from his 3DS Multidownload app to use in the Comic/Manga Downloading feature (not implemented in C_O_M_E_R_D yet).
 
* @MyLegGuy for the inspiration to write this application in the first place, as well as for his original Manga Reader.
[selectionFontColor]
0x80
0x80
0x80
</code>
 
==Known Issues:==
 
* There's a slight bug with the page selection that will kick you out of the comic if you jump to the last page. This should be fixed in later releases
* Due to the limitations of the 3DS, images larger than 1024x1024px will load up distorted. In the future, I'll try to add automatic scaling for said images so they'll load in-tact on the 3DS. However, for now, use Fotosizer to manually resize your images: http://www.fotosizer.com/
* (CIA Release only) If you try to exit by closing the app from the Home Menu, the 3DS will freeze. This is probably due to the fact that the RSF is unoptimized, this will be fixed later
* Slight bug with zeroes. Make sure each page has exactly the same number of zeroes, disregarding the number of digits in front. This will be fixed soon.


Dependencies (not including dependencies for dependencies):
==External links==
 
* GitHub - https://github.com/SaturnSH2x2/C_O_M_R_E_D
* ctrulib - https://github.com/smealum/ctrulib
* GBAtemp - https://gbatemp.net/threads/alpha-release-c_o_m_r_e_d-open-source-comic-manga-reader-for-your-3ds.440387
* sf2dlib - https://github.com/xerpi/sf2dlib
* sfillib - https://github.com/xerpi/sfillib
* sftdlib - https://github.com/xerpi/sftdlib
 
==Special Thanks:==
 
Everyone on the 3DS Hacking Discord for helping me with this project's development.


* @MarcusD for letting me use his File System Wrapper.
[[Category:3DS homebrew applications]]
* @Kartik for giving me permission to use code from his 3DS Multidownload app to use in the Comic/Manga Downloading feature. NOTE: THIS HAS NOT BEEN IMPLEMENTED YET, I'M CREDITING KARTIK IN ADVANCE.
[[Category:Other 3DS homebrew applications]]
* @MyLegGuy for inspiring me to write this app in the first place, as well as for his original Manga Reader.

Latest revision as of 01:58, 3 February 2022

C_O_M_R_E_D
Comred2.png
General
AuthorBEPISMAN2
TypeOther Apps
Versionalpha 0.1
LicenseMixed
Last Updated2016/10/04
Links
Download
Website
Source

C_O_M_R_E_D is an open source theme-able comic reader for the 3DS. The project is no longer in development and only a test theme is loaded from the SD Card.

Features

  • Read a folder full of images as a comic (supported extensions are .jpg, .png, and .bmp).
  • Orientation options: Hold the 3DS Upright and Sideways (Left- and Right-Hand Support).
  • Zooming.
  • Page Selection (jump to a certain page in the comic).
  • Partial theme support.

Installation

Available in CIA and 3DSX formats.

  • 3DSX - Put it in your /3ds/ folder and launch with Homebrew Launcher.
  • CIA - Install it using a CIA installer of your choice.

Copy the /data/ folder and put it at the root of your SD Card. Your comics/mangas should go in /data/C_O_M_R_E_D/comics/. Setup is similar to Manga Reader:

  • Create a directory, and make sure the images are in numerical order.
  • The number of zeroes and file extensions in a directory are auto-detected.
  • Make sure all images have the same number of zeroes in front of them, or else the images won't be detected.
  • However, the images can have a different file format and still work fine.

User guide

How to use

To switch the 3DS Orientation you're in while reading, press the icon next to the Next Page Icon.

In the Default theme, this should look like a DS Icon.

Creating a Theme

Replace the images in /data/C_O_M_R_E_D/themes/test/ with your own.

Make sure the images are the right dimensions, and that they use the PNG format.

Buttons that are displayed at the main menu (53x30px):

  • read_btn
  • download_btn
  • options_btn
  • exit_btn

The image displayed on the top screen when in the main menu and sub-menus (400x240px):

  • mm_top_scr_bg
  • opt_top_scr_bg

Same as above, but with the bottom screen instead (320x240px):

  • mm_bot_scr_bg
  • opt_bot_scr_bg

Buttons that perform their respective functions while reading (35x35px):

  • zoom_in
  • zoom_out
  • next_pg
  • prev_pg
  • switch_pg
  • menu

Font used in sub-menus, make sure it's in .ttf format:

  • font.ttf

Specifies the colors used in sub-menus, as well as other info:

  • theme.txt

More on theme

theme.txt uses headers to denote the type of info being read. Below each header should contain the content to be used by the program. Here are the following headers used by C_O_M_R_E_D:

  • [themeName]
  • [themeDescription]
  • [themeCreator]
  • [topScreenFontColor]
  • [bottomScreenFontColor]
  • [selectionFontColor]

The names should be self-explanatory. The font colors are used in the sub-menus.

  • [themeName], [themeDescription], and [themeCreator] should have simple text strings on the next line after the header. These strings should take up exactly one line in the file.
  • [topScreenFont], [bottomScreenFont], and [selectionFontColor] should have the R, G, and B values directly after the header, in that order. Each line should have the corresponding color value, in hexadecimal.

Here's an example of a valid theme.txt:

[bottomScreenFontColor]
0x00
0x00
0x00

[themeName]
Test

[themeDescription]
Test theme

[themeCreator]
B_E_P_I_S_M_A_N

[topScreenFontColor]
0x00
0xFF
0x00

[selectionFontColor]
0x80
0x80
0x80

Screenshots

comred3.pngcomred4.png

Known issues

There's a slight bug with the page selection that will kick you out of the comic if you jump to the last page.

Due to the limitations of the 3DS, images larger than 1024x1024px will load up distorted. You can use Fotosizer to manually resize your images.

(CIA Release only) If you try to exit by closing the app from the Home Menu, the 3DS will freeze. This is probably due to the fact that the RSF is unoptimized.

Slight bug with zeroes. Make sure each page has exactly the same number of zeroes, disregarding the number of digits in front.

Credits

Everyone on the 3DS Hacking Discord for helping me with this project's development.

  • @MarcusD for his File System Wrapper.
  • @Kartik for granting permission to use code from his 3DS Multidownload app to use in the Comic/Manga Downloading feature (not implemented in C_O_M_E_R_D yet).
  • @MyLegGuy for the inspiration to write this application in the first place, as well as for his original Manga Reader.

External links

Advertising: