feiyunwill / lumberyard

Amazon Lumberyard is a free AAA game engine deeply integrated with AWS and Twitch – with full source.

Amazon Lumberyard

Amazon Lumberyard is a free, AAA game engine that gives you the tools you need to create high quality games. Deeply integrated with AWS and Twitch, Amazon Lumberyard includes full source code, allowing you to customize your project at any level.

For more information, visit: https://aws.amazon.com/lumberyard/

Acquiring Lumberyard source

Each release of Lumberyard exists as a separate branch in GitHub. You can get Lumberyard from GitHub using the following steps:

Fork the repository

Forking creates a copy of the Lumberyard repository in your GitHub account. Your fork becomes the remote repository into which you can push changes.

Create a branch

The GitHub workflow assumes your master branch is always deployable. Create a branch for your local project or fixes.

For more information about branching, see the GitHub documentation.

Clone the repository

Cloning the repository copies your fork onto your computer. To clone the repository, click the "Clone or download" button on the GitHub website, and copy the resultant URL to the clipboard. In a command line window, type git clone [URL], where [URL] is the URL that you copied in the previous step.

For more information about cloning a reposity, see the GitHub documentation.

Downloading additive files

Once the repository exists locally on your machine, manually execute git_bootstrap.exe found at the root of the repository. This application will perform a download operation for Lumberyard binaries that are required prior to using or building the engine. This program uses AWS services to download the binaries. Monitor the health of AWS services on the AWS Service Health Dashboard.

Running the Setup Assistant

git_bootstrap.exe will launch the Setup Assistant when it completes. Setup Assistant lets you configure your environment and launch the Lumberyard Editor.

Contributing code to Lumberyard

You can submit changes or fixes to Lumberyard using pull requests. When you submit a pull request, the Lumberyard support team is notified and evaluates the code you submitted. You may be contacted to provide further detail or clarification while the support team evaluates your submitted code.

Best practices for submitting pull requests

Before submitting a pull request to a Lumberyard branch, please merge the latest changes from that branch into your project. We only accept pull requests on the latest version of a branch.

For more information about working with pull requests, see the GitHub documentation.

Purpose of Lumberyard on GitHub

Lumberyard on GitHub provides a way for you to view and acquire the engine source code, and contribute by submitting pull requests. Lumberyard does not endorse any particular source control system for your personal use.

Lumberyard Documentation

Full Lumberyard documentation can be found here: https://aws.amazon.com/documentation/lumberyard/ We also have tutorials available at https://gamedev.amazon.com/forums/tutorials

License

Your use of Lumberyard is governed by the AWS Customer Agreement at https://aws.amazon.com/agreement/ and Lumberyard Service Terms at https://aws.amazon.com/serviceterms/#57._Amazon_Lumberyard_Engine.

For complete copyright and license terms please see the LICENSE.txt file at the root of this distribution (the "License"). As a reminder, here are some key pieces to keep in mind when submitting changes/fixes and creating your own forks:

• If you submit a change/fix, we can use it without restriction, and other Lumberyard users can use it under the License.
• Only share forks in this GitHub repo (i.e., forks must be parented to https://github.com/aws/lumberyard).
• Your forks are governed by the License, and you must include the License.txt file with your fork. Please also add a note at the top explaining your modifications.
• If you use someone else’s fork from this repo, your use is subject to the License.
• Your fork may not enable the use of third-party compute, storage or database services.
• It's fine to connect to third-party platform services like Steamworks, Apple GameCenter, console platform services, etc.
  To learn more, please see our FAQs https://aws.amazon.com/lumberyard/faq/#licensing.