doomsider / shadow

Shadow is a script that works with Mysql to gather data and interact with game servers

shadow

General: Shadow is a script that works with Mysql to gather data and interact with game servers that have console input and output

Shadow is written and tested with StarMade in mind but will be flexible enough to use with other game servers as well. It is designed to allow modification to game servers without changing or modifying the server. It works by collecting the standard and error outputs of a server and issuing admin commands to the console.

Development: Adding useful modifications and testing towards an Alpha release

Install Easy:

wget https://raw.githubusercontent.com/doomsider/shadow/master/install.sh in the directory Starmade is or will be.

chmod +x install.sh

./install.sh

Follow the on screen instructions and be sure to go through all the steps

Install Manual:

Shadow is in testing mode only at the moment. The current target test system is Ubuntu 14.04 and Mysql 5.5. If you want to test shadow on other operating systems or configurations I cannot offer support during testing.

Step1 - Get Shadow's files and directories from Github then copy shadow files/dirs to the parent directory of Starmade if it exists. If it doesn't exist put them in the same directory you plan to install StarMade to.

Step2 - Prerequisites must be installed for the script to function properly. For Ubuntu you must install Java, Mysql, Zip, Dos2unix, Curl, and Screen if they are not installed already

EXAMPLE INSTALL COMMANDS FOR UBUNTU 14.04

sudo apt-get install screen

sudo apt-get install mysql-server libapache2-mod-auth-mysql php5-mysql

sudo apt-get install default-jre

sudo apt-get install zip

sudo apt-get install dos2unix

sudo apt-get install curl

sudo apt-get install git

SPECIAL NOTE:  You must set a root password for Mysql for Shadow to function, do not leave this blank.

Step3 - Make shadow.dtsd executable with a chmod +x shadow.dtsd.

Step4 - Run ./shadow.dtsd to see if there are formatting errors. If you get this error -bash: ./shadow.dtsd: /bin/bash^M: bad interpreter: No such file or directory then you must run dos2unix shadow.dtsd.

Step5 - Download or copy over an existing install of Starmade. To download with Shadow issue a ./shadow.dtsd download. This command will also update the server.

SPECIAL NOTE: Due to a bug in the Starmade starter file the install or upgrade/update will hang on the last file and the user with have to ctrl-c to break out.

Step6 - Run setup with ./shadow.dtsd setup. Go through the configuration completely before attempting to run Starmade. This will create a file in /core called config.dtsd that can be edited later.

SPECIAL NOTE:  When setting minimum or max memory it must have a m after it.  For example 1024m.

Step7 - Verify everything is working. Run the server with ./shadow.dtsd start and then check the Starmade server screen with screen -r screename_youpicked or try to connect with a client.

Additional Configuration and Notes for Shadow:

Typing ./shadow.dtsd will display the available commands.

To update StarMade issue a ./shadows.dtsd download.

To set initial rank for a player ./shadow.dtsd changerank player rank (example: ./shadow.dtsd changerank Doomsider Admiral).

You can edit what ranks can use what chat commands in /modules/rank.dtsd under COMMANDLIST_RANK1 through COMMANDLIST_RANK5. To rebuild ranks database do a ./shadow.dtsd setranks.

Writing Modules:

Writing you own module is what Shadow was designed for. There are several functions that allow building of modules to be independent of the existing scripts. This means you can just drop in your own script into /modules. For instance mymodule.dtsd.

MYSQL - Mysql is used heavily in Shadow and you will have to become somewhat familiar with it depending on what you wish to do. Basic examples of interacting with Mysql can be seen in /core/lib_mysql.dtstd and throughout the other scripts.

Creating a database is as easy as including MYSQLDTSD_TABLENANE_COLUMNNAME="Mysql information for column".  

Here is an example from the script that creates the Name column for Players MYSQLDTSD_PLAYERDB_NAME="VARCHAR(25)".

Naming Conventions - Shadow looks at its own functions' names to determine special circumstances for the script.

Any function that starts with core_ will be available for execution for the ./shadow.dtsd command line and be listed as an available function.  

Any function that starts with chatcommand_ will be available to be executed through chatcommands in the client.  Please put function name in all caps and don't forget to add it to the ranks database for the proper rank or you wont be able to see or execute it from the client.

Any function that starts with lib_ is a library function.  In this context this means it is an internal function expected to be used by several other functions.  The lib_ designation is only for ease of identification of heavily used functions.

Any variable that starts with LOGSEARCH_ will automatically entered into the search database and then the result will be returned to the specified function.  The format is LOGSEARCH_functioname="String match in log".

Any variable that starts with MYSQLEVENT_ will be added to the running Mysql events.  Mysql event manager must be turned on for these to work.  The format is MYSQLEVENT_FREQUENCY_TIMEVALUE_TIMEQUANTITY_EVENTNAME="EVENT_FUNCTION_NAME"

Known Issues: Mysql 5.6+ is not compatible with this script at this time

