martin-t / rec-wars

A top-down vehicle shooter in Rust - a FOSS clone of RecWar

RecWars

Recreational Warfare .rs
A multiplayer top-down tank shooter - a FOSS port of an old Windows game called RecWar to Rust/WASM.

Play in the Browser | Play splitscreen in the Browser | Join our Discord

RecWars is a free and open source clone of RecWar, a singleplayer and multiplayer tank shooter. You control a tank, hovercraft or hummer and fight other vehicles in one of three game modes using an arsenal of eight distinct weapons. You can play against bots, in splitscreen and over the network.

RecWars aims to have gameplay similar, but not identical, to RecWar. RecWar was balanced for playing against bots and might result in annoying strats being the most effective when people start playing to win, RecWars will make changes where needed to provide a more enjoyable multiplayer experience. However, almost everything in RecWars is configurable and you can switch to the original RecWar balance to compare.

Currently this is very much a work-in-progress: the driving physics don't feel right, there are no collisions between vehicles, bots move randomly ...

RecWars is developed in lockstep with RustCycles. Even though they are very different, built on different engines, they share the general architecture. Ideas are tested in one game, then ported to the other.

The ultimate goal is to create a fully moddable multiplayer game playable in the browser and natively on Linux, Windows and macOS. RecWars is built in the spirit of everlasting games.

Features

• Singleplayer
• Multiplayer
  • Splitscreen
  • Network (native client only, no browser support yet)
  • Splitscreen and network at the same time
• Bot AI
• Browser client
• Native client (Linux, Windows, macOS)
• Game modes
  • Free For All
  • Team War
  • Capture The Cow
• Highly configurable

See Todo.md for details.

How to Play

The browser version is hosted here.

Splitscreen is hosted here.

Compiling and Running Locally

Build Dependencies

Install Macroquad's dependencies.

Native version

• cargo run

You can set cvars on the command line - e.g.:

• cargo run -- bots_max 4 cl_splitscreen true g_map Atrium g_armor 150

Browser version

• Build with cargo build --target wasm32-unknown-unknown && mv target/wasm32-unknown-unknown/debug/rec-wars.wasm rec-wars.wasm
  • You can use --release to get better perf and a much smaller WASM file.
• Host with python3 -m http.server (or any other web server, simply opening macroquad.html will not work though).
• Open http://localhost:8000/macroquad.html.

Contributing

You can always find me on the Rusty Games Discord server if you have any questions or suggestions or if you just wanna see a game slowly develop from a small prototype to being playable and enjoyable by real people.

Issues and Pull Requests are welcome, I will try to look at them as soon as possible.

I want to make RecWars highly configurable with many different gamemodes and balance settings votable by players and anybody will be able to host their own server. RecWars aims to blur the line between a game and a genre-specific game engine. Vehicles, weapons, AI, game modes, etc. will be completely configurable. If you have a gameplay idea and don't suffer from the NIH syndrome, I'd be very happy to work together and test it in RecWars.

Tips (Optional)

Enable extra checks before every commit: copy/symlink pre-commit-example to pre-commit and run git config core.hooksPath git-hooks. It gets checked on CI anyway, this just catches issues faster.

Enable fast builds - see .cargo/config-example.toml for details.

Architecture Overview

