Skip to content

Latest commit

 

History

History
63 lines (50 loc) · 4.44 KB

README.md

File metadata and controls

63 lines (50 loc) · 4.44 KB
Raw

Project: Field Warning

Project: Field Warning is a community-made RTS game centered around squad and company-scale warfare. We are currently on Unity version 2019.4.0.

Downloading and Installing

We recommend using GitHub Desktop to download; it provides an easy way to synchronize with the latest changes. If it is inconvenient to download, or you do not want to sign up, you can use another Git client (like Sourcetree or just download a ZIP archive.

...with GitHub Desktop

  1. Download GitHub Desktop.
  2. Create a GitHub account, and sign into GitHub Desktop.
  3. Click File → Clone Repository; in the dialog box, under URL insert https://github.com/FieldWarning/projectFieldWarning. and clone it into any folder you like.

...with another Git client

This guide presumes that this client is set up and configured.

  1. Clone https://github.com/FieldWarning/projectFieldWarning into any folder you like.

...without using Git

Warning: You may fall behind from the latest version of the game. Make sure to check this page often, and redownload. You will also be unable to make commits to the game using this method.

  1. Download the master ZIP file for the game.
  2. Extract the ZIP into any folder you like.

Running and Playing

  1. Download Unity version 2019.4.0
  2. Run the Unity Installer
  3. Once the Installer finishes, open Unity, and click "Open" in the top right.
  4. Navigate to Clone Destination Folder, and select the FieldWarning folder.
  5. In Unity, open the Scene/full-featured-scene file (white/black cube icon).
  6. Once fully loaded, click the Play button and ensure everything works correctly. Enjoy!

Help, it's not working!

No need to worry. You can join our Discord Server, and ask for help in #general.
Our community is friendly and active—so don't be afraid to ask any questions or voice opinions.
If you believe something is not working because of a bug, error, or otherwise project-related reason then please file a bug report here.

Joining the community

Our project is 100% community based and everyone contributes on their own time. Without the staff, contributors, and members, this project would not have gotten this far. Thank you, everyone, for all your support.

Anyone is welcome to join and new-comers will be welcomed with open arms. If you are interested in becoming an active or contributing member, then make sure to join the Discord server by clicking this invite.
Assuming you've joined successfully, read the rules, and visit (and sign up for) everything listed in #links. Fill out and submit a Developer Application form. You must have the following to complete it:

  • Gmail Account
  • GitHub Account
  • Trello Account
  • Discord Username

We use the following platforms: Trello, Discord, and Google Docs

Documentation

Any available documentation is available in projectFieldWarning/documentation as well as our Wiki Please note How to Contribute, How to Utilize Trello, and our C# coding style.
Ensure you've read all documents (they're not that long, don't worry) and adhere to them when contributing.

Licensing

For the community project to work, all contributions need to be permissively licensed. By providing commits to this repository, you are licensing your contribution to the PFW contributors and the rest of the world under APv2 (see LICENSE file). If your commit contains files which you cannot or will not license to us under the APv2, please update the foreign-asset-licenses.md file. For code files, a notice in the header is required.