https://github.com/mholtkamp/octave

A 3D game engine for GameCube, Wii, 3DS, Windows, Linux, and Android.
https://github.com/mholtkamp/octave

Last synced: 3 months ago
JSON representation

A 3D game engine for GameCube, Wii, 3DS, Windows, Linux, and Android.

• Host: GitHub
• URL: https://github.com/mholtkamp/octave
• Owner: mholtkamp
• License: mit
• Created: 2022-03-28T00:46:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-12T02:14:25.000Z (3 months ago)
• Last Synced: 2024-09-12T12:07:13.906Z (3 months ago)
• Language: C++
• Homepage:
• Size: 20.8 MB
• Stars: 65
• Watchers: 11
• Forks: 6
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-game-engine-dev - Octave - 3D game engine for GameCube, Wii, 3DS, and more. (Libraries / C++)

README

        
# Octave

A 3D Game Engine for GameCube, Wii, 3DS, Windows, Linux, and Android

Tutorial Video: https://youtu.be/0CHLn0ie-DY?si=pq-s_hLgb71OX2Cc

Setup instructions below.

## Windows Setup

1. Download and Install:

	- Visual Studio Community 2022 (with C++ support)

	- Vulkan SDK version 1.3.275.0 (During install select "Shader Toolchain Debug Symbols - 64 bit" and deselect all other options)

    - devkitPPC for GameCube/Wii development (Optional)

    - devkitARM for 3DS development (Optional)

2. Build shaders by running compile.bat in Engine/Shaders/GLSL

3. Open Octave.sln

4. Switch to the DebugEditor solution configuration

5. Set the Standalone project as the Startup Project

6. In the debug settings for Standalone, change the working directory to $(SolutionDir)

7. Build and run Standalone. This is the standalone level edtior if you were making a game with Lua script only.

## Linux Setup

1. sudo apt-get install g++

2. sudo apt-get install make

3. sudo apt-get install libx11-dev

4. sudo apt-get install libasound2-dev

5. Install Vulkan SDK version 1.3.275.0

6. Install devkitPro Pacman for GameCube/Wii/3DS development (Optional) (https://devkitpro.org/wiki/devkitPro_pacman)

    - wget https://apt.devkitpro.org/install-devkitpro-pacman

    - chmod +x ./install-devkitpro-pacman

    - sudo ./install-devkitpro-pacman

7. Install GameCube/Wii/3DS development libraries (Optional) (https://devkitpro.org/wiki/Getting_Started)

    - sudo dkp-pacman -S gamecube-dev

    - sudo dkp-pacman -S wii-dev

    - sudo dkp-pacman -S 3ds-dev

8. Run Engine/Shaders/GLSL/compile.sh

### Linux Setup (Visual Studio Code)

9. Open the root folder in VsCode.

10. Run the Linux Editor config.

### Linux Setup (Terminal)

9. From the root directory `cd Standalone` 

10. Run `make -f Makefile_Linux_Editor`

11. Go back to the root directory `cd ..`

12. Run `Standalone/Build/Linux/OctaveEditor.out` It's important that the working directory is the root directory where the Engine and Standalone folders are located.

## Packaging

1. For packing Windows, add your devenv.exe folder to your PATH. For instance: 

    `C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE`

2. For packaging GameCube, Wii, or 3DS, add your devkitPro tools folder to your PATH. For instance: 

    `C:\devkitPro\tools\bin`

3. For packaing Android... TODO (I'm currently using Android Studio 2022.2.1 Patch 2)