luk3yx
/
advmarkers
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix README.md

This commit is contained in:
luk3yx 2019-01-08 14:04:18 +13:00
parent a2985a8d76
commit bed57ce3f0
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -2,14 +2,14 @@
A marker/waypoint mod for Minetest. A marker/waypoint mod for Minetest.
Unlike the [CSM], this mod does not require the [markers] mod to be installed. Unlike the [CSM], this mod is standalone, and conflicts with the [marker] mod.
## How to use ## How to use
`advmarkers` introduces the following chatcommands: `advmarkers` introduces the following chatcommands:
- `/mrkr`: Opens a formspec allowing you to display or delete markers. If you give this command a parameter (`h`/`here`, `t`/`there` or co-ordinates), it will set your HUD position to those co-ordinates. - `/mrkr`: Opens a formspec allowing you to display or delete markers. If you give this command a parameter (`h`/`here`, `t`/`there` or co-ordinates), it will set your HUD position to those co-ordinates.
- `/add_mrkr`: Adds markers. You can use `.add_mrkr x,y,z Marker name` to add markers. Markers are (currently) cross-server, and adding a marker with (exactly) the same name as another will overwrite the original marker. If you replace `x,y,z` with `here`, the marker will be set to your current position, and replacing it with `there` will set the marker to the last `.coords` position. - `/add_mrkr`: Adds markers. You can use `.add_mrkr x,y,z Marker name` to add markers. Adding a marker with (exactly) the same name as another will overwrite the original marker. If you replace `x,y,z` with `here`, the marker will be set to your current position, and replacing it with `there` will set the marker to the last `.coords` position.
- `/mrkr_export`: Exports your markers to an advmarkers string. Remember to not modify the text before copying it. You can use `/mrkr_export old` if you want an export string compatible with older versions of the advmarkers CSM (it should start with `M` instead of `J`). This old format does **not** work with this mod, so only use it if you know what you are doing! - `/mrkr_export`: Exports your markers to an advmarkers string. Remember to not modify the text before copying it. You can use `/mrkr_export old` if you want an export string compatible with older versions of the advmarkers CSM (it should start with `M` instead of `J`). This old format does **not** work with this mod, so only use it if you know what you are doing!
- `/mrkr_import`: Imports your markers from an advmarkers string (`.mrkr_import <advmarkers string>`). Any markers with the same name will not be overwritten, and if they do not have the same co-ordinates, `_` will be appended to the imported one. - `/mrkr_import`: Imports your markers from an advmarkers string (`.mrkr_import <advmarkers string>`). Any markers with the same name will not be overwritten, and if they do not have the same co-ordinates, `_` will be appended to the imported one.
- `/mrkrthere`: Alias for `/mrkr there`. - `/mrkrthere`: Alias for `/mrkr there`.
@ -22,8 +22,8 @@ update the last `.coords` position.
advmarkers works with the `.coords` command from chat_channels ([GitHub], advmarkers works with the `.coords` command from chat_channels ([GitHub],
[GitLab]), even without chat channels installed. When someone does `.coords`, [GitLab]), even without chat channels installed. When someone does `.coords`,
advmarkers temporarily stores this position, and you can set a temporary marker advmarkers temporarily stores this position, and you can set a temporary marker
at the `.coords` position with `.mrkrthere`, or add a permanent marker with at the `.coords` position with `/mrkrthere`, or add a permanent marker with
`.add_mrkr there Marker name`. `/add_mrkr there Marker name`.
[CSM]: https://gitlab.com/luk3yx/minetest-advmarkers-csm [CSM]: https://gitlab.com/luk3yx/minetest-advmarkers-csm
[marker]: https://github.com/Billy-S/kingdoms_game/blob/master/mods/marker [marker]: https://github.com/Billy-S/kingdoms_game/blob/master/mods/marker