gsd-cli 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1af1b9f1e06257b793b423b63114a3bab02cd955f4e55faaeb2a4a79f42cf2e7
+  data.tar.gz: 2a84ab555e3ee15fe6be3e8667a56fe4fe6bea640641fa002f9543db275b97bc
+SHA512:
+  metadata.gz: fb952a50c5307b0793139bcfa1cbb076c65054418cbf487b9884fd5dc3b7763baea3ea371364853645661ffa8576b5af0e5763e0b564cddd29132aa20525665c
+  data.tar.gz: 57e13347822f92779403c24dc3d9059321724919e158fbfc84cccdc5c51fbd6a9fc6cba49db9392fe0c36436f5d295e2f1a037d6d09f9ae24ef19f69613e9f1b

data/bin/gsd-cli

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "cli"

data/lib/cli.rb

@@ -0,0 +1,117 @@
+require "commander/import"
+require "game_template"
+require "game_servers/gmod"
+require "game_servers/rust"
+require "game_servers/terraria"
+require "game_servers/starbound"
+require "game_servers/seven_days"
+require "game_servers/team_fortress"
+require "game_servers/minecraft_ftb"
+require "game_servers/minecraft_spigot"
+require "game_servers/ace_of_spades"
+
+def userdata
+  {
+    "rust" => Rust.new,
+    "sdtd" => SevenDays.new,
+    "gmod" => GarrysMod.new,
+    "aos" => AceOfSpades.new,
+    "tf2" => TeamFortress.new,
+    "ftb" => MinecraftFtb.new,
+    "terraria" => Terraria.new,
+    "starbound" => Starbound.new,
+    "minecraft" => MinecraftSpigot.new
+  }
+end
+
+@games = userdata
+
+program :name, "gsc-cli"
+program :version, "0.1.0"
+program :description, "A cli tool to manage dedicated game servers on Linux"
+
+command :install do |c|
+  c.syntax = "gsd install [args] [options]"
+  c.summary = "Install and deploy a dedicated game server as a daemon."
+  c.description = "Installs and deploy a dedicated game server as a daemon (systemd unit)."
+  c.option "--path STRING", String, "Path that the game server will be installed to."
+  c.option "--steamuser STRING", String, "Steam user account required to install certain games."
+  c.option "--steampassword STRING", String, "Steam account password for installing certain games."
+  c.action do |args, options|
+    GameTemplate.new(@games[args.first()], options.path).install(options.steamuser, options.steampassword)
+  end
+end
+
+command :run do |c|
+  c.syntax = "gsd run [args]"
+  c.summary = "Run an installed dedicated game server as a new process."
+  c.description = "Runs an installed dedicated game server as a new process. This command is used by the daemon and is not designed to be run manually."
+  c.option "--path STRING", String, "Path that the game server will be installed to."
+  c.action do |args, options|
+    GameTemplate.new(@games[args.first()], options.path).run()
+  end
+end
+
+command :update do |c|
+  c.syntax = "gsd install [args] [options]"
+  c.summary = "Updates an installed dedicated game server."
+  c.description = "Updates an installed dedicated game server."
+  c.option "--path STRING", String, "Path that the game server will be update to."
+  c.action do |args, options|
+    GameTemplate.new(@games[args.first()], options.path).update()
+  end
+end
+
+command :start do |c|
+  c.syntax = "gsd start [args]"
+  c.summary = "Start a installed dedicated game server."
+  c.description = "Starts a dedicated game server daemon that has already been installed to the system."
+  c.action do |args|
+    GameTemplate.new(@games[args.first()]).start()
+  end
+end
+
+command :restart do |c|
+  c.syntax = "gsd restart [args]"
+  c.summary = "Restart a installed dedicated game server."
+  c.description = "Restarts a dedicated game server daemon that has already been installed to the system."
+  c.action do |args|
+    GameTemplate.new(@games[args.first()]).restart()
+  end
+end
+
+command :status do |c|
+  c.syntax = "gsd status [args]"
+  c.summary = "Display the status of a installed dedicated game server."
+  c.description = "Requests and returns the status of a installed dedicated game server from systemd."
+  c.action do |args|
+    GameTemplate.new(@games[args.first()]).status()
+  end
+end
+
+command :stop do |c|
+  c.syntax = "gsd stop [args]"
+  c.summary = "Stop running dedicated game server."
+  c.description = "Stops a running dedicated game server daemon."
+  c.action do |args|
+    GameTemplate.new(@games[args.first()]).stop()
+  end
+end
+
+command :enable do |c|
+  c.syntax = "gsd enable [args]"
+  c.summary = "Force a dedicated game server daemon to launch at system start."
+  c.description = "Enables a dedicated game server daemon to start when the system starts."
+  c.action do |args|
+    GameTemplate.new(@games[args.first()]).stop()
+  end
+end
+
+command :disable do |c|
+  c.syntax = "gsd disable [args]"
+  c.summary = "Disable a dedicated game server daemon from starting at system start."
+  c.description = "Disables a dedicated game server daemon from starting when the system starts."
+  c.action do |args|
+    GameTemplate.new(@games[args.first()]).stop()
+  end
+end

