https://github.com/voutilad/groom

Works with my chocolate-doom fork to relay telemetry into a Neo4j graph database
https://github.com/voutilad/groom

doom graph-database java neo4j

Last synced: 6 days ago
JSON representation

Works with my chocolate-doom fork to relay telemetry into a Neo4j graph database

• Host: GitHub
• URL: https://github.com/voutilad/groom
• Owner: voutilad
• License: gpl-3.0
• Created: 2020-04-05T21:08:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-09T17:20:16.000Z (about 4 years ago)
• Last Synced: 2024-10-30T19:46:22.079Z (about 2 months ago)
• Topics: doom, graph-database, java, neo4j
• Language: Java
• Homepage:
• Size: 517 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
```

          _____ ______  _____  _____ ___  ___

         |  __ \| ___ \|  _  ||  _  ||  \/  |

         | |  \/| |_/ /| | | || | | || .  . |

         | | __ |    / | | | || | | || |\/| |

         | |_\ \| |\ \ \ \_/ /\ \_/ /| |  | |

          \____/\_| \_| \___/  \___/ \_|  |_/

```

# groom

Do you like Doom?

Do you like Graph Databases?

Then this is for you!

## Pre-Requisites

You'll want to grab [my Chocolate-Doom fork](https://github.com/voutilad/chocolate-doom), build it, and have it configured to send telemetry events over UDP.

## Building

Use the gradle wrapper...

```bash

$ ./gradlew distTar

```

or...

```cmd

C:> gradlew.bat distZip

```

## Running

Assuming you've unpacked the dist zip/tar somewhere...you can use the helpful `bin/groom[.bat]` script to run the app:

```

$ ./build/distributions/groom-1.0-SNAPSHOT/bin/groom --help

usage: groom [-h] [--uri URI] [--user USER] [--password PASSWORD] [--tls TLS] [--db DB]

             [--udp-host UDP_HOST] [--udp-port UDP_PORT] [--buffer-size BUFFER_SIZE]

             [--flush-interval FLUSH_INTERVAL]

named arguments:

  -h, --help             show this help message and exit

Neo4j Host Settings:

  --uri URI              Bolt URI to target Neo4j database (will override TLS setting)

  --user USER

  --password PASSWORD

  --tls TLS              Ues a TLS Bolt connection?

  --db DB

UDP Event Listener:

  --udp-host UDP_HOST    IPv4 host to bind to

  --udp-port UDP_PORT    udp port to listen on

  --buffer-size BUFFER_SIZE

                         event buffer size

  --flush-interval FLUSH_INTERVAL

                         event buffer flush interval

```