Add readme.md

Readme.md

@@ -0,0 +1,21 @@
+# Open 1K OJ
+
+A reimplementation of the game 100% orange juice in the Godot engine
+
+## Requirements 
+Godot version 4.2.1 stable
+
+## Asset notes
+game assets are stored in `.pak` files that can be extracted with any decompression program. Godot may be able to load them directly.
+- texture files are `.dds` files renamed to have file extension `.dat`
+    - Some are obfuscated with a simple XOR cypher. It's easy to crack the key
+    - can be loaded directly
+- Sound files are `.ogg` for bgm and `.oga` for voice. They dont seem to be obfuscated
+    - can be loaded directly
+- locale files are just in plain `.txt`
+    - Need to write a parser
+- fonts are in a binary `.fnt` format.
+    - While Godot is supposed to support it, it throws out a bunch of errors when trying to import them.
+    - Let's try to find the original vector fonts and use those.
+- `event1.pak` and `event2.pak` seem to be obfuscated differently than all the other obfuscated files.
+- shaders are in a unknown-to-me format, and are obfuscated with the simple XOR cypher.