data/lib/game_servers/ace_of_spades.rb

@@ -0,0 +1,14 @@
+# A class for Feed The Beast Minecraft Server
+class AceOfSpades
+  attr_reader :name, :app_id
+  def initialize
+    @name = "aos"
+    @app_id = nil
+  end
+
+  def launch(install_path)
+  end
+
+  def install_server(install_path)
+  end
+end

data/lib/game_servers/gmod.rb

@@ -0,0 +1,24 @@
+# A module to produce resources for a Garry's Mod server
+class GarrysMod
+  attr_reader :name, :app_id
+  def initialize
+    @name = "gmod"
+    @app_id = "4020"
+  end
+
+  def launch(install_path, map = "gm_construct", players = 16, collection_id = "1270037458")
+    "cd #{install_path} &&
+    #{install_path}/srcds_run \
+    -console \
+    -game garrysmod \
+    +map #{map} \
+    +maxplayers #{players} \
+    +host_workshop_collection #{collection_id} \
+    -condebug & \
+    /usr/bin/tail -f #{install_path}/garrysmod/console.log"
+  end
+
+  def post_install(install_path)
+    system("touch #{install_path}/garrysmod/console.log")
+  end
+end

data/lib/game_servers/minecraft_ftb.rb

@@ -0,0 +1,23 @@
+# A class for Feed The Beast Minecraft Server
+class MinecraftFtb
+  attr_reader :name, :app_id
+  def initialize
+    @name = "ftb"
+    @app_id = nil
+  end
+
+  def launch(install_path)
+    "cd #{install_path} && /bin/bash #{install_path}/ServerStart.sh"
+  end
+
+  def install_server(install_path)
+    system("wget https://media.forgecdn.net/files/2658/240/FTBRevelationServer_2.7.0.zip -O /tmp/server.zip")
+    system("mkdir #{install_path}")
+    system("unzip /tmp/server.zip -d#{install_path}")
+    system("chmod +x #{install_path}/ServerStart.sh")
+    system("chmod +x #{install_path}/FTBInstall.sh")
+    system("/bin/bash #{install_path}/FTBInstall.sh")
+    system("rm #{install_path}/eula.txt")
+    system("echo eula=true > #{install_path}/eula.txt")
+  end
+end

data/lib/game_servers/minecraft_spigot.rb

