From eac0c23179c9ed438224013aaba67e376d760015 Mon Sep 17 00:00:00 2001
From: OrekiWoof <thezjarek@gmail.com>
Date: Sun, 31 May 2026 02:00:21 +0200
Subject: [PATCH] add readme

---
 .timetracker |  7 ++++++-
 README.md    | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/.timetracker b/.timetracker
index c0aeb92..a1b179c 100644
--- a/.timetracker
+++ b/.timetracker
@@ -1,5 +1,5 @@
 {
- "total": 20296,
+ "total": 20766,
  "sessions": [
   {
    "begin": "2026-03-17T23:54:43+01:00",
@@ -35,6 +35,11 @@
    "begin": "2026-05-31T01:44:30+02:00",
    "end": "2026-05-31T01:51:55+02:00",
    "duration": 445
+  },
+  {
+   "begin": "2026-05-31T01:52:40+02:00",
+   "end": "2026-05-31T02:00:30+02:00",
+   "duration": 470
   }
  ]
 }
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f41c6ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Butterfly Pins
+
+## Requirements for the solution
+
+- .NET 8 SDK for 1.21
+- .NET 10 SDK when building `Version22` for 1.22
+- Vintage Story install - 1.21 or 1.22, with environment variables describing the paths
+- env vars described below
+
+### Required env vars
+
+- `VINTAGE_STORY_21`: path to the 1.21 game install (on Windows default is `%appdata%/VintageStory`)
+- `VINTAGE_STORY_DATA_21`: path to the 1.21 game data directory (on Windows default is `%appdata%/VintageStoryData`)
+- `VINTAGE_STORY_22`: path to the 1.22 game install (`Version22` configuration)
+- `VINTAGE_STORY_DATA_22`: path to the 1.22 game data directory (`Version22` configuration)
+- `VS_CONFIGLIB`: path to `configlib.dll`. If not set, will compile with a warning and without configlib support
+
+## Running
+
+If you know what you're doing, `dotnet build` etc obviously will work. This was created with the official mod template.
+
+### VS Code with `C# Dev Kit` extension
+
+- select appropriate solution configuration: `F1` (run command) -> `.NET: Select a configuration`
+- for 1.21 select `Debug` or `Release`, for 1.22 select `Version22`
+- run action `Start debugging` or `Start without debugging` (might be `f5` and `ctrl+f5` by default)
+
+### Visual Studio
+
+- use configuration picker at the top - `Debug` or `Release` for 1.21, `Version22` for 1.22
+- set ButterflyPins project as the startup project
+- run