Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
matti committed May 19, 2019
1 parent d0790c7 commit 5e89693
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 11 deletions.
5 changes: 2 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,8 @@ $(BUILD):
#---------------------------------------------------------------------------------
cia: $(BUILD)
ifneq ($(MAKEROM),)
# $(MAKEROM) -rsf $(OUTPUT).rsf -elf $(OUTPUT).elf -icon $(OUTPUT).icn -banner $(OUTPUT).bnr -f cia -o $(OUTPUT).cia
#$(DEPLOY) $(OUTPUT).3dsx -0 sdmc:/3ds/$(OUTPUT).3dsx
C:/Games/_Retro/3DS/citra/nightly-mingw/citra.exe $(OUTPUT).3dsx
$(MAKEROM) -rsf $(OUTPUT).rsf -elf $(OUTPUT).elf -icon $(OUTPUT).icn -banner $(OUTPUT).bnr -f cia -o $(OUTPUT).cia
$(DEPLOY) $(OUTPUT).3dsx -0 sdmc:/3ds/$(OUTPUT).3dsx
else
$(error "CIA creation is not supported on this platform ($(UNAME_S)_$(UNAME_M))")
endif
Expand Down
24 changes: 17 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@

# IMPORTANT!
This fork includes several new features like custom border and second screen image for each game. You can also swap your game screen (broken screen anyone? :)). In terms of feature requests from the community we now have more hot key options available like Switch Controllers or Quick Save/Load. For all new features see [Change History](#change-history).
This fork includes several new features like custom border and second screen image for each game. You can also swap your game screen (broken screen anyone? :)). There are more hot key options available like Switch to player 2 or Quick Save/Load. For all new features see [Change History](#change-history).

This version is built with most recent devkitARM and libctru. (see [How to Build](#how-to-build))
This version is built with **most recent** devkitARM and libctru. (see [How to Build](#how-to-build))

I haven't noticed any new performance issues on my N3DS so far. Can't tell if it's working on Old 3DS.
See [FAQ](#frequently-asked-questions) if your games don't run properly.

Credits go to ramzinouris fork (https://github.com/ramzinouri/snes9x_3ds) and Asdolos snes9x forwarder (https://github.com/Asdolo/snes9x_3ds_forwarder) regarding custom border and bottom image. You can find the official bubble2k16 version here: https://github.com/bubble2k16/snes9x_3ds/releases


## TODO:
- provide release files (cia, 3dsx)
- zipfile support
- most recent and favorites in the rom menu
- game previews in the rom menu
- expand game info screen
- use it as forwarder

## To use:

Expand Down Expand Up @@ -42,8 +49,8 @@ Feedback and bug reports are welcome. Help with development is also welcome!

1. Go to sd:/snes9x_3ds_data/*<YOUR_GAME_FOLDER>*/
2. If folder is missing, just run the actual game. Folder will be created automatically
3. Place **border.png** (excactly 400px x 240px) and **cover.png** (max 400px x 400px) inside this folder (see examples folder)
4. PNG alpha transparency isn't supported (transparent region appears white).
3. Place **border.png** (excactly 400px x 240px) and **cover.png** (max 400px x 400px) inside this folder
4. PNG alpha transparency isn't supported.
Although you can adjust cover and border image via opacity settings in options tab.


Expand Down Expand Up @@ -80,14 +87,15 @@ Super Mario Kart (selected/active/empty save slots, 2-Player-Switch)

## Frequently Asked Questions

### My Game looks weird / runs slow. What can I do?
### My Game looks weird / runs slow / has sound issues. What can I do?

There are some emulator options, which may improve gaming experience

1.Go to Emulator Options tab and change the In-Frame Palette Changes to either one of the 3 options: Enabled, Disabled Style 1, Disabled Style 2. Color emulation is never perfect because we are using the 3DS GPU for rendering, which doesn't allow us to do what the SNES requires.
2. Go to Emulator Options Tab and change the SRAM Auto-Save Delay to 10 seconds, 60 seconds, or disable it entirely! Don't worry, the SRAM will be saved again when you open the emulator menu.
3. Ensure that your ROM file isn't corrupt. Try another revision or region.
4. Some games are just not running well on this emulator. (see [Compatibility List](http://wiki.gbatemp.net/wiki/Snes9x_for_3DS))
3. Sound issues may be gone after game reset or reload
4. Ensure that your ROM file isn't corrupt. Try another revision or region.
5. Some games are just not running well on this emulator. (see [Compatibility List](http://wiki.gbatemp.net/wiki/Snes9x_for_3DS))


### Why can't I load some games? They are lised as supported on the compatibility list!
Expand Down Expand Up @@ -145,6 +153,8 @@ Try to avoid pressing the Home button or putting the 3DS to sleep. Quit the emul
v1.41
- Fixed hotkey for making screenshot
- Fixed quick save/load (no data abort exceptions anymore)
- Fixed Errors if cover image is missing
- Updated assets (icon, banner, border, cover)

v1.40

Expand Down
2 changes: 1 addition & 1 deletion source/3dsmenu.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#define MENU_HEIGHT (14)
#define DIALOG_HEIGHT (5)

#define SNES9X_VERSION "v1.40"
#define SNES9X_VERSION "v1.41"
#define ANIMATE_TAB_STEPS 3

bool transferGameScreen = false;
Expand Down

0 comments on commit 5e89693

Please sign in to comment.