Rusty Sword Arena: A Crash Course in Rust (Companion repository to the OSCON tutorial)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
media
src
.gitignore
.travis.yml
Cargo.lock
Cargo.toml
GAME_DESIGN.md
HowToLearnRust.md
LICENSE
README.md
rebuild.sh

README.md

Build Status

Rusty Sword Arena: A Crash Course in Rust

This is the companion repository to the half-day tutorial for OSCON 2018.

OSCON 2018

Preparation - DO THIS BEFORE OSCON

I use macOS, and that is what I developed Rusty Sword Arena on. Everything ought to be able to work on major Linux distributions and Windows. Please do the following preparation before OSCON so we can focus our tutorial time on learning Rust instead of twiddling with dependencies. Please contact me ASAP if you have trouble with anything on this page.

Install Rust

Rust 1.27.0 or newer is required for Rusty Sword Arena!

  • Go to rust-lang.org and click on the big blue Install Rust button and follow the instructions to install Rust for your operating system.
    • Please DO NOT install rust via some other package manager, because it will be a version that is too old.

You should get somewhat similar output (versions may be newer) if you run commands like the ones below. If you get a version older than 1.27.0, then run rustup update to install a newer version.

$ rustc --version
rustc 1.27.0 (3eda71b00 2018-06-19)

$ cargo --version
cargo 1.27.0 (1e95190e5 2018-05-27)

If you have any trouble with installation or running the commands above, please contact me before OSCON!!!

Install Other Dependencies

ZeroMQ is used under-the-hood for networking. It's abstracted away, so you won't actually deal with it other than making sure the library portion of it is installed so Rust can find it.

On Linux, the alsa development libraries are needed for sound.

macOS

Make sure you have Homebrew installed and then run

brew install pkgconfig zmq

CentOS

# czmq-devel is in EPEL (Extra Packages for Linux), so if you haven't installed it, do
sudo yum install -y epel-release

# ...then you can actually install the dependencies
sudo yum install -y czmq-devel alsa-lib-devel

Debian Run the following AND follow the instructions for Debian in the ZeroMQ's download documentation (you might need to create an /etc/apt/sources.list.d/zeromq.list file if you don't have a sources.list file on Debian 9) :

sudo apt install libasound2-dev

Other Operating Systems

Follow the instructions in ZeroMQ's download documentation for your operating system.

See if everything is working

  • Clone this repository
  • From inside the repository, run:
cargo run --bin server
  • It should compile for a long time and then you should get a startup message and some stats.
    • If your firewall prompts you for whether to allow the server to use the network, choose YES
    • Leave the server running for the next step! When you're ready to shut it down press Ctrl-C
    • If something crashes or goes wrong, please contact me before OSCON!!!
  • In another terminal window, run
cargo run --bin client -- yourname localhost
  • The server should say something about a player connecting
  • This should compile and then launch a window with a circle with a stripe.
  • The stripe should point at your mouse pointer.
  • The circle can be moved around with the arrow keys or WASD.
  • Stop the client by closing the window. Stop the server by pressing Ctrl-C in it's terminal.
  • If something crashes or goes wrong, please contact me before OSCON!!!

If you got through all those steps without anything crashing, then you're all ready for OSCON. 🎉

Prepare to Learn

Please do all of the following (see the How To Learn Rust page for details on all of these)

  • Choose an IDE (or Editor) and configure it with Rust support and customize it to your liking
  • Choose one place to "find answers" and either introduce yourself (if it's a forum, IRC, etc.) or find the answer to one question you have.
  • Try doing something in Rust! If you don't have a better idea, then just do this:
    • cargo new message
    • cd message
    • cargo run
    • Edit src/main.rs and change the message.
    • cargo run again to see your new message.
  • Check out the descriptions of the tools and books.

Tutorial!

Now you are ready for the tutorial! You are going to make your own game client far Rusty Sword Arena!

Your resources will be:

Oh, and if you need to cheat catch up, here is the "duel" repo with a tag for each stage of the client we're going to build during the tutorial.