Add remaining READMEs, add helper script

This commit is contained in:
KoffeinFlummi 2015-01-26 14:34:48 +01:00
parent 0f027e7e09
commit c407553d49
42 changed files with 562 additions and 0 deletions

12
addons/goggles/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_goggles
===========
Adds various effects to different kinds of goggles and ambient effects like dirt thrown up by explosions.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [esteldunedain](https://github.com/esteldunedain)
- [CorruptedHeart](https://github.com/CorruptedHeart)

12
addons/grenades/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_grenades
============
Introduces different throwing modes for grenades, as well as a flashbang and hand flares.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

11
addons/gui/README.md Normal file
View File

@ -0,0 +1,11 @@
ace_gui
=======
to be scrapped.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [Glowbal](https://github.com/Glowbal)

13
addons/hearing/README.md Normal file
View File

@ -0,0 +1,13 @@
ace_hearing
===========
Introduces combat deafness.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)

View File

@ -0,0 +1,13 @@
ace_interaction
===============
Provides interaction options between units.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)
- [NouberNou](https://github.com/NouberNou)

View File

@ -0,0 +1,12 @@
ace_inventory
=============
Increases the size of the inventory dialog.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [PabstMirror](https://github.com/PabstMirror)

12
addons/kestrel/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_kestrel
===========
Adds the Kestrel weather and wind meter.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

12
addons/laser/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_laser
=========
Contains various functions necessary for the realitic protrayal of laser mechanics in other components.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [walterpearce](https://github.com/walterpearce)
- [NouberNou](https://github.com/NouberNou)

View File

@ -0,0 +1,12 @@
ace_laser_selfdesignate
=======================
Allows gunners to lase their own targets.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [walterpearce](https://github.com/walterpearce)
- [NouberNou](https://github.com/NouberNou)

View File

@ -0,0 +1,12 @@
ace_laserpointer
================
Adds a laser pointer visible during the day.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)

View File

@ -0,0 +1,12 @@
ace_lockbackpacks
=================
Introduces the ability to lock one's backpack.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

View File

@ -0,0 +1,12 @@
ace_magazinerepack
==================
Adds the ability to consolidate multiple half-empty magazines.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)

View File

@ -0,0 +1,12 @@
ace_magazines
=============
Adds new types of ammunition, such as sub-sonic rounds.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

13
addons/main/README.md Normal file
View File

@ -0,0 +1,13 @@
ace_main
========
Backbone of other components, defining most of the commonly used macros.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [walterpearce](https://github.com/walterpearce)
- [NouberNou](https://github.com/NouberNou)

13
addons/map/README.md Normal file
View File

@ -0,0 +1,13 @@
ace_map
=======
Various tweaks to the in-game map.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [esteldunedain](https://github.com/esteldunedain)
- [NouberNou](https://github.com/NouberNou)

13
addons/markers/README.md Normal file
View File

@ -0,0 +1,13 @@
ace_markers
===========
Completely replaces the default marker system, allowing quicker and more precise placement of markers.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)
- [PabstMirror](https://github.com/PabstMirror)

View File

@ -0,0 +1,12 @@
ace_missileguidance
===================
Various new modes for different missiles.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [walterpearce](https://github.com/walterpearce)
- [NouberNou](https://github.com/NouberNou)

12
addons/movement/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_movement
============
Various tweaks to movement animations.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

12
addons/nametags/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_nametags
============
Adds nametags above other players to simulate the familiarity with the faces with others one would have in real life.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)

View File

@ -0,0 +1,12 @@
ace_nightvision
===============
Adds different types of NVGs with different levels of quality.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [PabstMirror](https://github.com/PabstMirror)

12
addons/noradio/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_noradio
===========
Disables the automatic callouts for player units.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [bux578](https://github.com/bux578)

View File

@ -0,0 +1,12 @@
ace_optionsmenu
===============
Adds the options menu used by other components.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [PabstMirror](https://github.com/PabstMirror)
- [NouberNou](https://github.com/NouberNou)

View File

@ -0,0 +1,12 @@
ace_overheating
===============
Introduces weapon overheating and jamming, as well as the ability to swap the barrel on some weapons.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)

View File

@ -0,0 +1,12 @@
ace_protection
==============
Fixes and tweaks the protection values of body armour.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

12
addons/ragdolls/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_ragdolls
============
Tweaks the ragdoll behaviour to be more resposive to bullet impacts and explosions.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

View File

@ -0,0 +1,12 @@
ace_realisticnames
==================
Changes the names of various weapons and vehicles to those of their RL counterparts.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

12
addons/recoil/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_recoil
==========
Overhauls the vanilla recoil, reducing muzzle climb while increasing kickback.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

12
addons/reload/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_reload
==========
Hides the default reload indicators, making it necessary to manually check your magazine.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)

12
addons/respawn/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_respawn
===========
Various module options to help mission makers to quickly set up various respawn configurations.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [bux578](https://github.com/bux578)

12
addons/resting/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_resting
===========
Introduces weapon resting and bipod deployment, allowing the player to increase the stability of his weapon.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

12
addons/safemode/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_safemode
============
Adds the ability to use the safety on small arms.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

13
addons/scopes/README.md Normal file
View File

@ -0,0 +1,13 @@
ace_scopes
==========
Adds adjustable turrets for long-range optics, allowing zeroing in steps of 0.1 MILs.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)
- [bux578](https://github.com/bux578)

View File

@ -0,0 +1,12 @@
ace_smallarms
=============
Tweaks various config values for small arms, improving values like ROF.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

View File

@ -0,0 +1,12 @@
ace_switchunits
===============
Adds insurgency-style unit switching.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [bux578](https://github.com/bux578)
- [commy2](https://github.com/commy2)

12
addons/thermals/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_thermals
============
Improves the thermal properties of humans.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

12
addons/vector/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_vector
==========
Adds the Vector rangefinder including all modes found in its real counterpart.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

12
addons/vehicles/README.md Normal file
View File

@ -0,0 +1,12 @@
ace_vehicles
============
Various tweaks to vehicle and vehicle weapon configs.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [KoffeinFlummi](https://github.com/KoffeinFlummi)
- [commy2](https://github.com/commy2)

View File

@ -0,0 +1,12 @@
ace_weaponselect
================
Adds the ability to quickly select weapons using the number keys.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)

13
addons/weather/README.md Normal file
View File

@ -0,0 +1,13 @@
ace_weather
===========
Fixes weather synchronisation across clients.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [commy2](https://github.com/commy2)
- [esteldunedain](https://github.com/esteldunedain)
- [walterpearce](https://github.com/walterpearce)

View File

@ -0,0 +1,12 @@
ace_wep_dragon
==============
Adds the Dragon AT launcher.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [walterpearce](https://github.com/walterpearce)
- [NouberNou](https://github.com/NouberNou)

View File

@ -0,0 +1,12 @@
ace_wep_javelin
===============
Adds the Javelin AT launcher.
## Maintainers
The people responsible for merging changes to this component or answering potential questions.
- [walterpearce](https://github.com/walterpearce)
- [NouberNou](https://github.com/NouberNou)

64
tools/maintainers.py Executable file
View File

@ -0,0 +1,64 @@
#!/usr/bin/env python3
import os
import sys
def get_all_paths(root):
path = os.path.join(root, "addons")
fpaths = []
for f in os.listdir(path):
fpath = os.path.join(path, f, "README.md")
if not os.path.exists(fpath):
fpaths.append(fpath)
return fpaths
def add_readme(path):
name = os.path.split(os.path.dirname(path))[-1]
name = "ace_"+name
print("\n# COMPONENT: {}".format(name))
description = input("Desc: ")
maintainers = [
"KoffeinFlummi",
"commy2",
"esteldunedain",
"CorruptedHeart",
"PabstMirror",
"bux578",
"Glowbal",
"walterpearce",
"NouberNou"
]
for (i, m) in enumerate(maintainers):
print("({}) {}".format(i, m), end="")
if i+1 < len(maintainers):
print(", ", end="")
else:
print("")
mstring = input("Maintainers: ")
content = name + "\n" + "=" * len(name) + "\n\n"
content += description + "\n\n\n"
content += "## Maintainers\n\n"
content += "The people responsible for merging changes to this component or answering potential questions.\n\n"
for i in mstring.split(","):
mname = maintainers[int(i)]
content += "- [{}](https://github.com/{})\n".format(mname, mname)
f = open(path, "w")
f.write(content)
f.close()
def main():
projectroot = os.path.realpath(__file__)
projectroot = os.path.dirname(os.path.dirname(projectroot))
paths = get_all_paths(projectroot)
print(len(paths))
for path in paths:
add_readme(path)
if __name__ == "__main__":
main()