Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
gamemann committed Apr 22, 2024
1 parent 6ca69d4 commit 0e047b3
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,21 @@ There is additional command line usage with the AF_XDP version which may be foun
## Configuration File
If you want to use more than one sequence or more control, you will need to specify sequences inside of a config file using the [JSON syntax](https://www.w3schools.com/js/js_json_syntax.asp).

Here is the config file format.
Before continuing, here is information on the types used below with the config.

| Name | Length (Bytes) | Unsigned | Description |
| ---- | ------ | -------- | ----------- |
| string | `N/A` | no | A string terminated by `\0`. |
| byte | 1 | yes | A single byte integer. |
| boolean | 1 | yes | A single `true` (1) or `false` (0) value. |
| ushort | 2 | yes | An unsigned short. |
| short | 2 | no | A short. |
| uint | 4 | yes | An unsigned integer. |
| int | 4 | no | An integer. |
| long | 8 | no | A long. |
| ulong | 8 | yes | An unsigned long. |

Here is the full config file format.

| Key | Type | Default | Description |
| --- | ---- | ------- | ----------- |
Expand Down

0 comments on commit 0e047b3

Please sign in to comment.