Version 3 [06/18/25]

.env

@@ -0,0 +1,118 @@
+#########################################################
+# Dome-Client Environmental Variables and Configuration #
+#                                                       #
+#                                                       #
+#########################################################
+#                  Basic Configuration                  #
+#########################################################
+# Setting ENVIRONMENT to anything aside from production #
+# will put the app in debugging mode, where it will     #
+# show more logs, and not minify the javascript, making #
+# it easier to debug the frontend.                      #
+#                                                       #
+ENVIRONMENT=dev
+#                                                       #
+# Version number for the webclient
+#                                                       #
+VERSION_MAJOR=3
+VERSION_MINOR=0
+#                                                       #
+# PORT is the port you want your application to run on  #
+# if you set this to 80, you must run the server as root#
+# or allow node access to port 80.                      #
+#                                                       #
+PORT=3000
+#                                                       #
+# IP is optional & useful if the server has more than 1 #
+#                                                       #
+# IP=208.52.189.19
+#                                                       #
+# Used in various places backend /  frontend            #
+#                                                       #
+POWERED_BY="Dome Client"
+#                                                       #
+# Used in Express, default is probably fine             #
+#                                                       #
+SESSION_SECRET=secret
+#
+# If this setting is true, then the client will allow   #
+# the user to enter a host/port and connect to that game#
+# if it's false, the client is scoped only to the game  #
+# you configure in this file                            #
+CONNECT_ANYWHERE=true
+#########################################################
+#                  Socket.io Configuration              #
+#########################################################
+# Set DEBUG to socket.io* if you want to enable detailed#
+# debugging on all socket connections. Warning: SPAMMY  #
+#                                                       #
+#DEBUG=socket.io*
+#                                                       #
+# SOCKET_URL is where your webclient is running, + the  #
+# port you're running it. The port should be the same as#
+# the port set above. If you were running this in prod  #
+# you might set this to http://mysite.com:3000          #
+# If you are using standard ports such as 80 for http   #
+# and 443 for https, then byou can omit the :port       #
+#                                                       #
+SOCKET_URL=http://localhost:3000
+#                                                       #
+# SOCKET_URL_SSL is same as above and should be included#
+# when you are using SSL. Typically it's the same as    #
+# SOCKET_URL, but with https instead of http. You can   #
+# omit the :port if you are using 443 (typical)
+#                                                       #
+# SOCKET_URL_SSL=https://localhost:3000
+#                                                       #
+# SOCKET_PROXIED is used when are running your webclient#
+# on a non 80/443 port, any proxying the connection     #
+# through something like nginx or apache                #
+# if you're doing that, set it to true                  #
+#                                                       #
+SOCKET_PROXIED=false
+#                                                       #
+#########################################################
+#                  SSL Configuration                    #
+#########################################################
+# SSL is optional, and is enabled by setting an SSL_PORT#
+# along with the other items. The three items below are #
+# what I use to get SSL setup.
+#                                                       #
+#SSL_PORT=443,
+#SSL_KEY=config/ssl/BlahBlah.key
+#SSL_CERT=config/ssl/BlahBlah.crtpassphrase
+#                                                       #
+# If you want to use an SSL_CA you can, though I have   #
+# not tested this in a while.                           #
+#                                                       #
+#SSL_CA=path/to/file
+#                                                       #
+# This is optional, I don't actually know how to use    #
+# it :)                                                 #
+#                                                       #
+#SSL_PASSPHRASE=
+#                                                       #
+#########################################################
+#               Game Configuration                      #
+#########################################################
+# Define the details of your game with the config here  #
+#
+GAME_NAME="My game"
+#                                                       #
+# You can technicaly put an IP here as well             #
+#                                                       #
+GAME_HOST=moo.sindome.org
+GAME_PORT=5555
+#                                                       #
+# Passed to the Frontend                                #
+#                                                       #
+GAME_WEBSITE=///www.test.com/
+#                                                       #
+# specialized autocomplete for each player class you can#
+# update the files with your own autocomplete, or       #
+# comment this out to disable it. AUTOCOMPLETE_PLAYER is#
+# 'p' in the routes, and AUTOCOMPLETE_GUEST is 'o'      #
+#                                                       #
+AUTOCOMPLETE_PLAYER=config/ac/player.txt #
+AUTOCOMPLETE_GUEST=config/ac/guest.txt   #
+#########################################################

.env-example

