OAC:HowToImproveTheCompatibilityAddon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Image:" to "[[File:")
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Image:Banner biki.jpg]]
[[File:Banner biki.jpg]]


=# VII. How to improve OAC=
=# VII. How to improve OAC=


Project OAC uses [http://en.wikipedia.org/wiki/Git_%28software%29 Git] as source control (SC) system for the development.
Project OAC uses {{Link|https://en.wikipedia.org/wiki/Git_%28software%29|Git}} as source control (SC) system for the development.


You can:
You can:
Line 18: Line 18:




==Git: Source control system==
== Git: Source control system ==


1) Install git and check out the repository:
1) Install git and check out the repository:
* [http://dev-heaven.net/wiki/heaven/Git Git]
* {{Link|link= http://dev-heaven.net/wiki/heaven/Git|text= Git}}
* [http://dev-heaven.net/wiki/heaven/Git_Gui_Guide Git Gui Guide]
* {{Link|link= http://dev-heaven.net/wiki/heaven/Git_Gui_Guide|text= Git Gui Guide}}
* [http://dev-heaven.net/wiki/20/GitExtensions_QuickStart GitExtensions QuickStart]
* {{Link|link= http://dev-heaven.net/wiki/20/GitExtensions_QuickStart|text= GitExtensions QuickStart}}


IMPORTANT: Download OAC directly into this folder:
IMPORTANT: Download OAC directly into this folder:
Line 30: Line 30:
2) Pull (download) and push (upload) are explained in the guide above.
2) Pull (download) and push (upload) are explained in the guide above.


If you have any questions, please use the new [http://dev-heaven.net/projects/oac/boards OAC forum].
If you have any questions, please use the new {{Link|link= http://dev-heaven.net/projects/oac/boards|text= OAC forum}}.




===Making campaigns and missions folder available to arma===
=== Making campaigns and missions folder available to arma ===


'''IMPORTANT OAC campaigns or missions (only MP mission are an exception) note.'''
'''IMPORTANT OAC campaigns or missions (only MP mission are an exception) note.'''
Line 47: Line 47:
* Use junctions:
* Use junctions:


# Install [http://schinagl.priv.at/nt/hardlinkshellext/hardlinkshellext.html Link Shell Extension]
# Install {{Link|http://schinagl.priv.at/nt/hardlinkshellext/hardlinkshellext.html|Link Shell Extension}}
# RMB click on a folder, for example ''.\arma\x\oac\campaigns\bi\1985''.
# RMB click on a folder, for example ''.\arma\x\oac\campaigns\bi\1985''.
# Select "pick link source".
# Select "pick link source".
Line 61: Line 61:
those two instances gets updated, so will the other.
those two instances gets updated, so will the other.


===Get latest files from the repository===
=== Get latest files from the repository ===


In the local repository (.\arma\x\oac) you find a file called '''git_pull.bat'''.<br>
In the local repository (.\arma\x\oac) you find a file called '''git_pull.bat'''.<br>
Line 68: Line 68:
'''Do not forget to build the updates non mission PBOs.'''
'''Do not forget to build the updates non mission PBOs.'''


Use the [http://dev-heaven.net/repositories/show/oac OAC repository browser] and the [http://dev-heaven.net/repositories/revisions/oac OAC revisions details] to get an idea<br>
Use the {{Link|link= http://dev-heaven.net/repositories/show/oac|text= OAC repository browser}} and the {{Link|link= http://dev-heaven.net/repositories/revisions/oac|text= OAC revisions details}} to get an idea<br>
what folders have been updated and need to built to PBO after an update.
what folders have been updated and need to built to PBO after an update.


==Repository access==
== Repository access ==


Repository URL:
Repository URL:
  git@git.dev-heaven.net:oac.git
  git@git.dev-heaven.net:oac.git


===Anon read access===
=== Anon read access ===


Just git clone the above URL.
Just git clone the above URL.
Line 82: Line 82:
  git clone git://git.dev-heaven.net/oac.git
  git clone git://git.dev-heaven.net/oac.git


===Write access===
=== Write access ===


Send [http://dev-heaven.net/account/show/4 kju] your ssh key. Check the [http://dev-heaven.net/wiki/heaven/SSH-Keyset ssh guide] how to create one for you.
Send {{Link|link= http://dev-heaven.net/account/show/4|text= kju}} your ssh key. Check the {{Link|link= http://dev-heaven.net/wiki/heaven/SSH-Keyset|text= ssh guide}} how to create one for you.


==Coding standards==
== Coding standards ==


* Get a proper text editor like [http://notepad-plus.sourceforge.net/uk/site.htm notepad++] or [http://www.editpadpro.com editpadpro].
* Get a proper text editor like {{Link|http://notepad-plus.sourceforge.net/uk/site.htm|notepad++}} or {{Link|http://www.editpadpro.com|editpadpro}}.
* Do not mess up the code:
* Do not mess up the code:
** Preceding tabs - NO spaces! - before the code.
** Preceding tabs - NO spaces! - before the code.
Line 105: Line 105:




=Back to OAC Home=
= Back to OAC Home =


[[OAC:Project#Subpage_link_overview|The seven roads to OAC - subpage link overview]]
[[OAC:Project#Subpage_link_overview|The seven roads to OAC - subpage link overview]]

Latest revision as of 00:10, 21 November 2023

Banner biki.jpg

# VII. How to improve OAC

Project OAC uses Git as source control (SC) system for the development.

You can:

  • download the complete source with Git and play-test unreleased missions and campaigns
  • improve the existing missions and campaigns
  • add new class mappings to the OFP compatibility addon

and upload your changes again for everyone to use and improve.

The repository contains all campaigns and missions in development and released,
all their voice files, the OFP music files, replacement addons for community addons,
CWR and Project 85. The size is 1 GB and growing.


Git: Source control system

1) Install git and check out the repository:

  • Git (dead link)
  • Git Gui Guide (dead link)
  • GitExtensions QuickStart (dead link)

IMPORTANT: Download OAC directly into this folder:

.\arma\x\oac

2) Pull (download) and push (upload) are explained in the guide above.

If you have any questions, please use the new OAC forum (dead link).


Making campaigns and missions folder available to arma

IMPORTANT OAC campaigns or missions (only MP mission are an exception) note.

By default these are in .\arma\x\oac\*. This way they are not loaded.

Two options:

  • NOT RECOMMENDED:

Copy stuff to .\arma\campaigns, .\arma\missions, .\arma\mpmissions.

  • Use junctions:
  1. Install Link Shell Extension
  2. RMB click on a folder, for example .\arma\x\oac\campaigns\bi\1985.
  3. Select "pick link source".
  4. Goto .\arma\campaigns.
  5. RMB click on empty area in explorer inside that said folder.
  6. Select "drop as - junction".

The result is that the OS will create a link in this folder to the
source location. In other words on the hard disk level it does some
rewiring to make the 1985 folder also found in the dropped location.

More simply said 1985 is also found in .\arma\campaigns and if any of
those two instances gets updated, so will the other.

Get latest files from the repository

In the local repository (.\arma\x\oac) you find a file called git_pull.bat.
Execute it to update the repository to the latest version.

Do not forget to build the updates non mission PBOs.

Use the OAC repository browser (dead link) and the OAC revisions details (dead link) to get an idea
what folders have been updated and need to built to PBO after an update.

Repository access

Repository URL:

git@git.dev-heaven.net:oac.git

Anon read access

Just git clone the above URL.

git clone git://git.dev-heaven.net/oac.git

Write access

Send kju (dead link) your ssh key. Check the ssh guide (dead link) how to create one for you.

Coding standards

  • Get a proper text editor like notepad++ or editpadpro.
  • Do not mess up the code:
    • Preceding tabs - NO spaces! - before the code.
    • Correct number of preceding tabs.
    • NO tabs or spaces at the end of the line.
    • Spaces around an equal sign are standard.
    • One space after a colon, not before it.
    • Do not forget a semicolon to end definitions.
    • Use quotes for strings.
    • Correct placement of brackets.
  • Use comments where they are meaningful.
  • Use empty lines to separate code.
  • Order lists alphabetically - use editor functions!
  • Create a file header for addons according to the standard.
  • Name addons according to the standard.


Back to OAC Home

The seven roads to OAC - subpage link overview