From 2e681d17794881662cf5993ba9f906e9a11d64f6 Mon Sep 17 00:00:00 2001
From: Sebastian Pape <pape@vr.rwth-aachen.de>
Date: Wed, 29 Mar 2023 11:36:15 +0200
Subject: [PATCH] Adding Readme

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d4a741a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# Description
+This plugin is written to help with in-game video recordings. For this, it provides an actor that is shaped like a little camera and can be positioned in the world. On play, a second window is opened, which shows the view of the camera. This window can easily be recorded with something like [OBS](https://obsproject.com/de/download).
+
+# Customization
+You can change the rendering resolution of the camera in the actor itself. This also scales the output window accordingly. If you want to be able to grab the camera in-game, just derive a class from it and add your grabbing mechanism.
-- 
GitLab