HTTPS SSH

What is Trivial Engine?

Trivial Engine is a game framework inspired by game frameworks like Flixel and FlashPunk. The goal for Trivial is to make writing games easier and simple, giving you a higher level framework and tools to work with so that you can focus on what you do best, make games.

Getting our base app up and running is easy as, with 3 lines of code.

Trivial::App *myApp = Trivial::App::Instance();
myApp->configure(NULL, 800, 600, 32, "my game");
myApp->run();

INSTALLATION ON UNIX

TODO: Complete this tutorial

  1. Make sure you set two environment variables:

CMAKE_INCLUDE_PATH

CMAKE_LIBRARY_PATH

Both of these should have at least the SFML include and lib paths.

INSTALLATION ON WINDOWS

Getting started on Windows is simple, follow the steps and thats it.

Compiling SFML2

  1. Download the latest sfml code from the repo - https://github.com/LaurentGomila/SFML

For Visual Studio 9 2008 on windows

  1. run the cmake-gui

  2. Select the folder where SFML2 is and hit Configure, this shouldn't throw any errors(cmake will test for working compiler as well)

  3. under BUILD make sure BUILD_SHARED_LIBS is on

  4. Hit Generate and you should have your soultion(.sln file) generated for you

  5. Open the solution and build both Debug and Release configurations(should go without a hitch)

  6. Make libs folder in the root (mine looked like was c:\sfml2\libs)

  7. Copy all the newly created lib and dll files into this folder for ease of use (I copied the Debug and Release folders from from c:\sfml2\vcshared\lib to c:\sfml2\lib)

For Code::Blocks with MingW GCC on windows

  1. run the cmake-gui

(you will have to delete the cmake cache if you want to get the compiler/ide selection dialog again) 3. Select the folder where SFML2 is and hit Configure, this shouldn't throw any errors(cmake will test for working compiler as well)

  1. under BUILD make sure BUILD_SHARED_LIBS is on

  2. under CMAKE keep CMAKE_BUILD_TYPE to Release for now and later you will need to regenerate the CodeBlocksProject with this as DEBUG for the debug libs(make sure you change the Where to Build binaries text box to a new folder!! mine was C:/sfml2/cbSharedDebug and C:/sfml2/cbSharedRelease)

  3. Hit Generate and you should have your soultion generated for you

  4. Open the cbp and build all do this for the other project as well

  5. Since I'm using both msvc and mingw, I have both my libs stored at the same place, with a small change, I copied all my msvc libs to c:\sfml2\lib\Debug and Release and all my mingw libs ..\lib\Debug\mingw and ..\lib\Release\mingw

NOTE: you might have to hit Configure in cmake-gui a couple of times to make sure all the red coloured labels are gone!

--

Things to do before compiling Trivial and the test application

  1. copy all the dlls to appropriate Release and Debug folders, this includes the two dlls from the extlibs folder in sfml2 as well.

  2. Add sfml2\include to your header search path

  3. Add sfml2\lib and sfml2\lib* as required to your library search path

LICENSE

Trivial Engine is licensed under the MIT License.

The MIT License (MIT) Copyright (c) 2016, Hashstash.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.