Skip to content

Commit 132e593

Browse files
committed
Update README and bug_report.
1 parent 6a17a1d commit 132e593

File tree

2 files changed

+25
-17
lines changed

2 files changed

+25
-17
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ assignees: ''
77

88
---
99

10+
## Do not report issues with mods on this page. Please report them on the repo for the mods themselves.
11+
1012
## If you have a crash on startup, please make sure your graphics drivers are up to date before submitting a bug report.
1113

12-
**What is your GPU driver version? Old drivers, particularly on Nvidia, are known to cause crashes on boot on 1.1.0. If you are on Nvidia and the game is crashing on boot, please update to driver version 555.85 or newer before opening an issue.**
14+
**What is your GPU driver version? Old drivers, particularly on Nvidia, are known to cause crashes on boot. If you are on Nvidia and the game is crashing on boot, please update to a recent driver version before opening an issue.**
1315

1416
**Have you checked whether this issue is vanilla behavior? In other words, does it occur on original hardware?**
1517

@@ -36,5 +38,8 @@ Please attach a screenshot of the bug.
3638
- GPU: [e.g. NVIDIA GeForce .../Radeon RX .../Intel UHD .../etc.]
3739
- GPU driver: [e.g Nvidia driver 545.XX, AMD driver 24.X.X, etc]
3840

