search

datalurkur / Ghastly

Simple 2D Game Engine
2 stars 1 forks source link

Documentation? #1

Open Shalmezad opened 12 years ago

Shalmezad commented 12 years ago

So far, this engine looks interesting to use. As much as I would like to go through each part and figure out how it works, it would be a LOT easier if there were some documentation on: 1) How the engine is structured 2) How to use the engine (examples would be nice) 3) What the engine is for (from the looks of it, it's a 3d game engine based off SDL/OpenGL, but I can't tell for sure without going through everything)

If you provide a little detail about how it's structured (using the wiki portion of the git repository works wonders), then you can get some help if you have any issues. Hope to hear from you soon. Keep up the good work! -Shalmezad

datalurkur commented 12 years ago

Well, the reason there's no documentation is I've only been working on the engine for about 6 months know, and it's VERY far from finished. It's more or less a personal project with some vague concept goals. I've taken a lot of ideas from Ogre, another engine I worked on in the past (YAGE), and a game design book I've been reading (Game Engine Architecture). I appreciate the interest, but really wouldn't recommend you try to use Ghastly for anything for quite a long time. It's pretty much in its infancy on all fronts.

-Datalurkur

On Sun, Feb 26, 2012 at 3:17 PM, Shalmezad < reply@reply.github.com

wrote:

So far, this engine looks interesting to use. As much as I would like to go through each part and figure out how it works, it would be a LOT easier if there were some documentation on: 1) How the engine is structured 2) How to use the engine (examples would be nice) 3) What the engine is for (from the looks of it, it's a 3d game engine based off SDL/OpenGL, but I can't tell for sure without going through everything)

If you provide a little detail about how it's structured (using the wiki portion of the git repository works wonders), then you can get some help if you have any issues. Hope to hear from you soon. Keep up the good work! -Shalmezad

Reply to this email directly or view it on GitHub: https://github.com/datalurkur/Ghastly/issues/1

Shalmezad commented 12 years ago

But what about a UML diagram or a class structure layout? Even though it's still in it's infancy, a little forethought to design (even if you do make it similar to one you worked on before) makes it easier to code, and easier for others to get involved if you want help.

datalurkur commented 12 years ago

The lack of documentation is not an indication of lack of forethought. The reason I haven't bothered to document anything is that the project is still very fluid. Just this afternoon, I moved around a handful of files and made changes to the engine that would've required changes to documentation as well. The fact that I work on this project alone means documenting things at this stage would only really serve to slow down my process. The primary goal of the engine is to say I've written one, and explore the architectural space of engine design. However, since you've expressed interest, I'll see if I can draw up a broad overview of how the pieces fit together.

-Datalurkur

On Sun, Feb 26, 2012 at 3:41 PM, Shalmezad < reply@reply.github.com

wrote:

But what about a UML diagram or a class structure layout? Even though it's still in it's infancy, a little forethought to design (even if you do make it similar to one you worked on before) makes it easier to code, and easier for others to get involved if you want help.

Reply to this email directly or view it on GitHub: https://github.com/datalurkur/Ghastly/issues/1#issuecomment-4184789

Shalmezad commented 12 years ago

Alright, thank you very much. Even if the code changes, the documentation at least gives a base standpoint, allowing someone to get an understanding of what you are trying to accomplish (game engine could mean anything from simple SDL/OpenGL interface, to camera managers, to physics engines, game loop managers, etc.), and allows a quick overview for what the code does. Can't wait to see how everything works. I've tried making my own game engine before (without much luck), so it will be great to see how someone who's had experience structure theirs.

datalurkur commented 12 years ago

Overview block diagram attached.

On Sun, Feb 26, 2012 at 3:54 PM, Shalmezad < reply@reply.github.com

wrote:

Alright, thank you very much. Even if the code changes, the documentation at least gives a base standpoint, allowing someone to get an understanding of what you are trying to accomplish (game engine could mean anything from simple SDL/OpenGL interface, to camera managers, to physics engines, game loop managers, etc.), and allows a quick overview for what the code does. Can't wait to see how everything works. I've tried making my own game engine before (without much luck), so it will be great to see how someone who's had experience structure theirs.

Reply to this email directly or view it on GitHub: https://github.com/datalurkur/Ghastly/issues/1#issuecomment-4184877

datalurkur commented 12 years ago

Apparently github doesn't like attachments when it comes to email responses. I've created a couple wiki pages with block overviews of some pieces of the engine.