search

UnicordDev / Unicord

A free, open source Discord Client for Windows 10 and Windows Phone 10
MIT License
265 stars 28 forks source link

readme

Unicord

A free, open source Discord Client for Windows 10 and Windows 10 Mobile, providing a fast, efficient, native feeling Discord experience, while adding handy extras along the way. Built on DSharpPlus!

Build Status

promo

Downloads

See the latest release!

Getting Started

So you wanna build Unicord, well you're gonna need to have a few things handy.

Prerequisites

Building and Installing

Firstly, as with all GitHub projects, you'll want to clone the repo, but you will also need to pull submodules, to do this, use:

$ git submodule update --init --recursive

From here, building should be as simple as double clicking Unicord.sln, ensuring your targets are appropriate to your testing platform (i.e. Debug x64), and hitting F5. Once built and deployed, it should show in your start menu as "Unicord Canary", data and settings are kept separate from the Store version, so they can be installed side by side.

Canary

Testing

Unicord currently lacks any kind of unit testing. This will likely change as I adopt a more sane workflow, but for now, I suggest going around the app and making sure everything you'd use regularly works, and ensuring all configurations build. A handy way of doing this, is Visual Studio's Batch Build feature, accessible like so:

batch build

On one specific note, while the project technically targets a minimum of Windows 10 version 1709 (Fall Creators Update), all code should compile and run on version 1703 (Creators Update) to maintain Windows Phone support. Please pay special attention to the minimum required Windows version when consuming UWP APIs, and be careful when consuming .NET Standard 2.0 APIs, which may require a newer Windows version.

Contributing

Unicord accepts contributions! Want a feature that doesn't already exist? Feel free to dig right in and give it a shot. Do be mindful of other ongoing projects, make sure someone isn't already building the feature you want, etc. If you don't have the know how yourself, file an issue, someone might pick up on it.

Get in Touch

We have a Discord server specifically for Unicord development and testing, join here:

Unicord

License

Unicord is licensed under the MIT License.

Acknowledgements