@@ -0,0 +1,23 @@
+require "open-uri"
+require "fileutils"
+
+# A class for Feed The Beast Minecraft Server
+class MinecraftSpigot
+  attr_reader :name, :app_id
+  def initialize
+    @name = "minecraft"
+    @app_id = nil
+  end
+
+  def launch(install_path, version = "1.13.2")
+    "cd #{install_path} && java -Xms1G -Xmx2G -jar spigot-#{version}.jar --noconsole"
+  end
+
+  def install_server(install_path, version = "1.13.2")
+    FileUtils.mkdir_p(install_path)
+    File.open("#{install_path}/BuildTools.jar", "wb") do |file|
+      file.write(open("https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar").read())
+    end
+    system("cd #{install_path} && java -jar #{install_path}/BuildTools.jar --rev #{version}")
+  end
+end

data/lib/game_servers/rust.rb

@@ -0,0 +1,17 @@
+# Create a Rust server
+class Rust
+  attr_reader :name, :app_id
+  def initialize
+    @name = "rust"
+    @app_id = "258550"
+  end
+
+  def launch(install_path, password = "_", ip = "0.0.0.0", port = "28015")
+    "export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:#{install_path}/RustDedicated_Data/Plugins/x86_64 &&
+    cd #{install_path} &&
+    ./RustDedicated +server.ip #{ip} +server.port #{port} +server.identity rust +rcon.web 1 \
+    +rcon.ip #{ip} \
+    +rcon.port 28016 \
+    +rcon.password #{password}"
+  end
+end

data/lib/game_servers/seven_days.rb

@@ -0,0 +1,27 @@
+# Create a 7 Days to Die server
+class SevenDays
+  attr_reader :name, :app_id
+  def initialize
+    @name = "sdtd"
+    @app_id = "294420"
+  end
+
+  def launch(install_path)
+    "cd #{install_path} &&
+    export LD_LIBRARY_PATH=. &&
+    #{install_path}/7DaysToDieServer.x86_64 \
+    -logfile #{install_path}/server.log \
+    -quit \
+    -batchmode \
+    -nographics \
+    -dedicated \
+    -configfile=#{install_path}/serverconfig.xml & \
+    /usr/bin/tail -f #{install_path}/server.log"
+  end
+
+  def post_install(install_path)
+    system("touch #{install_path}/server.log") # TODO: This won't scale
+    system("rm #{install_path}/serverconfig.xml")
+    system("cp #{Dir.pwd}/conf/sdtd.xml #{install_path}/serverconfig.xml")
+  end
+end

data/lib/game_servers/starbound.rb

@@ -0,0 +1,13 @@
+# A module to produce resources for a Starbound server
+class Starbound
+  attr_reader :name, :app_id
+  def initialize
+    @name = "starbound"
+    @app_id = "533830"
+  end
+
+  def launch(install_path)
+    "cd #{install_path}/linux &&
+    #{install_path}/linux/starbound_server"
+  end
+end

data/lib/game_servers/team_fortress.rb

@@ -0,0 +1,24 @@
+# A module to produce resources for a Team Fortress 2 server
+class TeamFortress
+  attr_reader :name, :app_id
+  def initialize
+    @name = "tf2"
+    @app_id = "232250"
+  end
+
+  def launch(install_path, map = "ctf_2fort", players = 24)
+    "cd #{install_path} &&
+    #{install_path}/srcds_run \
+    -console \
+    -game tf \
+    +sv_pure 1 \
+    +map #{map} \
+    +maxplayers #{players} \
+    -condebug & \
+    /usr/bin/tail -f #{install_path}/tf/console.log"
+  end
+
+  def post_install(install_path)
+    system("touch #{install_path}/tf/console.log")
+  end
+end

data/lib/game_servers/terraria.rb

@@ -0,0 +1,14 @@
+# A class for Feed The Beast Minecraft Server
+class Terraria
+  attr_reader :name, :app_id
+  def initialize
+    @name = "terraria"
+    @app_id = nil
+  end
+
+  def launch(install_path)
+  end
+
+  def install_server(install_path)
+  end
+end

data/lib/game_template.rb

