gs-manager

GS manager

This is the source code for an open-source project for managing NeverWinter Nights game servers using docker. All testing to date has been done using Linux, this should also work on Windows but there might be some bugs. Here are the following key features of this project

• Currently supported features
  • Create and run multiple game servers each with its own config
  • Create groups of volumes that can be used by one or many game servers
  • Easily manage CEP packs
  • Manage databases used for persistant worlds
  • View actively logged in players
  • Very basic character editor (not stable)
  • Restful API
  • Viewing Player login history for servers with advanced filtering
• Features under development
  • Support for emailing/texting distribution lists when players log on
    • Will be configurable and will allow for distribution lists
  • Pulling of specific NWN docker versions and updating to latest
  • Selecting different docker images other than nwn
  • Full featured vharacter editor
  • Log file viewer
  • Unit tests
• Features considered but not yet planned
  • Revamp integrated file manager to be more modern
  • Support for managing other game servers
  • Support for managing/running nwn servers outside of docker

Installation (Under Construction)

• Install required software in a Linux environment: Docker and Python
  • NOTE: If someone wants to run it in Windows it should not be hard to get working and I would be more than willing to help out!
• Download and extract gs-manager
• Install python required packages by running the following command in the root directory of gs-manager:

  pip install -r requirements.txt
  

• make a directory for server files, I will refer to that directory as DOCKER_STORAGE in the rest of this README
• Configure front-end (web pages)
  • Copy gs_manger/config_example.py to the gs_manager/config.py
  • Edit gs_manager/config.py and change GS_PATH_STORAGE to point to your DOCKER_STORAGE location
• Configure backend (docker and game server manager)
  • Install NWN docker image by running the following command:

    docker pull nwnxee/unified
    

• Copy backends/nwnee/config_example.py to the backends/nwnee/config.py
• Most likely you will NOT need to edit this config.py unless you are also using mysql for a persistant world.
• Executing the program(s)
  • Start the front-end first
    • If your using a python virtual environment make sure to start it first (https://docs.python.org/3/library/venv.html)
    • To start web front-end it is recommended to use a webserver like gunicorn and run a command simular to this one:

      gunicorn -b 0.0.0.0:5000 -w 4 'gs_manager:create_app()'
      

    • For debub purposes and test purposes you can use the flask web server

      flask --app gs_manager run
      

  • Start the backend

    PYTHONPATH="$(pwd)" python backends/nwnee/docker/nwnee.py
    

Screenshots

Server Management

List/Control active servers

Add new server

• The volumes selection allows you to select what docker volume mounts from the volume manager that you want available for this server. Volumes can also be overlaid.

  Volume management

  List/Add/Delete Volumes

  

  Enter Volume Information

  

  Integrated File Manager: Upload/download/delete modules and characters including a character editor

  You can browser up and down directories by clicking on the links and the “..” lets you go back a directory. The max top level is set in a server config file to protect against accessing other portions of your server

  Server Modules

  

  Characters

  Character Editor

  

Logged in Users

Player Login History

This site is open source. Improve this page.