mizar/README.md

<!-- markdownlint-disable -->
<p align="center">
    <img src="https://raw.githubusercontent.com/Fabio286/mizar/master/assets/linux/256x256.png">
</p>
<!-- markdownlint-restore -->

# Mizar TCP Tester

![GitHub package.json version](https://img.shields.io/github/package-json/v/fabio286/mizar) ![GitHub](https://img.shields.io/github/license/fabio286/mizar) [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Ffabio286%2Fmizar%2Fbadge&style=flat)](https://actions-badge.atrox.dev/fabio286/mizar/goto) [![mizar](https://snapcraft.io/mizar/badge.svg)](https://snapcraft.io/mizar) [![mizar](https://snapcraft.io/mizar/trending.svg?name=0)](https://snapcraft.io/mizar)[![Plant a Tree](https://raw.githubusercontent.com/Fabio286/treedom-badge/master/svg/plant-a-tree.svg)](https://www.treedom.net/en/user/fabio-di-stasio/event/antares-for-the-planet)

Mizar is a TCP tester/debugger designed to be immediately useful and intuitive to use right out of the box.  
The purpose of Mizar is to help developers working on software that communicates over TCP protocol by speeding up debugging and testing from the earliest stages of development.

## Main features

### Client

- Open multiple sockets on multiple targets
- Send multiple messages
- Options to close on reply or persistend connections
- Loop mode
- Step test
- Min/max time interval between sends
- Display number of connected sockets and message sent and received

### Server

- Listen on multiple ports
- Echo server mode
- Trace received messages on console
- Display number of connected sockets and message/data received

## Installation

Based on your operating system you can have one or more distribution formats to choose based on your preferences.  
Since Mizar is a free software we don't have a budget to spend on annual licenses or certificates. This can result that on some platforms you might need to put in some additional work to install this app.

### Linux

On Linux you can simply download and run the `.AppImage` distribution or install from Snap Store.

### Windows

On Windows you can choose between downloading the app from Microsoft Store or downloading the `.exe` from [this github repo](https://github.com/Fabio286/mizar/releases/latest).  
Distributions that are not from Microsoft Store are not signed with a certificate, so to install you need to click on "More info" and then "Run anyway" on SmartScreen prompt.

### How to contribute

- 🌍 [Translate Mizar](https://github.com/Fabio286/mizar/wiki/Translate-Mizar)