Skip to content

Latest commit

 

History

History
148 lines (108 loc) · 3.32 KB

README.md

File metadata and controls

148 lines (108 loc) · 3.32 KB

🦎 Axolote Engine

Graphics engine made in C++ using OpenGL

🇧🇷 README em português: READMEpt.md

📄 Description

Graphics engine made in C++ using OpenGL version 3.3+. The idea of the project came from the fact that I (João Vitor Espig) wanted to learn OpenGL at the start of 2023 and have some fun doing some games and simulations, and then I decided to create a small engine using OpenGL. One of my motivations for learning OpenGL came from Minecraft (it uses OpenGL to render its graphics) and from the curiosity that I had about how 3D games are made.

📦 Dependencies

  • CMake 2.8.5+
  • OpenGL 3.3+
  • GLFW3
  • GLM
  • Assimp 5.4
  • Doxygen (Optional)

Linux

Ubuntu:

sudo apt-get install cmake
sudo apt-get install libglm-dev
sudo apt-get install libglfw3-dev libglfw3
sudo apt-get install libassimp-dev

Arch:

sudo pacman -S cmake
sudo pacman -S glm
sudo pamcan -S glfw
sudo pacman -S assimp

Windows

Download the CMake installer in https://cmake.org/download/ and install it.

The other dependencies will be installed via vcpkg. Install the vcpkg:

git clone https://github.com/microsoft/vcpkg.git
cd vcpkg
bootstrap-vcpkg.bat
vcpkg.exe integrate install

Install the dependencies

vcpkg.exe install glm
vcpkg.exe install glfw3
vcpkg.exe install assimp

🔧 Compiling

Clone the repository:

git clone https://github.com/JotaEspig/axolote-engine
cd axolote-engine
mkdir build
cd build

Linux

Compile the project:

cmake ..
make -j4

Windows

Compile the project (pay attention to the path of the vcpkg.cmake file, you must change it to your path where you cloned the vcpkg repository):

cmake -G "Visual Studio 17 2022" -DCMAKE_TOOLCHAIN_FILE=C:/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake ..
cmake --build . --config Release

For more details about building the project, see building.md.

🛠️ Installation

see install.md.

🚀 Getting Started

see getting-started.md.

🧪 Executing some tests

After compiling the project, run the following commands:

For Linux

./bin/window-test
./bin/models-and-shaders-test
./bin/main-test

For Windows

.\bin\Release\window-test.exe
.\bin\Release\models-and-shaders-test.exe
.\bin\Release\main-test.exe

📚 Documentation

If you have Doxygen, you can read the documentation using:

git clone https://github.com/JotaEspig/axolote-engine
cd axolote-engine
mkdir build
cd build
cmake ..
make docs

❓ Help

You can create an Issue or contact the mantainers (authors)

👥 Authors

🕒 Version History

see CHANGELOG.md

📜 License

This project is licensed under the MIT License - see the LICENSE file for details

🙏 Acknowledgments