oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-14 03:55:42 +00:00
Code Issues
15d0f93f8b
X10D/X10D.Unity/README.md
Oliver Booth 150028716c
[ci skip] fix(docs): rename master -> main 
This change was made quite a while ago, actually. Surprisingly, it's gone unnoticed for a long time. 

"Nevermore," quoth the raven.
2023-03-31 23:02:56 +01:00

2.7 KiB
Raw Blame History

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.1.0, which is commit 9f3b09661b09e83690318370eea808e70dd4a72c. 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.