TriEngine

General-purpose engine in C#/OpenGL

Will eventually have scripting API for Lua (and possible additional languages)

IRC

TriDevs has an IRC channel, feel free to hop in if you have a question about anything:
Server: irc.kottnet.net
Port: 6667, 6697 (SSL)
Channel: #TriDevs

The channel topic contains further info.

License

Copyright © 2013 by Adam Hellberg, Sijmen Schoon and Preston Shumway.

TriEngine is licensed under the MIT License, more info can be found in the LICENSE file.

Contributing

You are free to fork this project and make your own changes, as long as you follow the MIT License.

If you want to make a pull request, please do so to the main project and not any of the "official" forks.

For your pull request to be accepted, please follow our coding style:

• Indent with 4 spaces, not tabs.
• Curly braces placed on next line.
• All public methods, accessors and members must be properly documented.
• Use sensible variable names that describe what they are for.
• Method declarations written as:

public void Hello(string world)

• If your method accepts many parameters, it can be useful to put parameters on separate lines, as per this style:

public void Hello(string world,
                  bool print)

• Please write tests for your code (not strictly required, but it's a plus)

By looking through the current source code, you should be able to get a good understanding of the formatting we use.

If you're using Visual Studio, you can change the indent behaviour by going to: Tools -> Options -> Text Editor -> C# -> Tabs and make sure "Insert spaces" is checked.

If you write tests for your code, please place these tests in their own project: "< Namespace >.Tests", create said project if it does not exist (of type Class Library).

We use NUnit as test framework, feel free to use something else if you want to, but make sure you document what framework you are using and that it is freely available for anyone to obtain.

Platform-specific developing

The solution/project files have several different configurations defined for debugging on different platforms (Linux, Windows and OSX).

Each configuration has a compile constant defined:

• "Debug (Linux)" and "Release (Linux)" have the LINUX constant #defined
• "Debug (Windows)" and "Release (Windows)" have the WINDOWS constant #defined
• "Debug (OSX)" and "Release (OSX)" have the OSX constant #defined

Platform-specific code must be enclosed in #if {PLATFORM} /* Code goes here */ #endif

Example:

#if WINDOWS
DoWindowsStuff();
#elif LINUX
DoLinuxStuff();
#elif OSX
DoOSXStuff();
#else
// Unsupported platform?
#endif

#if WINDOWS
DoExclusiveWindowsStuff();
#else
AllOtherPlatforms();
#endif

Dependencies

TriEngine depends on log4net, which is included in the libs/log4net folder.

TriEngine depends on OpenTK, this is not included and you will have to build/install it yourself.
OpenTK depends on OpenGL drivers being installed, they are usually in your normal video card drivers.

TriEngine depends on Json.NET, this is not included, but is specified in the NuGet package config.
If you properly configure your NuGet settings, NuGet will automatically download Json.NET when building any projects that depend on it.

TriEngine depends on NVorbis, which is included in the libs/NVorbis folder.
NVorbis is licensed under Ms-PL.

If you want to run the tests you will need to have NUnit installed.