Skip to content

Commit 9dadbff

Browse files
committed
tested build for v.24, edited readme
1 parent 4953c69 commit 9dadbff

3 files changed

Lines changed: 60 additions & 66 deletions

File tree

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ SRC=$(NAME).cs
55
TGZ=$(NAME).tar.gz
66
ZIP=$(NAME).zip
77

8-
SOURCES=license readme Makefile $(SRC)
8+
SOURCES=license readme.md Makefile $(SRC)
99

1010
INSTALLDIR="$(KSP_DIR)"/GameData/$(NAME)
1111

@@ -37,7 +37,7 @@ $(ZIP): $(SOURCES) $(DLL)
3737
cp $(DLL) $(NAME)/GameData/$(NAME)
3838
mkdir -p $(NAME)/src
3939
cp $(SOURCES) $(NAME)/src
40-
cp readme $(NAME)/readme.txt
40+
cp readme.md $(NAME)/readme.txt
4141
zip --recurse-paths $@ $(NAME)
4242

4343
tgz: $(TGZ)

readme

Lines changed: 0 additions & 64 deletions
This file was deleted.

readme.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# How to install
2+
3+
Like pretty much every mod, copy the content of GameData to GameData in your KSP folder.
4+
5+
# How to use
6+
7+
Select a docking port as target.
8+
An additional red marker will appear, indicating the direction your docking port needs to face to be parallel to the target docking port.
9+
10+
This mod is basically a light-weight version of NavyFish's Docking Port Alignment Indicator mod, using only a single marker on the navball instead of a whole new window.
11+
12+
# How to configure
13+
14+
After the first start, there will be a text file at KSP_DIR/GameData/NavBallDockingAlignmentIndicator/PluginData/NavBallDockingAlignmentIndicator/config.xml, which you can edit to adjust the marker color and texture (the color is a vector3 of rgb, the texture is a vector2 of x, y subtexture position on [this texture](https://github.com/kitoban/EnhancedNavBall/blob/master/materialRef.JPG)).
15+
16+
The default values are (1, 0, 0) (red) and (0, 2) (the prograde marker).
17+
18+
# How to manually build
19+
20+
Use the included Makefile (or an development environment, if you wish to)
21+
22+
# Changelog
23+
24+
v0, 2013-10-20, KSP 0.22:
25+
26+
Initial release
27+
28+
v1, 2013-12-18, KSP 0.23:
29+
30+
Updated for KSP 0.23, changed ZIP folder structure
31+
32+
v2, 2013-12-18, KSP 0.23:
33+
34+
Made marker color and texture manually configurable
35+
36+
v3, 2014-05-10, KSP 0.23.5:
37+
38+
Instead of just docking ports, all parts that provide targeting information
39+
are now supported. This is mostly relevant for other mods.
40+
41+
v4, 2014-07-18, KSP 0.24:
42+
43+
Updated for KSP 0.24, changed readme file
44+
45+
# URLs
46+
47+
- [Github](https://github.com/mic-e/kspnavballdockingalignmentindicator)
48+
- [Forum](http://forum.kerbalspaceprogram.com/threads/54303)
49+
50+
# Credits
51+
52+
- NavyFish, creator of [Docking Alignment Indicator](http://kerbalspaceport.com/dock-align-indicator/)
53+
- kitoban, creator of [Enhanced Navball](http://kerbalspaceport.com/enhancednavball/)
54+
- taniwha, for the v2->v3 update
55+
56+
# License
57+
58+
This code is licensed under the GNU General Public License version 3, or, at your choice, any higher version.

0 commit comments

Comments
 (0)