Initial commit
authorLukas Krickl <lukas@krickl.dev>
Sun, 16 Feb 2025 17:49:16 +0000 (18:49 +0100)
committerLukas Krickl <lukas@krickl.dev>
Sun, 16 Feb 2025 17:49:16 +0000 (18:49 +0100)
.gitattributes [new file with mode: 0644]
.gitignore [new file with mode: 0644]
LICENSE [new file with mode: 0644]
README.md [new file with mode: 0644]
index.gmi [new file with mode: 0644]

diff --git a/.gitattributes b/.gitattributes
new file mode 100644 (file)
index 0000000..176a458
--- /dev/null
@@ -0,0 +1 @@
+* text=auto
diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..9008060
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,18 @@
+Copyright 2025 Lukas Krickl (lukas@krickl.dev)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy 
+of this software and associated documentation files (the "Software"), 
+to deal in the Software without restriction, 
+including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, 
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS",
+WITHOUT WARRANTY OF ANY KIND, 
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..51c3df4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# gbrg 
+
+An action rougelike for the gameboy
+
+## Table of content
+
+- [Installation](#Installation)
+- [Usage](#Usage)
+- [License](#License)
+- [Contributing](#Contributing)
+- [TODO](#TODO)
+
+## Installation
+
+To compile this game you will need a copy of `ulas`.
+Then simply run `make` to build the rom.
+
+## Usage
+
+This game is compatible with any gameboy emulator.
+
+### Building assets
+
+To build the assets simply check out the `assets repository` into the `assets` directory and run `make tiles`.
+This is only required if changes to the tileset were made. All 'compiled' tile directories are already included in this repository!
+
+## License
+
+This program is distributed under the terms of the MIT License.
+
+
diff --git a/index.gmi b/index.gmi
new file mode 100644 (file)
index 0000000..c3deea9
--- /dev/null
+++ b/index.gmi
@@ -0,0 +1 @@
+# unlink2's capsule