41+
**Mods Installed**
42+
List the mods you had installed and enabled when you encountered the error.
43+
3944
**Additional context**
40-
Add any other context about the problem here.
45+
Add any other context about the problem here.

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Goemon 64: Recompiled
2-
Goemon 64: Recompiled is a project that uses [N64: Recompiled](https://github.com/Mr-Wiseguy/N64Recomp) to **statically recompile** "Mystical Ninja Starring Goemon" (and soon "Goemon's Great Adventure") into a native port with many new features and enhancements. This project uses [RT64](https://github.com/rt64/rt64) as the rendering engine to provide some of these enhancements.
2+
Goemon 64: Recompiled is a project that uses [N64: Recompiled](https://github.com/Mr-Wiseguy/N64Recomp) to **statically recompile** "Mystical Ninja Starring Goemon" (and soon "Goemon's Great Adventure") into a native port with many new features and enhancements. This project uses [RT64](https://github.com/rt64/rt64) as the rendering engine to provide graphical enhancements.
33

44
### [Check out the latest release here](https://github.com/klorfmorf/Goemon64Recomp/releases/latest).
55

@@ -24,12 +24,13 @@ Goemon 64: Recompiled is a project that uses [N64: Recompiled](https://github.co
2424
* [Libraries Used and Projects Referenced](#libraries-used-and-projects-referenced)
2525

2626
## System Requirements
27-
A GPU supporting Direct3D 12.0 (Shader Model 6) or Vulkan 1.2 is required to run this project. The oldest GPUs that should be supported for each vendor are:
27+
A GPU supporting Direct3D 12.0 (Shader Model 6), Vulkan 1.2, or Metal Argument Buffers Tier 2 support is required to run this project. The oldest GPUs that should be supported for each vendor are:
2828
* GeForce GT 630
2929
* Radeon HD 7750 (the one from 2012, not to be confused with the RX 7000 series) and newer
3030
* Intel HD 510 (Skylake)
31+
* A Mac with Apple Silicon or an Intel 7th Gen CPU with MacOS 13.0+
3132

32-
A CPU supporting the SSE4.1 instruction set is also required (Intel Core 2 Penryn series or AMD Bulldozer and newer).
33+
On x86-64 PCs, a CPU supporting the AVX instruction set is also required (Intel Core 2000 series or AMD Bulldozer and newer). ARM64 builds will work on any ARM64 CPU.
3334

3435
If you have issues with crashes on startup, make sure your graphics drivers are fully up to date.
3536

@@ -54,6 +55,11 @@ Any aspect ratio is supported, with most effects modded to work correctly in wid
5455

5556
**Note**: Some animation quirks can be seen at the edges of the screen in certain cutscenes when using very wide aspect ratios.
5657

58+
#### Mod Support
59+
Install community made mods and texture packs! Mods can change any part of the game, including adding completely new features and content. You can install mods by simply dragging the mod files onto the game window before starting the game or by clicking the **Install Mods** button in the mod menu. Mods can be toggled in the mod menu, and some mods can be configured there as well.
60+
61+
If you're interested in making mods for this project, check out [the mod template](https://github.com/klorfmorf/MNSGRecompModTemplate) and [the modding documentation](https://hackmd.io/fMDiGEJ9TBSjomuZZOgzNg). If you're interested in making texture packs, check out [the RT64 documentation](https://github.com/rt64/rt64/blob/main/TEXTURE-PACKS.md).
62+
5763
#### Additional Control Options
5864
Customize your experience by setting your stick deadzone to your liking.
5965

@@ -64,16 +70,13 @@ This project has been optimized to have as little input lag as possible, making
6470
Saving and loading files, going from place to place, and pausing all happen in the blink of an eye thanks to the game running natively on modern hardware.
6571

6672
#### Linux and Steam Deck Support
67-
A Linux binary is available for playing on most up-to-date distros, including on the Steam Deck.
73+
A Linux binary as well as a Flatpak is available for playing on most up-to-date distros, including on the Steam Deck.
6874

6975
To play on Steam Deck, extract the Linux build onto your deck. Then, in desktop mode, right click the Goemon64Recompiled executable file and select "Add to Steam". From there, you can return to Gaming mode and configure the controls as needed. See the [Steam Deck gyro aim FAQ section](#how-do-i-set-up-gyro-aiming-on-steam-deck) for more detailed instructions.
7076

7177
## Planned Features
7278
* Goemon's Great Adventure support
73-
* Mod support and Randomizer
74-
* Texture Packs
75-
* Model Replacements
76-
* Ray Tracing (via RT64)
79+
* Ray Tracing and Higher Quality Model Replacements (via RT64)
7780

7881
## FAQ
7982

@@ -93,15 +96,17 @@ You'll probably also want to change the default behavior so that you don't need
9396
#### Where is the savefile stored?
9497
- Windows: `%LOCALAPPDATA%\Goemon64Recompiled\saves`
9598
- Linux: `~/.config/Goemon64Recompiled/saves`
99+
- macOS: `~/Library/Application Support/Zelda64Recompiled/saves`
96100

97101
#### How do I choose a different ROM?
98-
**You don't.** This project is **only** a port of the US version of "Mystical Ninja Starring Goemon". The expected format is .z64, though ROMs in formats will be automatically converted, as long as it is the correct ROM. **It is not an emulator and it cannot run any arbitrary ROM.**
102+
**You don't.** This project is **only** a port of Mystical Ninja Starring Goemon (and Goemon's Great Adventure in the future), and it will only accept one specific ROM: the US version of the N64 release of Mystical Ninja Starring Goemon. ROMs in formats other than .z64 will be automatically converted, as long as it is the correct ROM. **It is not an emulator and it cannot run any arbitrary ROM.**
99103

100-
If you want to play a modded ROM or in another language, note that support for modding and other languages will be added to the project itself in the future and will not rely on you supplying a different ROM.
104+
Instead, you can change the game by installing mods. See the [mod support](#mod-support) section for details.
105+
106+
#### Can you run this project as a portable application?
107+
Yes, if you place a file named `portable.txt` in the same folder as the executable then this project will run in portable mode. In portable mode, the save files, config files, and mods are placed in the same folder as the executable.
101108

102109
## Known Issues
103-
* Intel GPUs on Linux may not currently work. If you have experience with Vulkan development on Linux, help here would be greatly appreciated!
104-
* The prebuilt Linux binary may not work correctly on some distributions of Linux. If you encounter such an issue, building the project locally yourself is recommended. A Flatpak or AppImage may be provided in the future to solve this issue. Adding the Linux version to Steam and setting "Steam Linux Runtime" as the compatibility tool or launching it via Gamescope may work around the issue. Alternatively, running the Windows version with Proton is known to work well and may also work around this issue.
105110
* Overlays such as MSI Afterburner and other software such as Wallpaper Engine can cause performance issues with this project that prevent the game from rendering correctly. Disabling such software is recommended.
106111

107112
## Building
@@ -117,6 +122,4 @@ Building is not required to play this project, as prebuilt binaries (which do no
117122
* [Gamepad Motion Helpers](https://github.com/JibbSmart/GamepadMotionHelpers) for sensor fusion and calibration algorithms to implement gyro aiming
118123
* [Ares emulator](https://github.com/ares-emulator/ares) for RSP vector instruction reference implementations, used in RSP recompilation
119124

120-
Special thanks to [Jingleboy of Goemon International](https://goemoninternational.com) for drawing the icon/background graphic of Goemon's head!
121-
122-
Special thanks to [thecozies](https://github.com/thecozies) for designing and helping implement the launcher and config menus!
125+
Special thanks to [Jingleboy of Goemon International](https://goemoninternational.com) for designing and drawing the icon/background graphic!

0 commit comments

Comments
 (0)