@@ -0,0 +1,109 @@
+require "colorize"
+
+# Create a Rust server
+class GameTemplate
+  def initialize(game, path = nil)
+    @game = game
+    @install_path = get_install_path(path)
+    @file_path = "/tmp/#{@game.name}.service"
+  end
+
+  def start
+    system("sudo -p 'sudo password: ' systemctl start #{@game.name}")
+  end
+
+  def restart
+    system("sudo -p 'sudo password: ' systemctl restart #{@game.name}")
+  end
+
+  def status
+    system("sudo -p 'sudo password: ' systemctl status #{@game.name}")
+  end
+
+  def stop
+    system("sudo -p 'sudo password: ' systemctl stop #{@game.name}")
+  end
+
+  def enable
+    system("sudo -p 'sudo password: ' systemctl enable #{@game.name}")
+  end
+
+  def disable
+    system("sudo -p 'sudo password: ' systemctl disable #{@game.name}")
+  end
+
+  def run
+    exec(@game.launch(@install_path))
+  end
+
+  def install(steamuser, steampassword)
+    puts "Beginning installation process. This may take a while..."
+    ensure_delete_unit_file()
+    if @game.app_id.nil?
+      @game.install_server(@install_path)
+    else
+      install_steam_server(steamuser, steampassword)
+    end
+    create_unit_file()
+    system("sudo -p 'sudo password: ' cp -f #{@file_path} /etc/systemd/system/#{@game.name}.service")
+    puts "Server installation & deployment complete!".green
+  end
+
+  # Generic cli-facing update function
+  # for updating installed dedicated game servers
+  def update
+    if @game.app_id.nil?
+      puts "Non-Steam games not supported."
+    else
+      install_steam_server()
+    end
+  end
+
+  private
+
+  # Installs or Updates a dedicated game server via Steamcmd
+  def install_steam_server(steamuser = nil, steampassword = nil)
+    login = if steamuser.nil?
+              "+login anonymous"
+            else
+              "+login #{steamuser} #{steampassword}"
+            end
+    system("/usr/games/steamcmd +login anonymous +quit")
+    system("/usr/games/steamcmd #{login} +force_install_dir #{@install_path} +app_update #{@game.app_id} validate +quit")
+    @game.post_install(@install_path) if defined? @game.post_install
+  end
+
+  def get_install_path(path)
+    install_path = if path.nil?
+                    #  puts "Install path not defined: installing to /tmp/#{@game.name}".yellow
+                     "/tmp/#{@game.name}"
+                   else
+                     path
+                   end
+    install_path
+  end
+
+  def ensure_delete_unit_file
+    File.delete(@file_path) if File.file?(@file_path)
+  end
+
+  def create_unit_file
+    out_file = File.new(@file_path, "w")
+    out_file.puts(unit_file_contents()) # TODO: Pass in map with config
+    out_file.close()
+  end
+
+  def unit_file_contents
+    "[Unit]
+    After=network.target
+    Description=#{@desc}
+    [Install]
+    WantedBy=default.target
+    [Service]
+    LimitNPROC=infinity
+    WorkingDirectory=#{Dir.pwd}
+    Type=simple
+    User=#{`whoami`}
+    ExecStart=#{Dir.pwd}/bin/gsd run #{@game.name} --path #{@install_path}"
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: gsd-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Egee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies: []
+description: A simple cli for launching dedicated game servers
+email: brian@egee.io
+executables:
+- gsd-cli
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/gsd-cli
+- lib/cli.rb
+- lib/game_servers/ace_of_spades.rb
+- lib/game_servers/gmod.rb
+- lib/game_servers/minecraft_ftb.rb
+- lib/game_servers/minecraft_spigot.rb
+- lib/game_servers/rust.rb
+- lib/game_servers/seven_days.rb
+- lib/game_servers/starbound.rb
+- lib/game_servers/team_fortress.rb
+- lib/game_servers/terraria.rb
+- lib/game_template.rb
+homepage: https://github.com/Egeeio/gsd-cli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: A cli for launching servers
+test_files: []