Integrating latest 47acbe8
This commit is contained in:
alexpete
Vendored
+26
@@ -0,0 +1,26 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Create a bug report to help us improve.
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
Please provide a concise description of the bug.
|
||||
|
||||
**Steps to reproduce**
|
||||
Please provide steps to reproduce the bug. The more detail you provide, the more likely we'll be able to reproduce it.
|
||||
|
||||
**Expected behavior**
|
||||
Please provide a concise description of what you expected to happen.
|
||||
|
||||
**Screenshots/Logs**
|
||||
Please include any relevant screenshots and log files from your game project directory (e.g., C:\Amazon\lumberyard\1.15.0.0\dev\Cache\YOURPROJECT\pc\user\log). Note that you are posting to a public forum so please remove any sensitive information from your log files such as project name & path, IP address, credentials etc.
|
||||
|
||||
**Lumberyard version**
|
||||
State the version of Lumberyard in which you discovered this bug (e.g., v1.14.0.1 or v1.15.0.0 etc.).
|
||||
|
||||
**[OPTIONAL] What is your role in game development?**
|
||||
Are you a game designer, engineer, artist, producer, something else?
|
||||
|
||||
**[OPTIONAL] Tell us about your project or studio.**
|
||||
Briefly tell us about your project or studio.
|
||||
Tools/build/JenkinsScripts/distribution/git_release/inject/.github/ISSUE_TEMPLATE/feature_request.md
Vendored
+17
@@ -0,0 +1,17 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest a feature you'd like to see developed.
|
||||
|
||||
---
|
||||
|
||||
**Describe your feature request**
|
||||
Please provide a concise description of the feature you'd like to see in Lumberyard.
|
||||
|
||||
**Describe workarounds or alternatives you've considered**
|
||||
Please provide a concise description of workarounds or alternative solutions you've considered.
|
||||
|
||||
**[OPTIONAL] What is your role in game development?**
|
||||
Are you a game designer, engineer, artist, producer, something else?
|
||||
|
||||
**[OPTIONAL] Tell us about your project or studio.**
|
||||
Briefly tell us about your project or studio.
|
||||
Vendored
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Question
|
||||
about: Ask a question to the community.
|
||||
|
||||
---
|
||||
|
||||
**What is your question?**
|
||||
Please ask your question here.
|
||||
|
||||
**Which part of the engine are you asking about?**
|
||||
Please indicate the component of the engine that your question relates to (e.g., Script Canvas, PhysX, Animation etc.).
|
||||
|
||||
**Which version of Lumberyard are you using?**
|
||||
State the Lumberyard version that you're using (e.g., v1.14.0.1 or v1.15.0.0 etc.).
|
||||
|
||||
**[OPTIONAL] What is your role in game development?**
|
||||
Are you a game designer, engineer, artist, producer, something else?
|
||||
|
||||
**[OPTIONAL] Tell us about your project or studio.**
|
||||
Briefly tell us about your project or studio.
|
||||
@@ -0,0 +1,45 @@
|
||||
# Contribution Guidelines
|
||||
Thank you for visiting our contribution guidelines! An active and healthy development community is what makes a good game engine an exceptional game engine. As we focus on developing new features and resolving bugs with every version of Lumberyard, we want to hear from you. We are interested in seeing how you're using the engine and what improvements you're making while you work on your own game projects. This is why, in addition to our [GameDev Forums](https://gamedev.amazon.com/forums/index.html), [Tutorials](https://www.youtube.com/amazongamedev) and [Documentation](https://aws.amazon.com/documentation/lumberyard/), we provide you with the opportunity to share your features and improvements with your fellow developers. After you modify the core engine code, simply submit a pull request.
|
||||
|
||||
To make it easy for you to contribute to our game engine, the Lumberyard development team adheres to the following coding conventions. We believe that these guidelines keep the engine code consistent and easy to understand so that you can spend less time interpreting code and more time coding. We look forward to your contributions!
|
||||
|
||||
## Compiler Compatibility:
|
||||
- Use the C++11 standard whenever possible.
|
||||
- Stick to the C++11 features that are commonly supported by Microsoft Visual Studio 2013/2015 (refer to https://msdn.microsoft.com/en-us/library/hh567368.aspx).
|
||||
|
||||
## Formatting:
|
||||
- Lumberyard recommends using the Uncrustify code beautifier to keep C++ code consistent with the engine code. Refer to http://uncrustify.sourceforge.net/.
|
||||
- Apply indentation in a consistent manner:
|
||||
- Files should start without any indentation.
|
||||
- Use a single additional level of indentation for each nested block of code.
|
||||
- Indent all lines of a block by the same amount.
|
||||
- Make lines a reasonable length.
|
||||
- Indent preprocessor statements in a similar way to regular code.
|
||||
- When positioning curly braces, open braces on a new line and keep them flush with the outer block's indentation.
|
||||
- Always use curly braces for flow control statements.
|
||||
- Each line of code should only include a single statement.
|
||||
- Naming conventions for classes, functions, types and files should adhere to CamelCase and specify what the function does.
|
||||
- All header files must include the directive, "#pragma once".
|
||||
- Use forward declarations to minimize header file dependencies. Compile times are a concern so please put in the effort to minimize include chains.
|
||||
- The following syntax should be used when including header files: #include <Package/SubdirectoryChain/Header.h>
|
||||
This rule helps disambiguate files from different packages that have the same name. <Object.h> might appear relatively often, but <AZRender/Object.h> is far less likely to.
|
||||
|
||||
## Classes:
|
||||
- You should define a default constructor if your class defines member variables and has no other constructors. Unless you have a very specifically targeted optimization, you should initialize all variables to a known state even if the variable state is invalid.
|
||||
- Do not assume any specific properties based on the choice of struct vs class; always use <type_traits> to check the actual properties
|
||||
- Public declarations come before private declarations. Methods should be declared before data members.
|
||||
- All methods that do not modify internal state should be const. All function parameters passed by pointer or reference should be marked const unless they are output parameters.
|
||||
- Use the override keyword wherever possible and omit the keyword virtual when using override.
|
||||
- Use the final keyword where its use can be justified.
|
||||
|
||||
## Scoping:
|
||||
- All of your code should be in at least a namespace named after the package and conform to the naming convention specified earlier in this document.
|
||||
- Place a function's variable declarations in the narrowest possible scope and always initialize variables in their declaration.
|
||||
- Static member or global variables that are concrete class objects are completely forbidden. If you must have a global object it should be a pointer, and it must be constructed and destroyed via appropriate functions.
|
||||
|
||||
## Commenting Code:
|
||||
Clear and concise communication is essential in keeping the code readable for everyone. Since comments are the main method for communication, please follow these guidelines for commenting the code:
|
||||
- Use /// for comments.
|
||||
- Use /**..*/ for block comments.
|
||||
- Use @param, etc. for commands.
|
||||
- Full sentences with good grammar are preferable to abbreviated notes.
|
||||
@@ -0,0 +1,57 @@
|
||||
|
||||
|
||||
# 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](https://guides.github.com/introduction/flow/).
|
||||
|
||||
### 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](https://help.github.com/articles/cloning-a-repository/).
|
||||
|
||||
|
||||
### 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](https://status.aws.amazon.com/).
|
||||
|
||||
### 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](https://help.github.com/articles/cloning-a-repository/).
|
||||
|
||||
## 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://www.youtube.com/amazongamedev
|
||||
|
||||
## 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.
|
||||
Reference in New Issue
Block a user