Quasar/README.md

# Quasar

[![Build status](https://ci.appveyor.com/api/projects/status/5857hfy6r1ltb5f2?svg=true)](https://ci.appveyor.com/project/MaxXor/quasarrat)
[![Downloads](https://img.shields.io/github/downloads/quasar/QuasarRAT/total.svg)](https://github.com/quasar/QuasarRAT/releases)
[![License](https://img.shields.io/github/license/quasar/QuasarRAT.svg)](LICENSE)

**Free, Open-Source Remote Administration Tool for Windows**

Quasar is a fast and light-weight remote administration tool coded in C#. The usage ranges from user support through day-to-day administrative work to employee monitoring. Providing high stability and an easy-to-use user interface, Quasar is the perfect remote administration solution for you.

## Screenshots

![remote-shell](Images/remote-shell.png)

![remote-desktop](Images/remote-desktop.png)

![remote-files](Images/remote-files.png)

## Features
* TCP network stream (IPv4 & IPv6 support)
* Fast network serialization (Protocol Buffers)
* Compressed (QuickLZ) & Encrypted (TLS) communication
* UPnP Support
* Task Manager
* File Manager
* Startup Manager
* Remote Desktop
* Remote Shell
* Remote Execution
* System Information
* Registry Editor
* System Power Commands (Restart, Shutdown, Standby)
* Keylogger (Unicode Support)
* Reverse Proxy (SOCKS5)
* Password Recovery (Common Browsers and FTP Clients)
* ... and many more!

## Download
* [Latest stable release](https://github.com/quasar/QuasarRAT/releases) (recommended)
* [Latest development snapshot](https://ci.appveyor.com/project/MaxXor/quasarrat)

## Supported runtimes and operating systems
* .NET Framework 4.5.2 or higher
* Supported operating systems (32- and 64-bit)
  * Windows 10
  * Windows Server 2019
  * Windows Server 2016
  * Windows 8/8.1
  * Windows Server 2012
  * Windows 7
  * Windows Server 2008
  * Windows Vista
* For older systems please use [Quasar version 1.3.0](https://github.com/quasar/QuasarRAT/releases/tag/v1.3.0.0)

## Compiling
Open the project in Visual Studio 2019+ with installed .NET desktop development features and [restore the NuGET packages](https://docs.microsoft.com/en-us/nuget/consume-packages/package-restore). Once all packages are installed the project can be compiled as usual by clicking `Build` at the top or by pressing `F6`. See below which build configuration to choose from.

## Building a client
| Build configuration         | Usage scenario | Description
| ----------------------------|----------------|--------------
| Debug configuration         | Testing        | The pre-defined [Settings.cs](/Quasar.Client/Config/Settings.cs) will be used, so edit this file before compiling the client. You can execute the client directly with the specified settings.
| Release configuration       | Production     | Start `Quasar.exe` and use the client builder.

## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)

## Roadmap
See [ROADMAP.md](ROADMAP.md)

## Documentation
See the [wiki](https://github.com/quasar/QuasarRAT/wiki) for usage instructions and other documentation.

## License
Quasar is distributed under the [MIT License](LICENSE).  
Third-party licenses are located [here](Licenses).

## Thank you!
I really appreciate all kinds of feedback and contributions. Thanks for using and supporting Quasar!
Update resources and 3rd-party licenses 2018-10-04 15:49:25 +00:00			`# Quasar`
Added Roadmap 2018-07-03 18:02:25 +00:00
Update resources and 3rd-party licenses 2018-10-04 15:49:25 +00:00			`[![Build status](https://ci.appveyor.com/api/projects/status/5857hfy6r1ltb5f2?svg=true)](https://ci.appveyor.com/project/MaxXor/quasarrat)`
			`[![Downloads](https://img.shields.io/github/downloads/quasar/QuasarRAT/total.svg)](https://github.com/quasar/QuasarRAT/releases)`
			`[![License](https://img.shields.io/github/license/quasar/QuasarRAT.svg)](LICENSE)`
AppVeyor CI Integration closes #86 2015-05-06 13:45:48 +00:00
Begin renaming xRAT to Quasar 2015-08-19 18:01:23 +00:00			`Free, Open-Source Remote Administration Tool for Windows`
Initial commit 2014-07-08 12:27:59 +00:00
Update resources and 3rd-party licenses 2018-10-04 15:49:25 +00:00			`Quasar is a fast and light-weight remote administration tool coded in C#. The usage ranges from user support through day-to-day administrative work to employee monitoring. Providing high stability and an easy-to-use user interface, Quasar is the perfect remote administration solution for you.`
Edited Readme 2015-05-04 15:02:32 +00:00
Update documentation 2020-05-23 19:48:40 +00:00			`## Screenshots`

			`![remote-shell](Images/remote-shell.png)`

			`![remote-desktop](Images/remote-desktop.png)`

			`![remote-files](Images/remote-files.png)`

Added Roadmap 2018-07-03 18:02:25 +00:00			`## Features`
Updated README.md 2016-07-07 21:22:53 +00:00			`* TCP network stream (IPv4 & IPv6 support)`
Add basic TLS support 2018-10-21 12:22:31 +00:00			`* Fast network serialization (Protocol Buffers)`
			`* Compressed (QuickLZ) & Encrypted (TLS) communication`
Updated README.md 2014-07-31 19:07:52 +00:00			`* UPnP Support`
Initial commit with everything else 2014-07-08 12:58:53 +00:00			`* Task Manager`
			`* File Manager`
Forogt to add Startup Manager to features in README 2015-03-08 17:09:31 +00:00			`* Startup Manager`
Initial commit with everything else 2014-07-08 12:58:53 +00:00			`* Remote Desktop`
Updated README.md 2014-07-23 21:34:52 +00:00			`* Remote Shell`
Convert VS project files to new format and upgrade to .NET 4.5.2 2020-05-19 18:57:57 +00:00			`* Remote Execution`
Initial commit with everything else 2014-07-08 12:58:53 +00:00			`* System Information`
Convert VS project files to new format and upgrade to .NET 4.5.2 2020-05-19 18:57:57 +00:00			`* Registry Editor`
			`* System Power Commands (Restart, Shutdown, Standby)`
Edited Readme 2015-08-08 16:21:40 +00:00			`* Keylogger (Unicode Support)`
			`* Reverse Proxy (SOCKS5)`
Added FileZilla Password Recovery (thx to SandPox) #329 2015-08-17 11:26:09 +00:00			`* Password Recovery (Common Browsers and FTP Clients)`
Convert VS project files to new format and upgrade to .NET 4.5.2 2020-05-19 18:57:57 +00:00			`* ... and many more!`
Initial commit with everything else 2014-07-08 12:58:53 +00:00
Update documentation 2020-05-23 19:48:40 +00:00			`## Download`
			`* [Latest stable release](https://github.com/quasar/QuasarRAT/releases) (recommended)`
			`* [Latest development snapshot](https://ci.appveyor.com/project/MaxXor/quasarrat)`

Update Readme and update appveyor config 2018-08-16 19:06:44 +00:00			`## Supported runtimes and operating systems`
Convert VS project files to new format and upgrade to .NET 4.5.2 2020-05-19 18:57:57 +00:00			`* .NET Framework 4.5.2 or higher`
Update Readme and update appveyor config 2018-08-16 19:06:44 +00:00			`* Supported operating systems (32- and 64-bit)`
Edited Readme 2015-07-31 19:50:01 +00:00			`* Windows 10`
Convert VS project files to new format and upgrade to .NET 4.5.2 2020-05-19 18:57:57 +00:00			`* Windows Server 2019`
			`* Windows Server 2016`
			`* Windows 8/8.1`
			`* Windows Server 2012`
			`* Windows 7`
			`* Windows Server 2008`
			`* Windows Vista`
			`* For older systems please use [Quasar version 1.3.0](https://github.com/quasar/QuasarRAT/releases/tag/v1.3.0.0)`
Edited Readme 2015-06-20 19:24:03 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Compiling`
Update documentation 2020-05-23 19:48:40 +00:00			Open the project in Visual Studio 2019+ with installed .NET desktop development features and [restore the NuGET packages](https://docs.microsoft.com/en-us/nuget/consume-packages/package-restore). Once all packages are installed the project can be compiled as usual by clicking `Build` at the top or by pressing `F6`. See below which build configuration to choose from.
Updated README.md 2015-03-12 10:03:33 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Building a client`
Update Readme and update appveyor config 2018-08-16 19:06:44 +00:00			`\| Build configuration \| Usage scenario \| Description`
			`\| ----------------------------\|----------------\|--------------`
Update Readme 2018-11-19 15:44:39 +00:00			`\| Debug configuration \| Testing \| The pre-defined [Settings.cs](/Quasar.Client/Config/Settings.cs) will be used, so edit this file before compiling the client. You can execute the client directly with the specified settings.`
Convert VS project files to new format and upgrade to .NET 4.5.2 2020-05-19 18:57:57 +00:00			\| Release configuration \| Production \| Start `Quasar.exe` and use the client builder.
Initial commit with everything else 2014-07-08 12:58:53 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Contributing`
			`See [CONTRIBUTING.md](CONTRIBUTING.md)`
Edited Readme 2015-05-04 15:02:32 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Roadmap`
			`See [ROADMAP.md](ROADMAP.md)`
Initial commit with everything else 2014-07-08 12:58:53 +00:00
Update documentation 2020-05-23 19:48:40 +00:00			`## Documentation`
			`See the [wiki](https://github.com/quasar/QuasarRAT/wiki) for usage instructions and other documentation.`

Added Roadmap 2018-07-03 18:02:25 +00:00			`## License`
Update documentation 2020-05-23 19:48:40 +00:00			`Quasar is distributed under the [MIT License](LICENSE).`
Update resources and 3rd-party licenses 2018-10-04 15:49:25 +00:00			`Third-party licenses are located [here](Licenses).`
Updated Credits in Readme 2015-07-15 17:17:43 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Thank you!`
Begin renaming xRAT to Quasar 2015-08-19 18:01:23 +00:00			`I really appreciate all kinds of feedback and contributions. Thanks for using and supporting Quasar!`