Future Goals (feel free to edit/add):

Enhance server web pages with information from the database.

Add a web admin panel to control the game server remotely.

Current Work list(no particular order):

AI Guards
Reduce the size of the universe by deleting unused sectors
Faction Bank Accounts for credits and faction points
Tooltips
Custom color message box integration
Shop Restock automated
Shop replace default shops
Cool down for user chat commands
Ship quarantine for going over block size or other set parameters
Faction DB and tracking faction statistics
Basic PHP connection examples to extract information with a web page
Duelling
Arena

Ideas (feel free to edit/add):

Create classes/professions for SM: Classes or professions based on goal related to profession. For example a miner gains experience mining asteroids. Classes would have special abilities after certain levels. For example a bounty hunter could detect bounties close by.

Scripted events upon entering sectors: Basic missions given by NPCs. Script would spawn entities related to the script when the player enters with a check in change_sector.

More control over universe generation: Ability to reduce database by removing unused sectors by cross checking player creations with sectors and resetting sectors that are not being used.

Faction Maintenance: Be able to tax factions based on their total block count (all ships combined) as a system to prevent build-up and also to keep factions active

Alien Races: Script to simulate a universe generation combined with alien race stations and ships.

shadow's Issues

Cannot update StarMade.

I get this error when I check for updates on shadow.dtsd.
https://gist.github.com/thakyZ/ab9a7ee6c6daa09f41e12d17cd522648

Updates for new starmade version to keep script working as it should

Hi,
I managed to make pull request containing fix for one of recent starmade updates, which changes server log filenames. Dont mind a bit of a mess in gitignore if You wish. Details are in pull request message.
Greetings
w34

Vote points are added back after stop and restart

Step to replicate

Stop -r server properly

after terminated start -r and allow to boot

votes were readded EX i had 18 points when i had logged out last night, used 9 and, then played for a few hours before restarting after some changes. I had 18 again when the server was restarted when I should have only had 9 points

Scriptscreen http://pastebin.com/9s4EM7Ve

Mainscreen http://pastebin.com/dQkRY3vi

Faction database

hello is it possible to have the faction in a table in the database ?

Garage timer

The game's own built in spawn delay should trigger fine and limit possible abuse but placing an additional admin configurable limit with its own error (before it passes the command to the server) would be helpful.

Additionally; Suppressing the server's error message (IF invoked when calling for a ship too soon) and replacing it with message that's more contextual would be nice. This would be especially useful if a newbie owner or admin sets the delay too fast. Anything faster than the server's cool down.. And is wondering why they can't get their ships.

Shadow trying to access database it cannot access

~/StarMade$ /home/-/StarMade/shadow.dtsd makesearchdb
~/StarMade$ /home/-/StarMade/shadow.dtsd softstart
/home/-/StarMade/shadow.dtsd addevents
~/StarMade$ /home/-/StarMade/shadow.dtsd logloop
mysqlimport: [Warning] Using a password on the command line interface can be insecure.
mysqlimport: Error: 1044 Access denied for user 'user'@'localhost' to database 'dtsddb'
ERROR 1064 (42000) at line 1: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'AND SERVERLOG.line >= 1 ORDER BY SERVERLOG.line ASC' at line 1
/home/-/StarMade/core/core_loops.dtsd: line 74: let: MYSQLSTART=: syntax error: operand expected (error token is "=")

This error shows it is accessing dtsddb when it is supposed to be accessing zdtsddb but it is not. Although it says in every config file that it is supposed to access zdtsddb.
(some fields were changed to protected the user account)

external SQL

hello is it possible you to use an external database for the script in the configuration ?

when using the new setup process it doesnt put the m after he min max sizes.

had to go into defaults.dtsd to add it after running setup

migration DTSD to shadow ?

hello, a simple question ! how the DTSD migrated data to the database shadow ?

I did my tests currently on a vm based on archlinux ! all work perfectly ! I would share my setup in the coming days ! I still made ​​many test!

compared to the shadow of improvement for multi-server management while fonctionera since config.dtsd file so each server will have its own database ?

the integration of a shadow.dtsd updatebase variable for the update shadow pourais added a small asset! if that would avoid the duty of every customer retelechargée and reinstalled the basis of the script ( this obtion may be established if the case I did not view = (sorry )

cordially ELstringer

introduction ?

hello, how meter up this new system on my server?

bug report

Can you would add a field to see what joeuur connédtée currently on the server ?

resolve the bug faction in the player table
IDs faction are not updated

Crash while trying to restart and backup the universe.

So I found out why my server has been crashing and here is the log: http://pastebin.com/MNdw7SVT
The server seems to want to restart the server and then trying to back it up but it cannot because of an error.
ERROR 1537 (HY000) at line 1: Event 'SERVERRESTART' already exists
this is SCHEDULETYPE SYSTEM
ERROR 1537 (HY000) at line 1: Event 'SERVERUNIVERSEBACKUP' already exists