KinsonDigital.Velaptor 1.0.0-preview.15

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 provide feedback. 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 using cross platform dependencies as much as possible. If a cross platform dependency cannot be found, than the appropriate platform specific implementations will be used based on the platform.

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 better performance. 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.

🔧Maintainers

We currently have the following maintainers:

• Calvin Wilkinson (KinsonDigital GitHub Organization - Owner)
• Kristen Wilkinson (KinsonDigital 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

To learn how to contribute to the project, go here.

Practices

• The code base uses unit tests and has a high level of code coverage. Manual testing is performed by using the included testing application built specifically for manually testing the library. When contributing, make sure to add or adjust the unit tests accordingly and perform manual testing.
• We use a combination of StyleCop and Microsoft.CodeAnalysis.NetAnalyzers libraries for maintaining coding standards.

Note 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.

Funding

Velaptor and all of the KinsonDigital organization projects require significant effort to maintain, as such we greatly appreciate any financial support you are able to provide! This helps ensure the long term viability of all the projects in the organization and to help support the project maintainers in their free time.

Further Resources

• The sample project named VelaptorTesting can be found in the Testing Folder

Note 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.
• Come chat with us on Discord!

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.