Update README.md

This commit is contained in:
David Vogel 2020-05-30 19:29:39 +02:00
parent 0bc2c9122e
commit 4252e8fbe6

111
README.md
View File

@ -20,7 +20,7 @@ A resulting image with 3.8 gigapixels can be [seen here](https://easyzoom.com/im
1. Have Noita installed.
2. Download the [latest release of the mod from this link](https://github.com/Dadido3/noita-mapcap/releases/latest) (The `Windows.x86.7z`, not the source)
3. Unpack it into your mods folder, so that you get the following file structure `.../Noita/mods/noita-mapcap/mod.xml`.
4. Set your resolution to 1280x720, and use the `Windowed` mode. (Not `Fullscreen (Windowed)`!) If you have to use a different resolution, see advanced usage.
4. Set your resolution to 1280x720, and use the `Windowed` mode. (Not `Fullscreen (Windowed)`!) If you have to use a different resolution, see [Advanced stuff](#advanced-stuff).
5. Enable the mod and restart Noita.
6. In the game you should see text on screen.
- Either press `>> Start capturing map around view <<` to capture in a spiral around your current view.
@ -36,7 +36,61 @@ A resulting image with 3.8 gigapixels can be [seen here](https://easyzoom.com/im
- It will take the screenshots from the `output` folder.
10. The result will be saved as `.../Noita/mods/noita-mapcap/bin/stitch/output.png` if not defined otherwise.
## Advanced usage
## How to do a full map capture with minimal trouble
For the best experience and result, `noita_dev.exe` should be used.
This has the advantage of disabling the fog of war, and it can speed up the capturing process quite a bit, as a larger screen can be captured.
Here is a step by step explanation how to do so:
1. Have the mod installed and enabled as described in [Usage](#usage).
2. Change the following values inside of `.../Noita/mods/noita-mapcap/files/magic_numbers.xml` to
``` xml
<MagicNumbers
VIRTUAL_RESOLUTION_X="840"
VIRTUAL_RESOLUTION_Y="840"
STREAMING_CHUNK_TARGET="12"
...
>
```
3. Change the following values inside of `.../Noita/save_shared/config.xml` (Not the one in AppData!) to
``` xml
<Config
...
backbuffer_height="840"
backbuffer_width="840"
internal_size_h="840"
internal_size_w="840"
window_h="840"
window_w="840"
fullscreen="0"
framerate="600"
...
>
```
If that file doesn't exist do step 5, and come back here, and continue from step 3.
4. Patch your `.../Noita/noita_dev.exe` with [Large Address Aware](https://www.techpowerup.com/forums/threads/large-address-aware.112556/) or a similar tool.
This is optional, but it prevents crashes from noita running out of memory.
5. Start `.../Noita/noita_dev.exe`.
6. When the game is loaded (When you can control your character):
- Press `F5`, `F8` and `F12` (In that order).
- Press `F7`, and disable `mTrailerMode` in the menu. (This should reduce chunk loading problems)
- Press `F7` again to close the menu.
7. Press the `>> Start capturing full map <<` button.
8. Wait a few hours until it's complete.
9. Stitch the image as described in [Usage](#usage).
## Advanced stuff
If you use `noita_dev.exe`, you can enable the debug mode by pressing `F5`. Once in debug mode, you can use `F8` to toggle shaders (Includes fog of war), and you can use `F12` to disable the UI. There are some more options in the `F7` and `Shift + F7` menu.
@ -54,59 +108,6 @@ You can also change how much the tiles overlap by adjusting the `CAPTURE_GRID_SI
The rectangle for the full map capture mode is defined in `.../Noita/mods/noita-mapcap/files/capture.lua`.
## How to do a full map capture with minimal trouble
For the best experience and result, follow these steps:
1. Change the following values inside of `.../Noita/mods/noita-mapcap/files/magic_numbers.xml`:
``` xml
<MagicNumbers
VIRTUAL_RESOLUTION_X="840"
VIRTUAL_RESOLUTION_Y="840"
STREAMING_CHUNK_TARGET="12"
...
>
```
2. Change the following values inside of `.../Noita/save_shared/config.xml`: (Not the one in AppData!)
``` xml
<Config
...
backbuffer_height="840"
backbuffer_width="840"
internal_size_h="840"
internal_size_w="840"
window_h="840"
window_w="840"
fullscreen="0"
framerate="600"
...
>
```
If that file doesn't exist do step 3 and 5, and come back here.
3. Copy `.../Noita/tools_modding/noita_dev.exe` to `.../Noita/noita_dev.exe`.
- Also copy it again, if there was an update.
4. Patch your `.../Noita/noita_dev.exe` with [Large Address Aware](https://www.techpowerup.com/forums/threads/large-address-aware.112556/) or a similar tool.
5. Start `.../Noita/noita_dev.exe`.
- Click `Ignore always` on the `ASSERT FAILED!` requester.
6. When the game is loaded (When you can control your character):
- Press `F5`, `F8` and `F12` (In that order).
- Press `F7`, and disable `mTrailerMode` in the menu. (This should reduce chunk loading problems)
- Press `F7` again to close the menu.
7. Press the `>> Start capturing full map <<` button.
8. Wait a few hours until it's complete.
9. Stitch the image as described above.
## License
[MIT](LICENSE)