Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 3.54 KB

README.md

File metadata and controls

68 lines (48 loc) · 3.54 KB

dengine

Simple 3D Graphics Engine

cloning

Clone the repo. If on Windows to get all needed dependencies you might want to pass --recursive:
git clone --recursive https://github.com/Denzy7/dengine

If this is too much for you or takes an insanely long time, follow Linux users to the next step

On Linux and its derivatives, refer to deps/README.md to install all needed dependencies:

Change dir to repo:
cd dengine

building

  • DengineRC: Build dengine-rc into source dir:
    cmake -S main/dengine-rc -B build/dengine-rc
    cmake --build build/dengine-rc

  • Desktop (Linux, Windows) : Build with CMake. For Windows, MinGW is highly recommended. Haven't tested on MSVC with C99

    • (optional) Mess around with dengine_config.h.in for certain compile time options

    • Configure cmake: cmake -S . -B build/desktop

      • Optional options include:
        • -DDENGINE_WIN: Force Window API (Linux), can be X11, WAYLAND
        • -DDENGINE_CONTEXT: Force Context API (Linux), can be GLX(X11 only), EGL

    MinGW Note: See tools/mingw/README.md

    • Build the tree: cmake --build build/desktop

  • Android :

    • With Android Studio:

      • Simply open the apk test build.gradle with Android Studio

    • Without Android studio (terminal):

      • Ensure OpenJDK 11 is installed. Locate JRE from it. Call this JAVA_HOME. Ensure JAVA_HOME/bin has java executable.

      • Set environment variable to point to JAVA_HOME. Test with java --version if its actually openjdk 11.*

      • Run ./gradlew build (Linux) or gradlew.bat build (Windows)

      • The following gradle options may speed up build by skipping certain unneeded tasks for Native Activity: -x lintVitalAnalyzeRelease -x lintAnalyzeDebug -x lintDebug

      • By default, this builds an APK which you can run on any Physical Device or Emulator in app/build/output

      • Termux X11: - Configure cmake with option -DDENGINE_TERMUX_X11. Builds a regular executable as Desktop

    • To build the executable tests, run regular cmake. Use the toolchain in the NDK
      cmake -S . -B build/android -DCMAKE_TOOLCHAIN_FILE='<NDK_DIR>/build/cmake/android.toolchain.cmake' -DANDROID_API=24

    See other options at Android docs

glue code

writing python scripts

  • Be sure to skim through stubs documentation to see how to work with then, especially if you are running Windows.

  • Linux: Its actually very easy here. Just install the modules located in <CMAKE_BUILD_DIR>/dengine-script-build/modules-build/python-modules. Install dengine directory to your Python site-packages or add the directory to your IDE/Editor Python path (VSCode-OSS in this case)

  • Windows: You'll probably have to use the stubs. Unless you managed to build everyting with MSVC, which is usually what upstream python is built on

github actions artifact releases

now availabe on github actions! you need to be logged in
check out the latest succesfull build and download artifacts