Skip to content

Commit 8bcdebe

Browse files
committed
Update readme
1 parent 7811475 commit 8bcdebe

1 file changed

Lines changed: 59 additions & 16 deletions

File tree

readme.txt

Lines changed: 59 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
=== Xonpress ===
22
Tags: shortcode xonotic
3-
Donate link: TODO
3+
Donate link: https://www.paypal.me/MattBas
44
License: GPLv3+
55
License URI: http://www.gnu.org/licenses/gpl-3.0.html
6+
Requires at least: 3.5
7+
Tested up to: 4.4.2
8+
Contributors: mattiabasaglia
9+
Stable tag: master
10+
Tags: xonotic, unvanquished
611

7-
Xonotic Integration for Wordpress.
12+
Xonotic/Unvanquished integration for Wordpress.
813

914
== Description ==
1015

@@ -14,17 +19,15 @@ Adds shortcodes to display Xonotic server information on a Wordpress page.
1419

1520
Shows server status/info.
1621

17-
* ip [127.0.0.1] Connection address to query the server
18-
* port [26000] Connection (UDP) port to query the server
19-
* public_host [ip] Address to show on the page
20-
* stats_url [empty] Url to link to server stats
22+
* server [xon://127.0.0.1:26000] Connection address to query the server
23+
* public_host [same as in server] Address to show on the page
24+
* stats_url [empty] Url to link to server stats
2125

2226
= xon_players =
2327

2428
Shows a list of players currently in the server.
2529

26-
* ip [127.0.0.1] Connection address to query the server
27-
* port [26000] Connection (UDP) port to query the server
30+
* server [xon://127.0.0.1:26000] Connection address to query the server
2831

2932
= xon_img =
3033

@@ -33,10 +36,25 @@ Note: maps need to be extracted and have names like mymap.jpg (all lowercase),
3336
you can use this script to extract them:
3437
https://github.com/Evil-Ant-Colony/Xonotic-EAC-Scripts/blob/master/pk3/pk3-get-screenshots
3538

36-
* ip [127.0.0.1] Connection address to query the server
37-
* port [26000] Connection (UDP) port to query the server
38-
* class [xonpress_screenshot] CSS class for the image element
39-
39+
* server [xon://127.0.0.1:26000] Connection address to query the server
40+
* class [xonpress_screenshot] CSS class for the image element
41+
42+
= xon_player_number =
43+
44+
Display a summary of the number of players in the server.
45+
The format is player/total (bots)
46+
47+
* server [xon://127.0.0.1:26000] Connection address to query the server
48+
49+
= xon_server_list =
50+
51+
Shows a table with server details. It can show a fixed list of servers or
52+
get it from the master server.
53+
54+
* master Master server address
55+
* master_protocol Protocol name to use a default master server
56+
* servers A list of servers
57+
4058
= xon_mapinfo =
4159

4260
Shows information about a map.
@@ -67,18 +85,43 @@ URL corresponding to xonpress_maps_dir
6785

6886
Whether special darkplaces characters should be translated into Unicode (Default: 1)
6987

88+
= unvicon_prefix / unvicon_suffix =
89+
90+
Prefix/suffix used to link to the unvicons in Daemon strings.
91+
92+
= color_min_luma / color_max_luma =
93+
94+
Value between 0 and 1 to adjust the parsed colors to light or dark backgrounds.
95+
7096
== Theme Requirements ==
7197

7298
* img/noscreenshot.png
73-
** Image shown when a map screenshot cannot be found.
74-
* xonotic-map.php
75-
** Used by [xon_mapinfo], it should use the global $mapinfo
99+
* Image shown when a map screenshot cannot be found.
100+
* xonotic-map.php (template)
101+
* Used by [xon_mapinfo], it should use the global $mapinfo
76102

77103
== Installation ==
78104

79105
Nothing special, just extract the files in wp-contents/plugins/xonpress
80106

107+
== Changelog ==
108+
109+
= 0.2 =
110+
* Unvanquished integration
111+
* Master server list
112+
113+
= 0.1 =
114+
* Xonotic integration
115+
116+
== Upgrade Notice ==
117+
118+
Just pull the latest changes...
119+
120+
== Screenshots ==
121+
122+
None at the moment.
123+
81124
== Frequently Asked Questions ==
82125

83-
= Will it work with other games based on Darkplaces or similar engines? =
126+
= Will it work with other games based on similar engines? =
84127
Maybe, they need to respond to getstatus.

0 commit comments

Comments
 (0)