This article lists some tools that you’ll probably want to get if you’re doing Ares coding.
Table of Contents
Do yourself a favor and get a decent code editor. Here are some good ones:
I personally don’t think a Ruby IDE like RubyMine is worth the cost for the benefits you get, but YMMV.
GitHub Desktop is a nice tool that makes it easy to work with GitHub. It’s available for Mac or Windows.
For help using GitHub, including GitHub desktop, see the Git tutorial.
It’s helpful to have a place to test your code that isn’t your main game. That way you can make sure everything works right before unleashing it on your players.
There are several options available to you.
The simplest and quickest way to set up a test game is to just get a second droplet and install a new copy of the game using the standard installation instructions.
You don’t need a separate host name for the test game; you can just use the droplet’s IP address as the host name.
If you have MacOS installed on your home PC, you can actually install your own copy of Ares and run the code locally.
Install Homebrew, Mac’s package manager.
Copy/paste the following commands into a Mac terminal.
curl https://raw.githubusercontent.com/aresmush/aresmush/master/bin/local_setup_mac > setup_ares chmod +x setup_ares ./setup_ares
The install script will set up the command-line version of Git, but you probably also want to install GitHub Desktop. Either one will work for Ares.
If you want the Redis database server to be running all the time, set it up as a Homebrew service using
brew services start redis. Otherwise you’ll have to start it every time you want to use it by typing
Clone the aresmush and ares-webportal code repositories to your local drive. They must reside in adjacent directories (e.g. /home/Users/you/Code/aresmush and /home/Users/you/Code/ares-webportal). See the Editing Code tutorial for help using GitHub desktop to clone the game.
From the aresmush directory, run the following scripts to set up the game:
cp -r install/game.distr game mkdir game/logs chmod +x bin/* bin/configure bin/wipedb
Start the game using
bin/devstart in the aresmush directory.
Start the web portal using
bin/devportal from the ares-webportal directory. The development web portal runs on http://localhost:4200.
AresMUSH won’t run on Windows due to a limitation in the database driver, but you can install Ares using a Virtual Machine (VM). A VM is like a computer within a computer. Once your VM is installed and configured, you can connect to it just as you would a server in the cloud.
ifconfig. This will tell you the VM’s Private IP Address.
setup_serverscript as described in the install instructions.
installscript as described in the install instructions. Use the following options:
Your VM is now ready to use. You can leave it powered off whenever you’re not using it. Here are the steps to start the game:
To change the code on the VM, you can use any of the methods described in the Editing Code tutorial. You can edit code directly through the SSH client, upload new code via FTP (the VM will accept SFTP on 127.0.0.1) or use GitHub to push code to the cloud and then pull it down to the server.
You may have heard of some other games that have a test instance installed on the same droplet as their regular server. This is technically possible but not advised because:
If you choose to go this route, you’re on your own. There are too many pitfalls for me to be comfortable guiding people through the setup.
You edit code on the test game the same way you do on the real game: through direct editing, FTP, or GitHub. GitHub offers the most reliable workflow.
For more help using GitHub, including GitHub desktop, see the Git tutorial.
upgradescript or command on test games unless they’re running on their own droplet.