Skip to content
This repository has been archived by the owner on Dec 8, 2024. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Added changelog and added docs how to use codon
  • Loading branch information
dimkauzh committed Aug 30, 2023
1 parent f3adf2f commit 0ddafff
Show file tree
Hide file tree
Showing 8 changed files with 75 additions and 49 deletions.
44 changes: 1 addition & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,49 +118,7 @@ See at [our websites docs/wiki section](https://docs.fusion-engine.tech/)

### 🛠️ Features we are working on

We are working hard to implement very basic and complex stuff so our engine becomes more rigid. These features are worked on or will be worked on:

#### 3.0.0 and later

- [x] Engine
- [x] Window
- [x] Create window
- [x] Get data from window
- [x] Draw shapes
- [x] Draw images
- [x] Input
- [x] Storage system
- [x] Rendering options
- [x] Delta-Time
- [x] Pip package and SetupTools
- [x] Cython
- [x] Implement cython for extra speed
- [x] Dev version without cython
- [x] Vectors (stores x and y coordinates)
- [x] Create vector
- [x] GUI library
- [x] Text
- [x] Drawing (Build in draw function)
- [x] Buttons
- [x] Sound system
- [x] Sound player
- [x] File support
- [x] And more...

### 4.0.0 and later

- [ ] UI (Using TKinter)
- [ ] Menu
- [ ] Create project
- [ ] Editor
- [ ] Code editor build in
- [ ] Run game

- [ ] Physics system using PyMunk
- [ ] Gravity
- [ ] Rendering
- [ ] Collision system
- [ ] Physics shapes
We are working hard to implement very basic and complex stuff so our engine becomes more rigid. To see our changelog and todo list, please go [to our docs](https://docs.fusion-engine.tech/)

💡 - If you have more ideas, please tell us them in our [discord group](https://discord.gg/Smg3CK4ZMc) or create an issue!

Expand Down
26 changes: 26 additions & 0 deletions docs/changelog/3_0_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 3.0.0 Todo/Changelog

- [x] Engine
- [x] Window
- [x] Create window
- [x] Get data from window
- [x] Draw shapes
- [x] Draw images
- [x] Input
- [x] Storage system
- [x] Rendering options
- [x] Delta-Time
- [x] Pip package and SetupTools
- [x] Cython
- [x] Implement cython for extra speed
- [x] Dev version without cython
- [x] Vectors (stores x and y coordinates)
- [x] Create vector
- [x] GUI library
- [x] Text
- [x] Drawing (Build in draw function)
- [x] Buttons
- [x] Sound system
- [x] Sound player
- [x] File support
- [x] And more...
14 changes: 14 additions & 0 deletions docs/changelog/4_0_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 4.0.0 Todo/Changelog

- [ ] UI (Using TKinter)
- [ ] Menu
- [ ] Create project
- [ ] Editor
- [ ] Code editor build in
- [ ] Run game

- [ ] Physics system using PyMunk
- [ ] Gravity
- [ ] Rendering
- [ ] Collision system
- [ ] Physics shapes
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ And in tutorials we made some tutorials for you to better understand fusion!

### Tutorials
- [Tutorials](tutorials/index.md)

### Todo list and changelog
- [3.0.0](changelog/3_0_0.md)
- [4.0.0](changelog/4_0_0.md)


## 💻 Setting up
Expand Down
19 changes: 19 additions & 0 deletions docs/wiki/external.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# External tools

## Using pygame
If you cant find some function you need in this engine, the you could use pygame as the engine is build on pygame. You dont need to import pygame, as that can make so issues, you just use:
```python
fusion.pg
```
Make sure your not using main (the initialized class) but the module itself.

## Using Codon Compiler
So you heard of [codon](https://docs.exaloop.io/codon/), a python compiler with can compile your python code to machine code, which makes your code a lot faster But how do you use it? Well, its easy! You just install it and then modify these things in your code:

Loop:
You need to modify our loop to support codon, so you need to change it to this:
```python
while main.window.running(window):
... # Your own loop thing
```
You may reconise this type of while loop from the main wiki as your second option.
1 change: 1 addition & 0 deletions docs/wiki/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ So have luck!
### Table of contents

- [Main Wiki](wiki.md)
- [External tools Wiki](external.md)
- [Color Wiki](color.md)
- [Font Wiki](fonts.md)
- [Key Wiki](keys.md)
Expand Down
6 changes: 0 additions & 6 deletions docs/wiki/wiki.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,12 +317,6 @@ Its the same option 1, but you change the font to name of the font, like this:
```python
main.ui.text.print_text(window, "Your text", 10, 10, "Arial", 20, main.color.WHITE)
```
## Using pygame
If you cant find some function you need in this engine, the you could use pygame as the engine is build on pygame. You dont need to import pygame, as that can make so issues, you just use:
```python
fusion.pg
```
Make sure your not using main (the initialized class) but the module itself.

## Quit

Expand Down
10 changes: 10 additions & 0 deletions tests/codon_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
from python import fusionengine as fusion


main = fusion.Main()

window = main.window.new_window("Example: 1", 600, 600)
image = main.image.open_image(window, main.debug.DEBUGIMAGE, 0, 0, 600, 600)

while main.window.running(window):
main.image.draw_image(image)

0 comments on commit 0ddafff

Please sign in to comment.