From 9d63d0935742e9f9ca32c184cfae18bce3c43ff5 Mon Sep 17 00:00:00 2001
From: SpagettiFisch <63868515+SpagettiFisch@users.noreply.github.com>
Date: Wed, 14 Feb 2024 09:00:30 +0100
Subject: [PATCH] added a read.me

---
 READ.ME | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 READ.ME

diff --git a/READ.ME b/READ.ME
new file mode 100644
index 0000000..bf83747
--- /dev/null
+++ b/READ.ME
@@ -0,0 +1,39 @@
+Brief Explanation of all files and classes and pygame
+
+
+Button CLass:
+Button(position_x, position_y, width, height, font key phrase/word (see dictionary), the function which should be executed, and if the function should be executed while holding the button or only once per press)
+
+fonts = {
+    'medieval': 'medieval.ttf',
+    'minecraft': 'Minecraft Evenings.otf',
+    '3dpixel': '3D-Pixel.ttf',
+    '8bit': '8bitlim.ttf',
+    '8bito': '8blimro.ttf',
+    'arcade': 'ARCADECLASSIC.ttf',
+    'modern_game': 'astron boy video.otf',
+    'modern': 'astron boy.otf',
+    'wonder': 'Beyond Wonderland.ttf',
+    'curved': 'Digitag.ttf',
+    'simple': 'DisposableDroidBB.ttf',
+    'rounded': 'dpcomic.ttf',
+    'playfull': 'Endalian Script.ttf',
+    'blocky': 'FREAKSOFNATURE.ttf',
+    'catchy': 'Future TimeSplitters.otf',
+    'simple_wide': 'Halo3.ttf',
+    'simple_fat': 'INVASION2000.ttf',
+    'very_gamy': 'ka1.ttf',
+    'simple_round': 'Karma Suture.otf',
+    'mono': 'manaspc.ttf',
+    'damaged': 'Merchant Copy.ttf',
+    'big_natural': 'MorialCitadel.TTF',
+    'spacy': 'nasalization-rg.otf',
+    'sci-fi': 'neuropol.otf',
+    'hollow_big_edge': 'papercut.ttf',
+    'space_shuttle': 'pdark.ttf',
+    'thin': 'PixelFJVerdana12pt.ttf',
+    'random': 'Seattle Avenue.ttf',
+    'pixel': 'yoster.ttf'
+}
+
+Pygame window: (0, 0) is in the top left corner, the height and width are stored in HEIGHT and WIDTH
\ No newline at end of file