Skip to content

Commit 00c7afb

Browse files
Clean rebuild (#33)
* update readme * note on pre-built envs * Update README.md * Fix README reference in Sphinx index to correctly include project overview * Update question.md * Buildable on ubuntu, tests and standalone disabled * update win instructions * update project url * Add Doc for transition from airsim and solve a conflict * AirSim vnext to Project AirSim * Add GitHub issue templates, PR template, and Windows CI workflow --------- Co-authored-by: jonyMarino <jonymarino@gmail.com> Co-authored-by: Jonathan <unrealempowerment@gmail.com>
1 parent 5f847af commit 00c7afb

File tree

20 files changed

+576
-62
lines changed

20 files changed

+576
-62
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
<!-- ⚠️⚠️ Do Not Delete This! bug_report_template ⚠️⚠️ -->
6+
<!-- Please read our Rules of Conduct: https://opensource.microsoft.com/codeofconduct/ -->
7+
<!-- Please search for existing issues to avoid creating duplicates. -->
8+
<!-- Incomplete reports will lead to closing the issue. -->
9+
<!-- Also, please test using the latest main branch make sure your issue has not already been fixed -->
10+
11+
## Bug report
12+
<!-- If any section does not apply, replace its contents with "N/A". -->
13+
- Project AirSim Version/#commit:
14+
- autopilot version:
15+
- OS Version:
16+
17+
### What's the issue you encountered?
18+
<!-- Describe the issue in detail and what you were doing beforehand. -->
19+
<!-- Attach screenshot if applicable. -->
20+
21+
### Settings
22+
<!-- If not the default, include the settings.json file you are using -->
23+
<!-- If it's too large, you can create a [gist](https://gist.github.com/) and past the link here. -->
24+
25+
### How can the issue be reproduced?
26+
<!-- Include a detailed step by step process for recreating your issue. -->
27+
<!-- If your issue includes code, create a [gist](https://gist.github.com/) and past the link here. -->
28+
29+
1.
30+
2.
31+
32+
### Include full error message in text form
33+
34+
35+
36+
**What's better than filing an issue? Filing a pull request :).**

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
<!-- ⚠️⚠️ Do Not Delete This! feature_request_template ⚠️⚠️ -->
8+
<!-- Please read our Rules of Conduct: https://opensource.microsoft.com/codeofconduct/ -->
9+
<!-- Please search existing issues to avoid creating duplicates. -->
10+
11+
## What feature are you suggesting?
12+
### Overview:
13+
<!-- Describe the feature you'd like. -->
14+
15+
### Smaller Details:
16+
<!-- These may include specific methods of implementation etc. -->
17+
18+
### Nature of Request:
19+
<!-- Remove all that do not apply to your request. -->
20+
- Addition
21+
- Change
22+
- Removal
23+
- <!-- Removal of certain features or implementation due to a specific issue/bug or because of low quality code, etc. -->
24+
25+
## Why would this feature be useful?

.github/ISSUE_TEMPLATE/question.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Support Questions
3+
about: Your question may be moved to https://github.com/iamaisim/ProjectAirSim/discussions.
4+
---
5+
<!-- ⚠️⚠️ Do Not Delete This! question_template ⚠️⚠️ -->
6+
<!-- Please read our Rules of Conduct: https://opensource.microsoft.com/codeofconduct/ -->
7+
<!-- Please search existing issues to avoid creating duplicates. -->
8+
<!-- Add clear and concise title -->
9+
10+
## Question
11+
### What's your question?
12+
<!-- Describe your question in detail. -->
13+
14+
### Include context on what you are trying to achieve
15+
<!-- If any section does not apply, replace its contents with "N/A". -->
16+
17+
#### Context details
18+
<!-- Add OS, AirSim version, Python version, Unreal version if applicable -->
19+
<!-- If not the default, include the settings.json file you are using -->
20+
<!-- If it's too large, you can create a [gist](https://gist.github.com/) and past the link here. -->
21+
22+
### Include details of what you already did to find answers

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Thank you for submitting a pull request! -->
2+
<!-- ⚠️⚠️ Do Not Delete This! pull_request_template ⚠️⚠️ -->
3+
<!-- Please read our contribution guidelines: https://microsoft.github.io/AirSim/CONTRIBUTING/ -->
4+
5+
Fixes: # <!-- add this line for each issue your PR solves. -->
6+
<!-- Fixes: # -->
7+
<!-- Fixes: # -->
8+
9+
## About
10+
<!-- Describe what your PR is about. -->
11+
12+
## How Has This Been Tested?
13+
<!-- Please, describe how you have tested your changes to help us incorporate them. -->
14+
15+
## Screenshots and videos (if appropriate):

.github/workflows/test_windows.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Windows Build
2+
3+
# Controls when the action will run.
4+
on: [push]
5+
6+
jobs:
7+
build:
8+
permissions:
9+
actions: write
10+
pages: write
11+
contents: write
12+
runs-on: windows-2022
13+
14+
# Steps represent a sequence of tasks that will be executed as part of the job
15+
steps:
16+
- uses: actions/checkout@v3
17+
18+
- name: Enable Developer Command Prompt
19+
uses: ilammy/msvc-dev-cmd@v1
20+
21+
- name: Build SimLibs
22+
shell: cmd
23+
run: build simlibs_debug

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ Our project's roadmap and future direction are defined through GitHub issues and
6868

6969
See **[Installing system prerequisites](docs/system_specs.md#installing-system-prerequisites)** for information about Windows/Linux system setup needed before running Project AirSim.
7070

71-
### 1. Develop with Project AirSim source
71+
### 1. Pre-built environment binaries
7272

73-
> I'm going to build the sim libs, Plugin, Blocks, and my own UE project environment from the ground up so I can customize it to my application.
73+
> I just want to download and run a Project AirSim environment and drive it with some Python code.
7474
75-
*Note:* You can either build Project AirSim from source or download pre-built binaries to use with the Python client. Currently, only the classic Blocks environment is available. If you require another environment (e.g., urban, geo-specific, etc.), you can sponsor its maintenance by contacting [info@iamaisim.com](mailto:info@iamaisim.com).
75+
*Note:* You can either build Project AirSim from source or download pre-built binaries to use with the Python client. Currently, only the classic Blocks environment is available. If you require another environment (e.g., urban, geo-specific, etc.), you can sponsor its maintenance by contacting [envs@iamaisim.com](mailto:envs@iamaisim.com).
7676

7777
#### **[Use pre-built binary environments](docs/development/use_prebuilt.md)**
7878

@@ -110,11 +110,6 @@ These arguments can also be used while debugging in VS Code by modifying the `la
110110

111111
- **[Overall API Info](docs/api.md)**
112112

113-
### ROS Integration
114-
115-
- **[ROS Bridge Setup and Use](docs/ros/ros.md)**
116-
- **[ROS Bridge Examples](docs/ros/ros_examples.md)**
117-
118113
### Controllers
119114

120115
- **[Flight Controllers](docs/controllers/controllers.md)**
@@ -144,11 +139,6 @@ These arguments can also be used while debugging in VS Code by modifying the `la
144139
- **[Fast Physics](docs/physics/fast_physics.md)**
145140
- **[Matlab Physics](docs/physics/matlab_physics.md)**
146141

147-
### Autonomy Blocks
148-
149-
- **[Autonomy Building-Blocks](docs/autonomy/autonomy.md)**
150-
- **[Autonomy Gym](docs/autonomy/gym/gym_envs.md)**
151-
152142
## FAQ
153143

154144
If you run into problems, check the **[FAQ](docs/faq.md)** for help.
@@ -163,7 +153,7 @@ Please see the [License page](docs/license.md) for Project AirSim license inform
163153

164154
---
165155

166-
Copyright (C) Microsoft Corporation.
156+
Copyright (C) Microsoft Corporation.
167157
Copyright (C) IAMAI Consulting Corporation.
168158

169159
MIT License

build.sh

100644100755
File mode changed.

core_sim/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616
add_subdirectory(src)
1717

1818
# Add unit tests
19-
add_subdirectory(test)
19+
# add_subdirectory(test)

docs/development/dev_setup_win.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ On Windows, Project AirSim can be developed with either Visual Studio 2019 or VS
77

88
1. A) To develop with **VS Code**:
99

10-
First, install the **[VS 2019 C++ build tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)** with:
10+
First, install the **[VS 2022 C++ build tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)** with:
1111

12-
- `C++ build tools` workload
12+
- `Desktop development with C++` workload
1313
- `.NET Framework 4.8 SDK` individual component
14-
- `.NET Core SDK` individual component
14+
- (no)`.NET Core SDK` individual component
1515

1616
Second, install **[VS Code](https://code.visualstudio.com/)** with the following extensions:
1717

@@ -36,12 +36,12 @@ On Windows, Project AirSim can be developed with either Visual Studio 2019 or VS
3636
- `.NET Framework 4.8 SDK` individual component
3737
- `.NET Core SDK` individual component
3838

39-
2. Install the **[Epic Games Launcher](https://www.unrealengine.com/en-US/)** and install Unreal Engine 4.25 binary (requires Epic account log-in). While selecting the engine version to install, there is also an `Options` section where you can enable downloading `Editor symbols for debugging` (~30 GB) if desired. **Note**: Installing the engine can take a long time **(~1 hour)**.
39+
2. Install the **[Epic Games Launcher](https://www.unrealengine.com/en-US/)** and install Unreal Engine 5.2 binary (requires Epic account log-in). While selecting the engine version to install, there is also an `Options` section where you can enable downloading `Editor symbols for debugging` (~30 GB) if desired. **Note**: Installing the engine can take a long time **(~1 hour)**.
4040

4141
3. Set a Windows environment variable for `UE_ROOT` to the installed folder, either through the Control Panel section `Edit environment variables for your account`, or by using the command line:
4242

4343
```
44-
setx UE_ROOT "C:\Program Files\Epic Games\UE_4.25"
44+
setx UE_ROOT "C:\Program Files\Epic Games\UE_5.2"
4545
4646
<restart the command prompt to refresh environment variables>
4747
```
@@ -52,7 +52,7 @@ On Windows, Project AirSim can be developed with either Visual Studio 2019 or VS
5252
5353
6. Clone the Project AirSim repo (HTTPS authentication is recommended for using Git Credential Manager):
5454
55-
`git clone https://bizair.visualstudio.com/Project%20AirSim/_git/projectairsim`
55+
`git clone https://github.com/iamaisim/ProjectAirSim.git`
5656
5757
7. Do the **[Project AirSim Client Setup](../client_setup.md#setting-up-the-client-on-windows)**.
5858

0 commit comments

Comments
 (0)