The goal of this project is to create a full python app engine/library to help people to easily create apps or games directly with Python, and to prepare the C++ implementation of this app engine/library that will aim to better performances and the ability to export any app / or game created with it into the most device / platform possible (Linux computer, windows computer, MAC computers, Android mobiles, IOS mobiles, Android VR headsets, ...).
All the files in the root directory beginning with lib_nadisplay_ are the core elements of this library.
The project is separated into 2 large layers:
-
The backend layer: Its role is to use correctly the sub systems rendering engines like (
SDL2,GLFW,Pygame) for windows management and (OpenGL,Vulkan) for rendering. The main classes for backend are:-
ND_Display: Global display management and font gestion -
ND_Window: Window specific management and core rendering functions -
ND_EventsManager: Event manager systemFor each possible combination (like
Pygame,SDL2 + SDLGFX,SDL2 + OpenGL,GLFW + OpenGL,GLFW + Vulkan), there are scripts where thoses specific classes are implemented.
-
-
The frontend layer: Its role is to propose an abstraction layer on common rendering functionnalities and to help design apps or games. The main classes for frontend are:
ND_MainApp- and the
ND_+Element_Name+for each element given to use with the library, likeND_Elt_TextInputorND_Elt_SpriteorND_Elt_Button.
The main classes are organized in the
lib_nadisplay_core.py, and all the other classes are organized each in theirlib_nadisplay_???.pyfile.
Some OpenGL shaders are stored in the folder gl_shaders/, the vulkan shaders will be store in the folder vk_shaders/.
The tests are separated into 2 subdirectories, the tests/apps/ tests and the tests/scripts/ tests. While the script tests are smaller tests that helped to create the backend layers libs (you can see that no lib_nadisplay_... files are used for the script tests), the app tests are bigger tests that use directly the lib_nadisplay_... library to test it like a real project would use it.
-
To execute the script tests, you must place your terminal to the subdirectory
tests/scripts/and launch them withpython test_file.py. -
To execute the app tests, you must place your terminal to the subdirectory
tests/apps/app_to_test/and launch them withpython main.py -
It is strongly recommanded to use a python venv for this project, you can create one with
python -m venv venv_dir/, and activate with itsource venv_dir/bin/activate(on linux) or./venv_dir/bin/activate.bat(on windows), and then deactivate it later withdeactivate.
The full python pip requirements required to run any python file in the project are stored in the file requirements.txt, you can install them in any python environments with pip install -r requirements.
Currently the backend that are working are :
SDL2 + SDLGFXSDL2 + OPENGLGLFW + OPENGL
Pygame is working a little, but there are some bugs and no multi-windowing.
Note: It is difficult to work on the GLFW + Vulkan because of no good Vulkan Wrapper for Python with good library and examples.
Currently, there are the following usable classes for creating apps and games with the lib_nadisplay :
ND_Elt_TextND_Elt_RectangleND_Elt_SpriteND_AtlasTextureND_Elt_Sprite_of_AtlasTextureND_Elt_AnimatedSpriteND_Elt_ButtonND_Elt_H_ScrollBarND_Elt_V_ScrollBarND_Elt_LineEditND_Elt_CheckboxND_Elt_NumberInputND_Elt_SelectOptionsND_Elt_ContainerND_Elt_MultiLayerND_Elt_CameraGridND_Elt_RectGrid
A lot of new element classes are planned to be added in the future.
The documentation hasn't been started yet, but there will be one well writen and easy to use when the project will be at a state where people can start to use it, that is not really currently the case.
- A snake game: https://github.com/nath54/Snaky