Skip to content

KinsonDigital/Velaptor

Repository files navigation

logo

Velaptor

Build PR Status Check Unit Test PR Status Check

Technical Debt Maintainability Rating Vulnerabilities

Bugs Code Smells Duplicated Lines (%)

Codecov

Latest Nuget Release Nuget Downloads

Good First GitHub Issues Discord

!! 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 Velaptor and provide feedback. That is what open source is all about. πŸ₯³


πŸ“– About Velaptor πŸ“–

⭐ Don't forget to give us a star! ⭐

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. We do this by using as many cross-platform dependencies as possible. If a cross platform dependency cannot be found, then the appropriate platform-specific implementations will be used.

Easy To Use

One of the goals of this library is to make it easy to use. We aim for consistent naming conventions, documentation and usability of the API to be first-class.

Flexible Content Loading System

Velaptor can load texture atlas data for its rendering as well as single images 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, it will be used from memory instead of being reloaded. You can also load content by building your content loader.

πŸ“½οΈ Feature Demo πŸ“½οΈ

FeatureDemoVideo


πŸ“ƒ Documentation and Resources πŸ“ƒ

Full API documentation and tutorials can be found at docs.velaptor.io.Velaptoris powered by CASL and Silk.NET.


πŸ™πŸΌ Contributing πŸ™πŸΌ

Interested in contributing? If so, click here to learn how to contribute your time or here if you are interested in contributing your funds via a one-time or recurring donation.

πŸ”§ Maintainers πŸ”§

x-logo-dark-mode x-logo-light-mode Calvin Wilkinson (KinsonDigital GitHub Organization - Owner)


πŸš” Licensing And Governance πŸš”

Contributor Covenant GitHub

This software 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.