Most of the code is commented to be understandable by anyone with a basic understanding of how a game works (there's a main loop, gamelogic and rendering run is steps called frames). If it's not clear why a particular piece of code exists or why it needs to be written the way it is, I consider that a bug which should be fixed by either rewriting the code more clearly or adding comments explaining it.

Currently, most game state is managed by generational arenas from the thunderdome crate to make the code type-safe and readable. Previously, RecWars used the legion ECS. However it was cumbersome to use and WASM didn't get any benefits from parallelism. The only reason I was using ECS was so I could have references between entities and for this I was paying by having all entities dynamicly typed which lead to bugs. It's a Rust tradition to start writing a game and end up writing a game engine or ECS so I am considering creating an ECS crate that would satisfy my standards of clean API and static typing. For now arenas seem to be close enough.

The code is currently all in a single crate. It used to be split into a lib (gamelogic) and bin (rendering) but this builds faster.

Cvars

Cvars are console variables - configuration settings which control everything in the game like physics, weapon behavior, AI, HUD layout, etc.

They use the cvars crate - an alternative to inline_tweak & friends. There's a built-in console from the cvars-console-macroquad crate.

Changing cvars

• Press ";" or "`" to open the console
• Type the cvar's name and new value, then enter - e.g. g_bfg_beam_range 250

The desktop version also accepts them on the command line. Some cvars like g_map or d_seed currently only take effect this way because they need to be set before match start.

The entire list of cvars is in src/cvars.rs.

The Original Game

RecWar by Willem Janssen:

• homepage: http://recreationalwarfare.atspace.com/index_willem.html (the game's download is broken but still hosts extra maps)
• unofficial homepage: http://www.recwar.50webs.com/
• archive.org download: https://archive.org/details/recwar_201903
• archive.org download with extra maps: https://archive.org/details/RecWar

The original RecWar only contains a Windows .exe but runs ok-ish under wine on Linux (sometimes freezes on map load). It includes a map editor. The binaries in both archive.org links are identical to what I got on an old CD so should be safe.

RecWars vs RecWar differences

RecWar would probably be impossible to replicate exactly without decompiling the binary (which doesn't even contain debug symbols), though if a fan of the original finds this project, I am not gonna stop them from trying.

Additionally, when playing against people instead of bots, I suspect RecWar's original balance would lead to annoying and boring strats like making the cow inaccessible with mines or just simple camping. For example, experience from poorly designed games shows large areas will be dominated by instant-hit weapons (in RecWar the railgun) and there might simply be no way to get across the map alive. Therefore I made the railgun a very fast projectile in RecWars. I might make more balance changes based on how the online gameplay evolves.

For those reasons, RecWars will have a slightly different balance than RecWar. I will try to keep them as similar as possible but some things like physics will never be exact and I will make changes where I see fit to make the gameplay more interesting.

Intentional differences (can be toggled by switching the balance):

• Railgun - RecWar railgun hits instantly, RecWars uses a very fast projectile because hitscan weapons ruin large maps

Unintentional differences - I will make best effort here but some things won't be exact:

• Speeds, accelerations, turning, inertia of vehicles and weapons
• Push force of mines and railguns
• Tank in RecWar turned around turret swivel point, not center of chassis - this is for simplicity for now
• Weapons
  • Damage - Cluster bomb and BFG beam are hard to measure exactly
  • Spreads - Cluster bombs and MG are hard to measure exactly
• Self destruct damage and range - it appears to be the only explosion in RecWar with damage decreasing by distance and it's really hard to measure exactly.

Maps

• maps/ - Maps from the original RecWar
• maps/extra/ - Extra maps from the official homepage
• maps/extra2/ - Extra maps from archive.org

Currently the map is picked randomly by default, however, in the desktop version you can choose it manually on the command line.

Lessons Learned

Read this to learn from other people's mistakes and save yourself some time.

• RecWars originally drew to an HTML canvas directly without an engine. It turned out to provide no benefits over just using an engine and the raw canvas version has since been removed. The current version uses macroquad, which takes care of building WASM and talking to the browser. The raw canvas version has, however, taught me a bit about compiling Rust to WASM and the wasm-pack tooling:
  • It's possible and advisable to use WASM without NPM. The official Rust+WASM book heavily pushes people towards NPM and the whole thing feels like "just download this big template, don't try to understand it and only touch the parts we tell you to". Honestly how do you even statically host the thing on GH/GL pages without npm run?. If you're not planning to use other NPM packages, all you need is a few lines of JS glue to run your WASM. Use the Without a Bundler example as your "template" and host it with python3 -m http.server. You'll understand exactly what is going on and you'll avoid the whole JS ecosystem.
• The canvas 2D API is too slow for a game which needs to redraw the entire screen each frame, especially in firefox. UPDATE 2021-02-16: HTML canvas in firefox on linux is too slow. Probably nothing I can do about it until this bug is resolved. Quote: "AFAIK Chrome does use it, but they also maintain a long list of driver bug workarounds - too much to handle for the FF team.". In short, again, blame incompetent driver devs - C(++) rockstars like them can't be bothered with stuff like tests, basic static analysis or sanitizers - they killed glium, they're killing firefox on linux. UPDATE 2023-07-11: Performance in Firefox is now OK. People who don't use readily available tools for checking correctness still shouldn't call themselves engineers.
• ECS is overhyped. It will make all your game entities dynamicly typed but with much more boilerplate than a dynlang and will predictably lead to bugs. If you don't need to add/remove components at runtime, the only reason you're using it is probably so you can have references between entities - just use generational arenas. Appeal to authority: Fyrox is written by an experienced game engine dev and avoids ECS for much the same reason.
• Generational arenas will lead to slightly more borrowck errors. ECS either avoided them implicitly by borrowing only parts of the gamestate (runtime borrowchecking) or resolved them explicitly by postponing mutation (e.g. legion's CommandBuffer). With arenas, you have to deal with them explicitly more often:
  • You can't add to / remove from an arena while iterating through it
    • Use specialized methods like retain if available
    • Avoid borrowing the whole arena in a loop - instead, collect handles into a vector, iterate through that vector and borrow only for parts of the loop body
    • Collect entities to add or handles to remove into a vector, add / remove them after the loop is done
  • Subfunctions need mutable game state while you're iterating through one of the arenas
    • Be more granular - don't pass them the entire game state, just the arenas it needs
    • Again, collect handles, iterate through them, reborrow each iteration, end borrow before calling subfunctions

License

All code is available under AGPL-v3 or newer.

All assets (maps, textures, sounds, etc.) are taken from the original RecWar by Willem Janssen which is freely available online.

rec-wars's Issues

Add tests

• shoot all weaps, make sure they don't hit owner but do hit enemy
• make sure bullets don't pass through vehicles when moving fast
  • also when vehicle moving in opposite direction (bullet trace could stop in from one frame, continue behind moved vehicle next frame)
• self destruct - proper delay, dead after
• GM - stop guiding and camera tracking on player death / impact / launching next
• z-order of explosions - SD, mines, weapons vs vehicle
• see notes in systems::input() about input going to the wrong entities

Some tiles sometimes randomly flicker in WASM

Only seen it online so far: https://martin-t.gitlab.io/gitlab-pages/rec-wars/macroquad.html

Must have started recently, firefox 104.0.2 (64-bit)

Map was Delta. Stopped happening after reloading the page.

Performance

• stop using canvas 2D
  • canvas 2d is not the actual issue but firefox itself (https://bugzilla.mozilla.org/show_bug.cgi?id=1010527#c0)
• when gamelogic reproducible, allow measuring perf by running a game with prerecorded input

Firefox's privacy.resistFingerprinting makes the game extremely laggy

The time increments by 100 ms.

Not sure this is possible to fix, might wanna detect it and warn the user.

Doesn't work if installed by `cargo install rec-wars`

• The executable should be just rec-wars, not rec-wars-macroquad
• It crashes because of missing assets.