search

mholtkamp / octave

A 3D game engine for GameCube, Wii, 3DS, Windows, Linux, and Android.
MIT License
65 stars 6 forks source link

Please add documentation #7

Open mardy opened 1 year ago

mardy commented 1 year ago

Hi! The idea behind this project is excellent! For newcomers (like me), if would be very interesting to have some short documentation that shows how a typical small project looks like, and explains how targetting multiple platform is achieved. A tutorial would be ideal :-)

mholtkamp commented 1 year ago

Hi mardy! Yes, I definitely need to add some documentation. Right now I'm using a private version of this engine for an indie game I'm working on. I'll be releasing the game later this year and updating this repo with all of my updates. After I do that I'm going to make a couple tutorial videos on how to use the engine.

JamesMWestbrook commented 7 months ago

Seconding this. Got the project pulled up when running debug, but not sure how to get lua scripts started up. I assume to get the lua API i'll need to study the source code, but more information about setting this up would be nice.

SavantSusi commented 5 months ago

I wanna go about making some simple test games but I don't even know where to start

mholtkamp commented 5 months ago

Hi folks! I am going to be creating a tutorial video series soon, and shortly after I'll be working on Lua documentation. So yes, unfortunately for now, the best "documentation" for scripting will be to look through the source files in the "Engine/Source/LuaBindings" directory. Also take a look at this repo for an incomplete demo game: https://github.com/mholtkamp/octo-bombers