@@ -0,0 +1,117 @@
+########################################################
+# Dome-Client Environmental Variables and Configuration #
+#                                                       #
+#                                                       #
+#########################################################
+#                  Basic Configuration                  #
+#########################################################
+# Setting ENVIRONMENT to anything aside from production #
+# will put the app in debugging mode, where it will     #
+# show more logs, and not minify the javascript, making #
+# it easier to debug the frontend.                      #
+#                                                       #
+ENVIRONMENT=dev
+#                                                       #
+# Version number for the webclient
+#                                                       #
+VERSION_MAJOR=3
+VERSION_MINOR=0
+#                                                       #
+# PORT is the port you want your application to run on  #
+# if you set this to 80, you must run the server as root#
+# or allow node access to port 80.                      #
+#                                                       #
+PORT=3000
+#                                                       #
+# IP is optional & useful if the server has more than 1 #
+#                                                       #
+# IP=208.52.189.19
+#                                                       #
+# Used in various places backend /  frontend            #
+#                                                       #
+POWERED_BY="Dome Client"
+#                                                       #
+# Used in Express, default is probably fine             #
+#                                                       #
+SESSION_SECRET=secret
+                                                       #
+# If this setting is true, then the client will allow   #
+# the user to enter a host/port and connect to that game#
+# if it's false, the client is scoped only to the game  #
+# you configure in this file                            #
+CONNECT_ANYWHERE=false                                  #
+#########################################################
+#                  Socket.io Configuration              #
+#########################################################
+# Set DEBUG to socket.io* if you want to enable detailed#
+# debugging on all socket connections. Warning: SPAMMY  #
+#                                                       #
+# DEBUG=socket.io*
+# SOCKET_URL is where your webclient is running, + the  #
+# port you're running it. The port should be the same as#
+# the port set above. If you were running this in prod  #
+# you might set this to http://mysite.com:3000          #
+# If you are using standard ports such as 80 for http   #
+# and 443 for https, then byou can omit the :port       #
+#                                                       #
+SOCKET_URL=http://localhost:3000
+#                                                       #
+# SOCKET_URL_SSL is same as above and should be included#
+# when you are using SSL. Typically it's the same as    #
+# SOCKET_URL, but with https instead of http. You can   #
+# omit the :port if you are using 443 (typical)
+#                                                       #
+# SOCKET_URL_SSL=https://localhost:3000
+#                                                       #
+# SOCKET_PROXIED is used when are running your webclient#
+# on a non 80/443 port, any proxying the connection     #
+# through something like nginx or apache                #
+# if you're doing that, set it to true                  #
+#                                                       #
+SOCKET_PROXIED=false
+#                                                       #
+#########################################################
+#                  SSL Configuration                    #
+#########################################################
+# SSL is optional, and is enabled by setting an SSL_PORT#
+# along with the other items. The three items below are #
+# what I use to get SSL setup.
+#                                                       #
+#SSL_PORT=443,
+#SSL_KEY=config/ssl/BlahBlah.key
+#SSL_CERT=config/ssl/BlahBlah.crtpassphrase
+#                                                       #
+# If you want to use an SSL_CA you can, though I have   #
+# not tested this in a while.                           #
+#                                                       #
+#SSL_CA=path/to/file
+#                                                       #
+# This is optional, I don't actually know how to use    #
+# it :)                                                 #
+#                                                       #
+#SSL_PASSPHRASE=
+#                                                       #
+#########################################################
+#               Game Configuration                      #
+#########################################################
+# Define the details of your game with the config here  #
+#
+GAME_NAME="My game"
+#                                                       #
+# You can technicaly put an IP here as well             #
+#                                                       #
+GAME_HOST=your.game.com
+GAME_PORT=5555
+#                                                       #
+# Passed to the Frontend                                #
+#                                                       #
+GAME_WEBSITE=///www.test.com/
+#                                                       #
+# specialized autocomplete for each player class you can#
+# update the files with your own autocomplete, or       #
+# comment this out to disable it. AUTOCOMPLETE_PLAYER is#
+# 'p' in the routes, and AUTOCOMPLETE_GUEST is 'o'      #
+#                                                       #
+AUTOCOMPLETE_PLAYER=config/ac/player.txt #
+AUTOCOMPLETE_GUEST=config/ac/guest.txt   #
+#########################################################

.gitignore

@@ -1,3 +1,4 @@
+.env
 lib-cov
 *.seed
 *.log
@@ -6,14 +7,10 @@ lib-cov
 *.out
 *.pid
 *.gz
-
 pids
 logs
 results
-
 node_modules
-public/css
-
 npm-debug.log
 .metadata
-.idea
+.idea

CHANGELOG.md

@@ -1,5 +1,24 @@
 # CHANGE LOG
 
+## 06/18/25
+* Fixed several bugs
+* Updated .env-example
+
+## 04/11/25
+
+* Updated README
+* Fixing a few things before releasing
+* Updated copyright year
+
+## 11/15/23
+
+* Full rebuild from the Sindome Webclient, stripping out unneeded things
+* Integration of .env for all configuration
+* Updated README and instructions to make setup much easier
+* All dependencies have been Updated
+* Can runs on Node 18 now!
+* A bunch of other changes, this is a major release and is not backwards compatible in many ways.
+
 ## 01/17/19
 
 * Added ability to toggle the connect to any server / connect to a specific game option in config

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013, The Sindome Group
+Copyright (c) 2023, The Sindome Corporation
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -8,14 +8,14 @@ modification, are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
-    * Neither the name of The Sindome Group nor the
+    * Neither the name of The Sindome Corporation nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE SINDOME GROUP BE LIABLE FOR ANY
+DISCLAIMED. IN NO EVENT SHALL The Sindome Corporation BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND