Arma3_Epoch/ACE3
1
0
Fork 0
mirror of https://github.com/acemod/ACE3.git synced 2024-08-30 18:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#5455)

Browse Source 
* Update README.md

* Update README.md
This commit is contained in:
Thomas Kooi 2017-08-26 18:37:51 +02:00 committed by PabstMirror
parent eacca05fda
commit 78fafc93cb
1 changed files with 47 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -37,7 +37,8 @@ The project is entirely **open-source** and all contributions are welcome. Feel
The mod is **built modularly**, so almost any included PBO can be easily removed from the configuration. This way, a team can maintain its own tailored version of ACE3 by simply excluding any components they don't need, or those possibly in conflict with other mods. Modules themselves, e.g. the medical system, also include various customization options, allowing mission designers to tweak the overall experience. The mod is **built modularly**, so almost any included PBO can be easily removed from the configuration. This way, a team can maintain its own tailored version of ACE3 by simply excluding any components they don't need, or those possibly in conflict with other mods. Modules themselves, e.g. the medical system, also include various customization options, allowing mission designers to tweak the overall experience.
### Core features ## Core features
- Brand new 3D interaction/action system - Brand new 3D interaction/action system
- Performance and reliability framework - Performance and reliability framework
- Focus on modularity and customization - Focus on modularity and customization
@ -51,7 +52,8 @@ The mod is **built modularly**, so almost any included PBO can be easily removed
- Logistics - Logistics
- Advanced missile guidance and laser designation - Advanced missile guidance and laser designation
#### Additional features ### Additional features
- Carrying and dragging - Carrying and dragging
- Realistic names for vehicles and weapons - Realistic names for vehicles and weapons
- A fire control system (FCS) for armored vehicles and helicopters - A fire control system (FCS) for armored vehicles and helicopters
@ -72,18 +74,56 @@ The mod is **built modularly**, so almost any included PBO can be easily removed
- Vector, MicroDAGR and Kestrel devices<br> - Vector, MicroDAGR and Kestrel devices<br>
***and much more...*** ***and much more...***
### Guides & how-tos ## Getting started
If you installed ACE3 but have trouble understanding how it all works, or where to start, read this first:
ACE3 requires Arma 3 and the latest version of <a href="https://github.com/CBATeam/CBA_A3/releases">CBA A3</a>. See the following pages for help and information on how to get started with ACE3:
- [Installation guide](https://ace3mod.com/wiki/user/installation-guide.html) - [Installation guide](https://ace3mod.com/wiki/user/installation-guide.html)
- [Information center](https://ace3mod.com/wiki/user/information-center.html) - [Information center](https://ace3mod.com/wiki/user/information-center.html)
#### Contributing ## Contributing
You can help out with the ongoing development by looking for potential bugs in our code base, or by contributing new features. To contribute something to ACE3, simply fork this repository and submit your pull requests for review by other collaborators. Remember to add yourself to the author array of any PBO you will be editing and the [`AUTHORS.txt`](https://github.com/acemod/ACE3/blob/master/AUTHORS.txt) file; including a valid email address.
You can help out with the ongoing development by looking for potential bugs in our code base, or by contributing new features. We are always welcoming new pull requests containing bug fixes, refactors and new features. We have a list of tasks and bugs on our issue tracker on Github. Please comment on issues if you want to contribute with, to avoid duplicating effort.
### Contribution guidelines
To contribute something to ACE3, simply fork this repository and submit your pull requests for review by other collaborators. Remember to add yourself to the author array of any PBO you will be editing and the [`AUTHORS.txt`](https://github.com/acemod/ACE3/blob/master/AUTHORS.txt) file; including a valid email address.
### Submitting issues and requesting features
Please, use our [Issue Tracker](https://github.com/acemod/ACE3/issues) to report a bug, propose a feature, or suggest changes to the existing ones. See also: Please, use our [Issue Tracker](https://github.com/acemod/ACE3/issues) to report a bug, propose a feature, or suggest changes to the existing ones. See also:
- [How to report an issue](https://ace3mod.com/wiki/user/how-to-report-an-issue.html) - [How to report an issue](https://ace3mod.com/wiki/user/how-to-report-an-issue.html)
- [How to make a feature request](https://ace3mod.com/wiki/user/how-to-make-a-feature-request.html) - [How to make a feature request](https://ace3mod.com/wiki/user/how-to-make-a-feature-request.html)
#### Testing & building ### Testing & building
To help us test the latest development changes, download our master branch ([directly](https://github.com/acemod/ACE3/archive/master.zip), or [with git](https://help.github.com/articles/fetching-a-remote/)), then assemble a test build: To help us test the latest development changes, download our master branch ([directly](https://github.com/acemod/ACE3/archive/master.zip), or [with git](https://help.github.com/articles/fetching-a-remote/)), then assemble a test build:
- [Setting up the development environment](https://ace3mod.com/wiki/development/setting-up-the-development-environment.html) – step-by-step instructions on how to properly setup and build a version of ACE3 for testing purposes. - [Setting up the development environment](https://ace3mod.com/wiki/development/setting-up-the-development-environment.html) – step-by-step instructions on how to properly setup and build a version of ACE3 for testing purposes.
### Get in touch
<table>
<tr>
<td><a href="https://slackin.ace3mod.com/">Slack</a></td>
<td>We have a public Slack team that anyone can join. This is where all our developers and contributors hang out and where we make announcements</td>
</tr>
<tr>
<td><a href="https://twitter.com/ACE3Mod">Twitter</a></td>
<td>You can follow our Twitter account to get updates and various links to guides</td>
</tr>
<tr>
<td><a href="https://www.facebook.com/ACE3Mod">Facebook</a></td>
<td>You can follow our Facebook account to get updates and various links to guides</td>
</tr>
<tr>
<td><a href="https://forums.bistudio.com/topic/181341-ace3-a-collaborative-merger-between-agm-cse-and-ace/?p=2859670">Bohemia Forum</a></td>
<td>We have a dedicated thread on the Bohemia Forums for the ACE3 project</td>
</tr>
</table>
## License
ACE3 is licensed under the GNU General Public License ([GPLv2](https://github.com/acemod/ACE3/blob/master/LICENSE).