README.md

nwn-order

Go program written to enhance nwnxee persistent worlds with an external go program.

required software

• Docker
• Docker compose

Module requirements:

• Neverwinter Nights enhanced edition
• NWNXEE

Setup

For a starting docker compose template

https://github.com/Urothis/nwnxee-template

Docker Compose

version: '3'
services:
  nwn-order:
    hostname: nwn-order
    image: urothis/nwn-order:latest
    env_file: ${PWD-.}/config/nwnorder.env
    restart: always
    ports:
      - "5750:5750/tcp"
  redis:
    hostname: redis
    image: healthcheck/redis:latest
    command: ["redis-server", "--appendonly", "no"]
    hostname: redis
    volumes:
      - ${PWD-.}/redis:/data
    restart: always
  nwnxee-server:
    hostname: nwnxee-server
    image: nwnxee/unified:latest
    env_file: ${PWD-.}/config/nwserver.env
    stdin_open: true
    tty: true
    links:
      - "redis:redis"
    depends_on:
      - redis
    volumes:
      - ${PWD-.}/logs:/nwn/run/logs.0
      - ${PWD-.}/server/:/nwn/home
      - ${PWD-.}/logs:/nwn/data/bin/linux-x86/logs.0
    restart: always
    ports:
      - "5121:5121/udp"

If you are still running into issues feel free to stop by the discord

https://discord.gg/r6wuUdx

Project goals

This project started as a way for me to setup a full ci deployment. This has evolved into a fun way to see what we can do. Community involvement is appreciated.

Completed

• Extra heartbeats
• UUID generation

In Progress

• Full CI
• Cat facts
• Patreon integration
• Discord bot integration
• Whatever else the community suggests

NWSCRIPT

UUID

This function should be passed the player object only. It will return the assigned UUID to the player.

Internal scripts attach this uuid to the player tag.

OrderGetUUIDPlayer(oPC)

Should return the players unique ID

Example return:

6fc7438a87d42b2dec552b4fb81b75a2

Heartbeat

Heartbeat functionality can be enabled via config/nworder.env

NWN_ORDER_HB_VERBOSE=

Setting to true will disply more logs for heartbeat

NWN_ORDER_HB_ONE_MINUTE=true

Tickers will need to be enabled or disabled depending on your needs.

Default actions for heartbeat tickers are defined in order_heartbeat.nss

CI/Github

This requires alittle bit of setup to function.

Requirements: have a webhook setup for the repo you want to recieve alerts from. https://developer.github.com/webhooks/creating/

When the docker-compose does go up, order will spit out an external facing IP and port.

You will need to go into github and enable the webhook.

Example:

So when you deliver a webhook, order will accept the webhook and trigger the "OrderGithub();" function inside of order_github.nss

License