Inerska / Velaptor

2D game and media application development framework

Velaptor

!! NOTICE !!

This library is still under development and is not at v1.0.0 yet!! However, all of the major features are available, so we encourage you to use it and report back any issues and improvements you may have. That is what open source is all about. 🥳

📖 About Velaptor

Velaptor is a 2D game development framework written in modern C# that strives to be simple and easy to use. Game development can be difficult which is why Velaptor was developed. It takes care of all of the lower level, more complicated things for creating a game like playing sound, loading graphics, managing content, multi-platform, and dealing with input, just to name a few. This way you can just concentrate on developing your game or multi-media application.

✨Features

Cross-Platform

We strive for Velaptor to be a cross platform library by running under .NET v6.0+.

Easy To Use

One of the goals of this library is to make sure that the it is easy to use. Everything from naming, documentation and usability of the API will be first class citizens.

Flexible Content Loading System

Velaptor has the ability to load texture atlas data for texture atlas type rendering as well as single image and sound content. The content loading system is flexible and has an API with the ability to be extended to load custom content for your media applications and games.

Content Caching

Loaded content such as images and sounds are cached for performance reasons. If the same content is attempting to be loaded from its source after it has already been loaded, that same content will be used from memory instead of being reloaded. You can also load content by building your own content loader.

Feature Demo Application

CompleteVideo.mp4

🔧Maintainers

We currently have the following maintainers:

• Calvin Wilkinson (GitHub Organization / Owner)
• Kristen Wilkinson (GitHub Organization / Documentation Maintainer / Tester)

📄Documentation

• Go to the Table Of Contents for instructions on various topics such as:
  • Branching
  • Release Process
  • Environment Setup
  • and more . . .

🙏🏼Contributing

Velaptor encourages and uses Early Pull Requests. Please don't wait until you're finished with your work before creating a PR.

1. Fork the repository.
2. Create a feature branch following the feature branch section in the documentation here.
3. Add an empty commit to the new feature branch to start your work off.
   • Use this git command: git commit --allow-empty -m "start work for issue #<issue-number-here>".
   • Example: git commit --allow-empty -m "start work for issue #123".
4. Once you've pushed a commit, open a draft pull request. Do this before you start working.
5. Make your commits in small, incremental steps with clear descriptions.
6. All unit tests must pass before a PR will be completed.
7. Make sure that the code follows the the coding standards.
   • Pay attention to the warnings in Visual Studio!!
   • Refer to the .editorconfig files in the code base for rules.
8. Tag a maintainer when you're done and ask for a review!

If you have any questions, please reach out to a project maintainer.

Practices

• The code base is highly tested by using unit tests while maintaining a high level of code coverage. Manual testing is performed using the included testing application built specifically for manually testing the library. When contributing, make sure to add or adjust the unit tests appropriately regarding your changes and perform manual testing.
• We use a combination of StyleCop and Microsoft.CodeAnalysis.NetAnalyzers libraries for maintaining coding standards.
  • We understand that there are some exceptions to the rule and not all coding standards fit every situation. In these scenarios, contact a maintainer and lets discuss it!! Warnings can always be suppressed if need be.
• We use semantic versioning 2.0 for versioning.
• Branching model below.
  • Branching Diagram (GitHub Dark Mode)
  • Branching Diagram (GitHub Light Mode)

Further Resources

• The sample project named VelaptorTesting can be found in the Testing Folder
  • This is a sample project for the purpose of performing manual testing of the library as well as understanding how to use it.
• CASL is used for audio.
• Powered by Silk.NET.

Licensing And Governance

Velaptor is distributed under the very permissive MIT license and all dependencies are distributed under MIT-compatible licenses. This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.