License

I am the Elder God. A 3 vs 1 board game made using Quicksilver

Copyright (C) 2019 WushuWorks

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

I am the Elder God Game

This will be a 3 vs 1 board game featuring a 'Support-Assault-Trapper' S.A.T. team versus an eldritch monster - Yt'kathl the Dream.

Unique player-class abilities
Evolving Eldritch enemy and Hunters
Boardgame turn based gameplay.

Visit the project website for more details

Project Notes

What are you trying to accomplish?

A game that is playable 'in 9 seconds on the net'.

Why Rust? Why not Unity, Unreal, etc.?

Rust enforces memory safety and enables high performance code; two important properties for game development. My hope is that by developing this project in Rust as opposed to a mainstreeam language, I will encourage future investment in Rust as a solution for game development.

Sources and Inspirations Cited

This game makes heavy use of the state machine used in Mehen's Portable Casino and shares structure and code with it. Quicksilver Rougelike was used as a template to learn Quicksilver in practice, and has some code similarities.

This game was heavily inspired by Evolve and Arkham Horror

Supported Browsers

In order of best to worst

Firefox, Opera, Chrome

The below browsers are officially unsupported

1. All Microsoft browsers

Quick Play Instructions (For Players)

It is not required but highly recommended to play in Firefox, download it from the official website here

Play the current web release here

Play Instructions (For Developers)

Desktop

1. Clone to a repo of your choice
2. Run cargo run --release

Web

1. Clone the repo to an IDE of your choice
2. If cargo-web is not installed, run cargo install cargo-web
3. Run web start --release
4. Copy http://[::1]:8000 into a Firefox of your choice

Build for Deployment to GitHub Pages (For Developers)

1. Push all commits to master branch
2. Checkout (or create) to gh-pages branch, very important
3. Merge from master
4. If cargo-web is not installed, run cargo install cargo-web
5. Run cargo web deploy --release
6. Copy everything in target/deployto the project root directory
7. Add all the files to git git add . and commit them git commit -m "Don't use Microsoft browsers"
8. Push everything to your gh-pages branch, git push origin gh-pages

Play game in a Firefox browser of your choice at https://{github-username}.github.io/{repo name}/

Architecture Notes (For Developers)

1. The game is run on the Quicksilver engine, which supports easy deployment to the web.
2. The entire game is run by a simple state-machine to separate gameplay from other elements.
3. Within the game, most gameplay variables are explicitly set to certain values to eliminate ambiguity when translating to WASM.
4. Due to engine limitations and efficiency considerations regarding dynamic text rendering, all text elements are pre-rendered at allocation.

Unsupported engine functions such as looping music and simple animations are accomplished using timing based on fps counts from the game context, this is highly experimental and should not be relied on for high accuracy functions.