X10D/X10D.Unity
Oliver Booth 0afe45f4d6
chore: bump to 3.3.1
2023-08-21 17:39:28 +01:00
..
src feat: add DebugUtility.DrawFunction 2023-04-13 01:48:58 +01:00
README.md [ci skip] docs: update upm stable in README 2023-04-04 21:25:56 +01:00
X10D.Unity.csproj chore: bump to 3.3.1 2023-08-21 17:39:28 +01:00
X10D.Unity.csproj.DotSettings fix: rename DebugEx to DebugUtility 2023-04-02 03:10:36 +01:00
branding_Unity.png [ci skip] docs: vertically center Unity branding 2023-03-31 23:06:48 +01:00

README.md

GitHub Workflow Status MIT License

About

X10D (pronounced extend), is a .NET package that provides extension methods for numerous types. The purpose of this library is to simplify a codebase by reducing the need for repeated code when performing common operations. Simplify your codebase. Take advantage of .NET. Use extension methods.

(I'm also dogfooding this library, so there's that.)

Preface

Parity with the main branch of X10D, and full .NET feature support, is planned. Unity plan to add CoreCLR and native NuGet support in the future, but no timeline is available. For more information, see this forum post.

Installation

You must be using Unity 2021.3 LTS or later to add this package.

Using the Unity Package Manager (UPM)

To install X10D in Unity, follow the steps blow:

  1. Navigate to the Package Manager window, under Window > Package Manager
  2. Hit the + icon and select Add package from git URL...
  3. Enter the following URL: https://github.com/oliverbooth/X10D.git#upm and hit the Add button
  4. Profit!

The upm branch contains the latest nightly - that is the bleeding edge version of X10D. If you'd like to remain on a stable release, specify a commit hash after the # instead of upm. The latest current stable is 3.2.0, which is commit 55898d9e70228380b2d039c55e36d89cfe8a0fa2. Keep in mind that referencing a specific commit rather than the upm branch will prevent the auto-updater in Unity from detecting new versions.

Contributing

Contributions are welcome. See CONTRIBUTING.md.

License

X10D is released under the MIT License. See here for more details.