Resourceful-Rails-Team / resourceful-rails-game

MIT License
0 stars 2 forks source link

Resourceful Rails

Thomas Abel, Daniel Gerendasy, and Christian Schmid


Description

Resourceful Rails is a 3D video game board game, where players pay for and build railroad tracks across the Pacific Northwest, delivering cargo to different cities by train, and making a profit from that cargo. Money is the name of the game - when a player earns a certain amount of dollars from their cargo, they win!

There are two different turn types for each game that is played - build turns and delivery turns.

Goal of the Game - to connect railroad tracks to a specified amount of major cities, and to have a set amount of cash in hand. If a player meets both these goals, they win.

How To Play

See the Release Page to download a version that works with your system. No installation is required. Currently only Windows is supported.

Build Instructions

1) Use git to download the project: git clone https://github.com/Resourceful-Rails-Team/resourceful-rails-game

2) Go to Unity's website using the following link:

https://unity3d.com/get-unity/download

3) Download and install Unity Hub. This makes it easier to use different versions of Unity. Once it's done installing open Unity Hub.

4) In Unity Hub there will be 4 tabs on the left hand side Select the Installs tab. From there we will be installing the version of Unity that the game uses; version 2020.3.12f1. Follow this link and click the link right under the title that says "Unity Hub".

https://unity3d.com/unity/whats-new/2020.3.12

5) A popup window will appear in Unity Hub that will ask you to choose modules to install. In order to successfully compile the game you need to select the platform you're building to (most likely Windows, Mac, or Linux). Select Install and wait until it's done.

6) In order to open the project you first need to download the repository from GitHub. The entire repository needs to be in its own folder. Once that's done go back to Unity Hub to the Projects tab and select the "Add" button in the upper right. Select the folder you used for the repository.

7) Once the project has been added click on it to open it in the Unity Editor. Either press the key combination CTRL+SHIFT+B or select "File" in the upper left corner and then "Build Settings".

8) Keep the main selection on "PC, Mac & Linux Standalone" and select your platform from the dropdown list on the right. Select "Build and Run" at the bottom and then a popup will ask where you want to save the executable. Once you select the location the game will compile and automatically run. If it doesn't run (or you selected "Build" only) then you can always open the game using the executable itself.

Running Tests

Resourceful Rails' testing system is directly integrated into the editor. Upon opening Unity, the tests will automatically run, and the results will be displayed in the console at the bottom of the window. The console is the thin stip of gray at the very bottom - clicking it will open the window to display multiple lines.

Inspiration

Inspiration for Resourceful Rails comes from:

Technology

Resourceful Rails is built using the Unity Engine, with the C# programming language.

Development Goals

  1. COMPLETE Create a level generator / editor, which allows placement of nodes, cities, mountains, and other areas of interest through Unity's interface. For the creation of MVP map, and future maps created by open source developers. This will be made using Unity's editor tools, which offers a poweful and customizable system of generating a unique user interface to meet the requirements.

  2. COMPLETE WITH SOME BUGS Implement game logic, which will dictate the state of a unique game session, including player turns, build vs. delivery stages, pathfinding, and random card drawing. Please see the project's issues for

  3. COMPLETE Develop an interactive user interface, that directs players during the game, and handles player tasks, such as building tracks, choosing cards, and directing trains.

  4. COMPLETE Create art and assets, and an interface which binds the assets to the game state, for players to see. Art assets include trains, tracks, nodes, and a world map background. Art will be both 3D (for models and nodes) and 2D (for background).

Refer to the DESIGN and CONTROLS documents for more information about the game's rules, UI, controls, components, and objectives.

Acknowledgements

Thanks to the Unity development team for creating the Unity Engine, for the creation of open-source and industry video games.

Pacific Northwest Major Exports Information

Algorithms

3D Models

Project roadmap

Click here, to see the project's roadmap.

World Creator / Editor Art / Assets Game Logic Stretch Goals
COMPLETE - Map Creation COMPLETE - Basic 3D Assets COMPLETE WITH BUGS - Pathfinding Optional Rules
COMPLETE WITH HOTFIX - Map Serialization COMPLETE - Basic UI COMPLETE - Level Setup Multi. Short Paths
COMPLETE - Map Editing COMPLETE - Map Background COMPLETE - Build Turns 2D Billboard Art
COMPLETE - Complete 3D Assets COMPLETE - Trains Controller Support
COMPLETE - Complete UI COMPLETE - Order Cards
COMPLETE WITH BUGS - Delivery Turns
COMPLETE - Train Upgrades
COMPLETE - Determining Win


Demo Video

Please click here to see our project video.

Work Summary

Thomas Abel

Daniel Gerendasy

Christian Schmid

License

This work is made available under the "MIT License". Please see the LICENSE in this distribution for license terms.