README added (with images)

dgarroDC · May 15, 2023 · 3f58c87 · 3f58c87
1 parent 6f39b25
commit 3f58c87
Show file tree

Hide file tree

Showing 27 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# Épicas Album by Damián Garro
+
+![thumbnail](images/thumbnail.jpg)
+
+Adds a new [Custom Ship Log Mode](https://outerwildsmods.com/mods/customshiplogmodes/) to the computer, the Épicas Album. This is a gallery-like UI where you can browse snapshots uploaded from your scout.
+
+Photos are upload by pressing the lock on button (**left click** in the mouse by default). This saves the currently displayed picture (in your helmet HUD or ship cabin screen) into your device and makes it visible in the Épicas Album mode of your ship computer.
+
+The game by default has black and white scout pictures, so a good companion for this mod is the [Color Cameras](https://outerwildsmods.com/mods/colorcameras/) mod; snapshots uploaded while that mod is active will also include color!
+
+![screenshot](images/screenshot.jpg)
+
+This mod could be a great choice for someone that is doing their first playthrough, because you can use the images to remember important stuff without relying to much on the vanilla ship log, although these snapshots don't include text that you could use to keep notes. However, I'm already working on a next mod that lets you add your own ship log entries and will be powered by Épicas to set the photos of your entries, so stay tuned!
+
+All photos are saved in a folder "snapshots" inside of the mod folder. The "snapshots" folder has subfolders with the names of Outer Wilds profiles, in each of these subfolders there are all of the images that the Épicas Album displays (using the current profile). You can also go to this folder in your file explorer by using the "**Show on Disk**" option from the album, although this feature currently only works for Windows.
+
+You can even manually add any image to the album by moving image files (*.png* and *.jpg* supported) to the corresponding folder, but you would need to restart the game or the loop to view it in the album. This also applies to deletion of images, but you can already do this with the "**Delete**" option inside the album and the action would be immediately reflected in the UI, a very useful feature if you take a lot of photos and then want to just keep your most epic takes.
diff --git a/images/screenshot.jpg b/images/screenshot.jpg
diff --git a/images/snapshots/000.png b/images/snapshots/000.png
diff --git a/images/snapshots/001.png b/images/snapshots/001.png
diff --git a/images/snapshots/002.png b/images/snapshots/002.png
diff --git a/images/snapshots/003.png b/images/snapshots/003.png
diff --git a/images/snapshots/004.png b/images/snapshots/004.png
diff --git a/images/snapshots/005.png b/images/snapshots/005.png
diff --git a/images/snapshots/006.png b/images/snapshots/006.png
diff --git a/images/snapshots/007.png b/images/snapshots/007.png
diff --git a/images/snapshots/008.png b/images/snapshots/008.png
diff --git a/images/snapshots/009.png b/images/snapshots/009.png
diff --git a/images/snapshots/010.png b/images/snapshots/010.png
diff --git a/images/snapshots/011.png b/images/snapshots/011.png
diff --git a/images/snapshots/012.png b/images/snapshots/012.png
diff --git a/images/snapshots/013.png b/images/snapshots/013.png
diff --git a/images/snapshots/014.png b/images/snapshots/014.png
diff --git a/images/snapshots/015.png b/images/snapshots/015.png
diff --git a/images/snapshots/016.png b/images/snapshots/016.png
diff --git a/images/snapshots/017.png b/images/snapshots/017.png
diff --git a/images/snapshots/018.png b/images/snapshots/018.png
diff --git a/images/snapshots/019.png b/images/snapshots/019.png
diff --git a/images/snapshots/020.png b/images/snapshots/020.png
diff --git a/images/snapshots/021.png b/images/snapshots/021.png
diff --git a/images/snapshots/022.png b/images/snapshots/022.png
diff --git a/images/thumbnail.jpg b/images/thumbnail.jpg
diff --git a/images/thumbnail_screenshot.jpg b/images/thumbnail_screenshot.jpg