d4v3y5c0n3s / goldelish-engine Goto Github PK

(WIP) A reimplementation of the Corange Game Engine (https://github.com/orangeduck/Corange) in the ATS programming language.

License: Mozilla Public License 2.0

ATS 80.21% Makefile 1.43% C 3.76% GLSL 14.60%

game-engine wip corange-engine goldelish-engine ats-lang 3d-game-engine

goldelish-engine's Introduction

[ Goldelish-Engine ]

    GGG	     OOO    L	      DD     EEEEE L         IIIII    SSS  H   H
  G    	   O	 O  L	      D	  D  E	   L           I    S  	 S H   H
 G     	  O 	  O L	      D	   D E	   L           I    S  	   H   H
 G     	  O    	  O L	      D	   D EEE   L           I     S 	   HHHHH
 G     	  O	  O L	      D	   D E	   L           I      S	   H   H
 G    GGG O       O L  	      D	   D E	   L           I       S   H   H
  G     G  O	 O  L 	      D	  D  E	   L           I   S    S  H   H
    GGG	     OOO    LLLLLLL   DDD    EEEEE LLLLLLL   IIIII   SSS   H   H

[ Project Goals ]
  I want to show off ATS by using it to build a game engine,

[ Project Motives ]
  This project was created because I wanted to learn ATS & because I think game engines are cool.

[ Project Status ]
  The project is getting close to being usable.  Yup.

[ Contributing ]
  See a problem or have a question?  Create an issue.  Want to code?  Make a pull request.

[ Corange Engine Copyright Notice ]
  This project is based on Corange Engine, and therefore the copyright notice for Corange is below in compliance with its license.

*---------------------------------*
|Copyright (c) 2010, Daniel Holden|
|All rights reserved.		  |
*---------------------------------*

goldelish-engine's People

Contributors

Stargazers

Watchers

goldelish-engine's Issues

Create a Makefile

The engine needs one to compile. Look up Makefile syntax, Corange's Makefile, and ATS Makefiles from the 'ATS-Postiats-contrib' repo.

Fix certain types to be abstract

Currently some types are not abstract in order to get the engine to a workable state faster. An example in the code currently would be the vertex type in g_engine.dats. Once I finish getting the engine working, then I'll come back to this.

Finish SDL2 integration

This is necessary in order for the engine to work.

Write the Main Files for the Engine

This is a general issue and will remain the main focus of work on this project for a while.

Review the code and test it

Do this to determine whether the reimplementation is complete once the engine runs.

Write the Header Files for the Engine

This will take some time, but the header files are an important milestone in getting this engine implemented.

Mix_GetError() produces warning due to handling of the string returned

Warning message produced:
assignment discards 'const' qualifier from pointer target type [-Wdiscarded-qualifiers]

Since it's only a warning, I will return to this later to investigate it further.

Cleaning up the static files

I am cleaning up the static files (which are ".sats" files, formerly ".hats" files) to ensure that they are working fine.

b_array_mutate() and b_array_index() use unsafe features to violate linear types and potentially leaks memory

These functions are in the dict.dats file.

Write documentation and/or tutorials

This will allow new users to actually use the engine. I will not get to this until the engine is in a workable state, that way I don't have to keep changing the docs. Corange has pretty sparse documentation, so I'll have to do much of the work from scratch.

Considering changing the license to GPL-3.0 (with exception to allow users to link code)

I'm considering changing the license to GPL-3.0, because I've recently realized that I've had some misunderstandings about how the GPL functions. The ability of the copyright holder (me) to allow exceptions would enable users to use the engine without needing to GPL-ify their code.

I think using the GPL in a project such as this could provide an example to others of how flexible the license can be, and perhaps I could clear up misconceptions about the license in general.

This seems like a topic that others would be interested in, so I'd like to hear what others have to say about the idea.

Check out the GPL-3.0 FAQ here for more information. Also, here's the part that talks about exceptions to allow for linking without GPLing.

Current SDL interface is hacky, unsafe, and doesn't utilize ATS features such as linear types

This needs to get cleaned up, which will also involve rewriting some code already based on the current implementation such as g_audio.