Giter Club home page Giter Club logo

gdx's Introduction

GDX

Latest Release Discord Server License: MIT

Game Development Extensions, a battle-tested library of game-focused high performance C# code.

Feature Highlights

  • Optimized & non-allocating collections (GDX.Collections)

    It's important to note that many of the structures backing data, indices, counts, etc. are publicly accessible. This is meant for advanced usage, change at runtime at your own risk.

Usage

Add com.dotbunny.gdx as a dependency to the project Packages/manifest.json file:

{
  "dependencies": {
    "com.dotbunny.gdx": "https://github.com/dotBunny/GDX.git",
  }
}

It is possible for the repository to be simply cloned into a sub-folder in your projects Asset folder.

Requirements

The package is designed to be compatible with an empty project created in Unity. It uses a preprocessor system, where the assembly definition will define features based on the packages found in the project.

It is important to note that the GDX_* defines are only valid inside of the GDX assemblies.

Supported Packages

Package Minimum Version
com.unity.addressables 1.16.0
com.unity.burst 1.4.0
com.unity.jobs 0.6.9
com.unity.mathematics 1.2.1

Contributing

GDX is an open-source project and we encourage and welcome contributions.

Design Guidelines

There is a general effort to follow the Framework Design Guidelines set forth by the .NET team. While we do not always precisely adhere to them, they serve as a guiding principle.

  • Embedded in the project is an EditorConfig, which should standardize much of the formatting.
    • It is based on the .NET Roslyn repositories .editorconfig.
    • Warns of non-explicit type definitions everywhere (we're not going to use var to promote better readability).
  • .NET Coding Conventions is also a good point of reference.
  • Typically sections of classes are ordered alphabetically.
  • Preference to expose backing data, indices, etc.

License

GDX is licensed under the MIT License. A copy of this license can be found at the root of the project in the LICENSE file.

gdx's People

Contributors

reapazor avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.