Organizing bash files

Lucien Lachance · 07-21-2013, 03:57 PM

I've been writing a simple text-based rpg game for a project for my Linux-Scripting class and I would like to know if there's a standard for setting up a project in Bash. So far I've made a directory called rpg_lite that contains two files: one file that serves as the main file that sources the second file which contains all of my functions. If you had multiple associative arrays where would be the best place to put them and how would you organize this? Here's a snippet:

Code:

#!/usr/bin/env bash

. my_functions

inventory "$weapons" # prints available weapons

unSpawn · 07-23-2013, 01:49 AM

Quote:

Originally Posted by Lucien Lachance

I would like to know if there's a standard for setting up a project in Bash.

BASH is a shell. It has no concept of "projects" so feel free to use what suits you (common sense).

Quote:

Originally Posted by Lucien Lachance

If you had multiple associative arrays where would be the best place to put them

Wherever they're accessible for inclusion int he game? Not sure what the real reason is for asking this? Maybe add examples to illustrate?

Lucien Lachance · 07-23-2013, 11:23 AM

What you said makes sense, I lost sight of that.

David the H. · 07-23-2013, 01:20 PM

Since these are (apparently) definitions of game data (weapons and such), I'd probably store them in an external "data" file in the same place as the functions.

Lucien Lachance · 07-23-2013, 02:42 PM

Code:

declare -A apparel=(
  ['Steel Platemail']=108
  ['Studded Cuirass']=102
  ['Heavy Platemail']=110
  ['Assassin Robes']=60
)

# Items => Damage
declare -A weapons=(
  ['Edged Shuriken']=25
  ['Steel Claymore']=90
  ['Imperial Sword']=73
  ['Tainted Knives']=15
)

# Holds => Cities
declare -A regions=(
  ['Eastern Palace']='Imperial City'
  ['Darkwood Basin']='Undead Asylum'
  ['Redwood Valley']='Thieves Guild'
)

inventory() {
  declare -p $1 | awk -F '"' '{ for(i=2; i<=NF; i+=4) print $i,"=>",$(i+2) }'
}

get_magic() {
  spells=()
  while IFS= read -r line; do
    spells+=("$line")
  done < $HOME/current_spells
  printf "%s\n" "${spells[@]}"
}

locations() {
  for city in "${!regions[@]}"; do
    printf "%s\t%s\n" "$city" "${regions[$city]}"
  done | sort
}

check_key() {
  local holds city=$1
  shift
  for holds; do
    [[ $holds == $city ]] && return 0
  done
  return 1
}

traveling() {
  locations
  read -p 'Travel to which capitol? ' on_foot
  if check_key "$on_foot" "${regions[@]}"; then
    printf "Now entering: %s\n" "$on_foot"
  else
    echo 'You got lost and rested at an Inn..'
  fi
}

list_menu() {
  # Should be exclusive to the player's equipment
  selection=( 'Apparel' 'Weapons' 'Spells' 'Exit' )
  for (( i=0; i<${#selection[@]}; i++ )); do
    printf "%2d. %s\n" "$((i+1))" "${selection[$i]}"
  done
}

I started this awhile ago, and kind of just had fun with by adding things to it day by day. I tried not to repeat myself. I just couldn't figure out how to simulate attacking an enemy.

konsolebox · 07-24-2013, 08:00 AM

It's quite admirable that you're brave enough to do this in Bash though I would recommend making it work in other scripting languages like Ruby instead.

Anyhow if you plan to organize your code into multiple source files then you might find this tool helpful: Shell Script Loader. It would allow you to call your files elegantly like how it's done in most languages.

And you might try looking at other projects as well for design concepts that you might find useful incorporating in your project.