Skip to content

map-b/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 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. 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 naming, documentation and usability of the API to be first class.

Flexible Content Loading System

Velaptor has the ability to load texture atlas data for its 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, it will be used from memory instead of being reloaded. You can also load content by building your own content loader.

📽️ Feature Demo 📽️

FeatureDemoVideo


📃 Documentation and Resources 📃

Full API documentation and tutorials can be found at docs.velaptor.io. Velaptor is 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 one-time or recurring donation.

🔧 Maintainers 🔧

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

x-logo-dark-mode x-logo-light-mode Kristen Wilkinson (KinsonDigital GitHub Organization - Project Management, Documentation, Tester)


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

About

2D game and media application development framework

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 99.1%
  • GLSL 0.9%