Updates

fusionengine-org · Aug 24, 2023 · 4cecc6b · 4cecc6b
1 parent 150b173
commit 4cecc6b
Show file tree

Hide file tree

Showing 18 changed files with 126 additions and 40 deletions.
diff --git a/docs/api/api.md b/docs/api/api.md
@@ -103,4 +103,3 @@ set_volume(volume: int)
 fadeout(time: str)
 ```
 
-[Back](<https://dimkauzh.github.io/fusion-engine/docs/index.html>)
diff --git a/docs/api/color.md b/docs/api/color.md
@@ -45,5 +45,8 @@ AZURE = (0, 128, 255, 255)
 ```python
 hex_to_rgba(hex)
 ```
+<<<<<<< Updated upstream
 
 [Back](<https://dimkauzh.github.io/fusion-engine/docs/index.html>)
+=======
+>>>>>>> Stashed changes
diff --git a/docs/api/fonts.md b/docs/api/fonts.md
@@ -7,4 +7,3 @@ NUNITO_LIGHT
 SAIRACONDENSED_EXTRABOLD
 ```
 
-[Back](<https://dimkauzh.github.io/fusion-engine/docs/index.html>)
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,23 @@
+# Api
+
+Welcome to our api! Here you will find all functions that exist in fusion engine and what arguments they get.
+We have seperated the api in some parts, like main api, color api and more. You choose one you need.
+Can't find something? Then try looking in the main api/
+So have luck!
+
+## Table of contents
+ - [Main API](api.md)
+  - Main
+  - Window
+  - Event
+  - Draw
+  - Image
+  - Body
+  - Shape
+  - UI
+  - Debug
+  - Vector
+  - Sound
+ -[Color API](color.md)
+ -[Font API](fonts.md)
+ -[Key API](keys.md)
diff --git a/docs/api/keys.md b/docs/api/keys.md
@@ -239,5 +239,3 @@
 	KEY_EJECT = sdl2.SDLK_EJECT
 	KEY_SLEEP = sdl2.SDLK_SLEEP
 ```
-
-[Back](<https://dimkauzh.github.io/fusion-engine/docs/index.html>)
diff --git a/docs/api/math.md b/docs/api/math.md
@@ -4,8 +4,12 @@
 ```python
 PI = 3.141592653589793238462643383279502884197
 EULERNUMBER = 2.718281828459045
+<<<<<<< Updated upstream
 main.math.FLOOR(3.4)
 ```
 
 
-[Back](<https://dimkauzh.github.io/fusion-engine/docs/index.html>)
+[Back](<https://dimkauzh.github.io/fusion-engine/docs/index.html>)
+=======
+```
+>>>>>>> Stashed changes
diff --git a/docs/index.md b/docs/index.md
@@ -1,24 +1,23 @@
 # Fusion Engine Documentation
 
 ## 🗜️ Table of Contents
-Choose what api you need or click next to get send to the first api page
+Welcome to fusion engine documentation! We have seperated the documentation in some parts: main, api, wiki and tutorial. 
+Wiki is made if you need to know what a function does.
+Api is made if you need to know if a function exist and what arguments it takes
+And in tutorials we made some tutorials for you to better understand fusion!
+
 
 ### Wiki
  - [Setting up](#setting-up)
- - [Api](<https://dimkauzh.github.io/fusion-engine/docs/wiki/wiki.html>)
- - [Color Wiki](<https://dimkauzh.github.io/fusion-engine/docs/wiki/color.html>)
- - [Font Wiki](<https://dimkauzh.github.io/fusion-engine/docs/wiki/fonts.html>)
- - [Key Wiki](<https://dimkauzh.github.io/fusion-engine/docs/wiki/keys.html>)
- - [Math Wiki](<https://dimkauzh.github.io/fusion-engine/docs/wiki/math.html>)
+ - [Api](wiki/index.md)
 
 ### Api
- - [API](<https://dimkauzh.github.io/fusion-engine/docs/api/api.html>)
- - [Color API](<https://dimkauzh.github.io/fusion-engine/docs/api/color.html>)
- - [Font API](<https://dimkauzh.github.io/fusion-engine/docs/api/fonts.html>)
- - [Key API](<https://dimkauzh.github.io/fusion-engine/docs/api/keys.html>)
- - [Math API](<https://dimkauzh.github.io/fusion-engine/docs/api/math.html>)
-
+ - [Setting up](#setting-up)
+ - [API](api/api.md)
 
+### Tutorials
+ - [Tutorials](tutorials/index.md)
+
 
 ## 💻 Setting up
 

diff --git a/docs/tutorials/basics.md b/docs/tutorials/basics.md
@@ -1,9 +1,9 @@
 # Basic rendering tutorial
 
 ## Introduction
-This is a tutorial so you would understand the basics of the engine and how it works. In this tutorial we will learn how to render a window and draw some images on it. If you want to learn more, then go to [our docs](,https://dimkauzh.github.io/fusion-engine/docs/index.html.) and select wiki.
+This is a tutorial so you would understand the basics of the engine and how it works. In this tutorial we will learn how to render a window and draw some images on it. If you want to learn more, then go to [our docs](docs.fusion-engine.tech) and select wiki.
 
-This tutorial also expect you to have everything setup, if not, head over to [tutorial 1: setting everything up](<imkauzh.github.io/fusion-engine/docs/tutorials/setup.html>)
+This tutorial also expect you to have everything setup, if not, head over to [tutorial 1: setting everything up](setup.md)
 
 ## Creating a window
 

diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md
@@ -12,12 +12,12 @@ Navigating through these tutorials is as easy as a summer breeze. Take a look at
 ### 🗺️ Tutorial 1: Setting Everything Up
 Ahoy, brave learner! Get ready to uncover the magic behind the Fusion Engine. This first tutorial will walk you through the setup process, ensuring you're all geared up to dive into the world of creative possibilities.
 
-[Start your journey: Tutorial 1](<http://fusion-engine.tech/docs/tutorials/setup.html>)
+[Start your journey: Tutorial 1](setup.md)
 
 ### 🎨 Tutorial 2: Basic Rendering
 Calling all aspiring artists and tech enthusiasts! Tutorial 2 is your canvas to experiment and explore. We'll guide you through the basics of rendering, letting you create and visualize like never before.
 
-[Start your journey: Tutorial 2](<http://fusion-engine.tech/docs/tutorials/basics.html>)
+[Start your journey: Tutorial 2](basics.md)
 
 ## Learning Can Be Exciting Too!
 No need to be daunted by the unknown. As you embark on these tutorials, remember that learning is a journey of excitement and growth. With each tutorial you conquer, you're leveling up your Fusion Engine skills!

diff --git a/docs/tutorials/setup.md b/docs/tutorials/setup.md
@@ -3,7 +3,7 @@
 ## Introduction
 Welcome to our fusion-engine tutorials! Here you can learn about our engine and how to use it! This will go easy over everything you need to know to start programming with fusion!
 
-So this tutorial is made to setup everything, so you can start programming with fusion-engine! But if you already have everything setup then head over to [tutorial 2: basic rendering](<dimkauzh.github.io/fusion-engine/docs/tutorials/basics.html>)
+So this tutorial is made to setup everything, so you can start programming with fusion-engine! But if you already have everything setup then head over to [tutorial 2: basic rendering](basics.md)
 
 ## Installing
 So firstly we need to install fusion-engine. We have our package hoster at pypi so you can easly install it by running:

diff --git a/docs/wiki/color.md b/docs/wiki/color.md
@@ -53,7 +53,4 @@ main.draw.drawRect(window, 100, 100, 400, 400, (255, 255, 255, 0))
 If you have a hex color and want to convert it to rgba you can use this function:
 ```python
 main.colortools.hex_to_rgba(hex)
-```
-
-[Back](<https://dimkauzh.github.io/fusion-engine/docs/wiki/wiki.html>)
-[Next](<https://dimkauzh.github.io/fusion-engine/docs/wiki/fonts.html>)
+```
diff --git a/docs/wiki/fonts.md b/docs/wiki/fonts.md
@@ -11,6 +11,3 @@ main.fonts.SAIRACONDENSED_EXTRABOLD
 ```
 
 There will be more fonts available in the future.
-
-[Next](<https://dimkauzh.github.io/fusion-engine/docs/wiki/keys.html>)
-[Back](<https://dimkauzh.github.io/fusion-engine/docs/wiki/color.html>)
diff --git a/docs/wiki/index.md b/docs/wiki/index.md
@@ -0,0 +1,33 @@
+# Wiki
+
+Welcome to our wiki! Here you will find all function with their small explanaion and how to use them.
+We have seperated the wiki in some parts, like main wiki, color wiki and more. You choose one you need.
+Can't find something? Then try looking in the main wiki
+So have luck!
+
+### Table of contents
+
+ - [Main Wiki](wiki.md)
+	 - Create Window
+	 - Start Loop
+	 - Default Message
+	 - Set Background Color
+	 - DeltaTime
+	 - Predefined Shapes
+	 - Window Icon
+	 - Set FPS
+	 - Vectors
+	 - Draw a Line]
+	 - Draw Rectangle
+	 - Draw Image
+	 - Create Entity
+	 - Sound
+	 - Storage System
+	 - Keyboard Input
+	 - User Interface (UI)
+	 - Using Pygame]
+	 - Quit
+ - [Color Wiki](color.md)
+ - [Font Wiki](fonts.md)
+ - [Key Wiki](keys.md)
+ - [Math Wiki](math.md)
diff --git a/docs/wiki/keys.md b/docs/wiki/keys.md
@@ -238,5 +238,3 @@ We use PySDL2 for this, here are our key bindings to the sdl2 keys:
 	KEY_EJECT = sdl2.SDLK_EJECT
 	KEY_SLEEP = sdl2.SDLK_SLEEP
 ```
-[Back](<https://dimkauzh.github.io/fusion-engine/docs/wiki/fonts.html>)
-[Next](<https://dimkauzh.github.io/fusion-engine/docs/wiki/math.html>)
diff --git a/docs/wiki/math.md b/docs/wiki/math.md
@@ -23,4 +23,3 @@ You can read more about it [here.](https://en.wikipedia.org/wiki/E_(mathematical
 ```python
 	main.math.EULERNUMBER
 ```
-[Back](<https://dimkauzh.github.io/fusion-engine/docs/wiki/keys.html>)
diff --git a/docs/wiki/wiki.md b/docs/wiki/wiki.md
@@ -1,4 +1,40 @@
-# Api docs
+# Main Wiki
+
+ - [Create Window](#create-window)
+ - [Start Loop](#start-loop)
+ - [Default Message](#default-message)
+ - [Set Background Color](#set-background-color)
+ - [DeltaTime](#deltatime)
+ - [Predefined Shapes](#predefined-shapes)
+ - [Window Icon](#window-icon)
+ - [Set FPS](#set-fps)
+ - [Vectors](#vectors)
+    - [Vector2d](#vector2d)
+ - [Draw a Line](#draw-a-line)
+ - [Draw Rectangle](#draw-rectangle)
+ - [Draw Image](#draw-image)
+ - [Create Entity](#create-entity)
+    - [Draw Rect with Entity](#draw-rect-with-entity)
+    - [Draw Image with Entity](#draw-image-with-entity)
+ - [Sound](#sound)
+    - [Load Sound](#load-sound)
+    - [Play Sound](#play-sound)
+    - [Stop Sound](#stop-sound)
+    - [Background Music](#background-music)
+ - [Storage System](#storage-system)
+    - [Init](#init)
+    - [Insertion](#insertion)
+    - [Reading](#reading)
+    - [Updating](#updating)
+    - [Deleting](#deleting)
+    - [Saving to Disk](#saving-to-disk)
+ - [Keyboard Input](#keyboard-input)
+ - [User Interface (UI)](#user-interface-ui)
+    - [Buttons](#buttons)
+        - [Button Clicked](#button-clicked)
+    - [Rendering Text](#rendering-text)
+ - [Using Pygame](#using-pygame)
+ - [Quit](#quit)
 
 ## Create window
 
@@ -315,9 +351,3 @@ Make sure your not using main (the initialized class) but the module itself.
 ## Quit
 
 The quitting of the engine is done automaticly for you, so you dont have to worry about it.
-
-[Back](https://dimkauzh.github.io/fusion-engine/docs/index.html)
-[Next](<https://dimkauzh.github.io/fusion-engine/docs/wiki/color.html>)
-
-
-[Back to main page](https://dimkauzh.github.io/fusion-engine/docs/index.html)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,7 @@
+site_name: Fusion Engine
+
+nav:
+  - Home: 'index.md'
+  - Wiki: 'wiki/index.md'
+  - Api: 'api/index.md'
+  - Tutorial: 'tutorials/index.md'
diff --git a/src/fusionengine/files/event.py b/src/fusionengine/files/event.py
@@ -6,7 +6,7 @@ class Event:
     def __init__(self) -> None:
         pass
 
-    def key_down_once(self, key: int, window: window._CustomRenderer) -> bool:
+    def key_down_once(self, key: int) -> bool:
         return False
 
     def key_down(self, key):