Skip to content

Commit a54365b

Browse files
author
Hubert
authored
Upgrade to v1.10
1 parent 3938060 commit a54365b

File tree

1 file changed

+51
-12
lines changed

1 file changed

+51
-12
lines changed

README.md

Lines changed: 51 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
About Minecraft Shell Library
22
=============================
3-
An API for Minecraft / Bukkit server management and scripting.
4-
5-
Check http://lotr-minecraft-mod-exiles.wikia.com/wiki/Minecraft_Shell_Library for functions list.
3+
An API for Minecraft / Forge / Bukkit server management and scripting.
64

75

86
Installation
@@ -14,6 +12,8 @@ After that just type "make install" and answer those questions.
1412
For an initial installation, you'll have to tweak the settings to your taste in the .server-settings installed file.
1513
Else verify if there are new configuration items to import in your existing server configuration.
1614

15+
Also add the Commands and Scripts subdirectories to the PATH of your Minecraft system account.
16+
1717

1818
Usage
1919
=====
@@ -23,17 +23,13 @@ Include the following line near the start of your shell scripts:
2323

2424
Then you can use all the functions in the library.
2525

26-
Check CronTasks/CronMonitor for a little example.
26+
Check Scripts/mcchat for a little example.
2727

2828
The functions list is located at the start of the .minecraft-library file.
2929
For parameters, check each function header.
3030

31-
32-
Further development plans
33-
=========================
34-
The library works fine for me as it is.
35-
Nonetheless, I think I'll add a function to check if a player is running a forbidden client side mod, which could then be called from a cron script to kick/ban offending players.
36-
I'm also considering to add the remaining Minecraft console commands.
31+
The library is fully documented at the following Web address:
32+
http://lotr-minecraft-mod-exiles.wikia.com/wiki/Minecraft_Shell_Library
3733

3834

3935
Caveats
@@ -43,7 +39,50 @@ Developed and tested only on FreeBSD 10.1.
4339

4440
Versions and changelog
4541
======================
46-
1.00 2016-09-18 Initial public release
42+
1.10 2016-09-30 Added a StripColors() function for filtering out color codes from logfiles
43+
44+
Added a DisplayChat() function for filtering the chat from a logfile
45+
46+
Added a GetClientSideModsForPlayer() function for getting the list of client side mods used by a player
47+
48+
Added a GetForbiddenModsForPlayer() function for getting the list of forbidden client side mods used by a player
49+
50+
Corrected errors in ToggleNbtValue(), GetOnlinePlayers()
51+
52+
Made generic wrappers for commands, with or without results to display
53+
54+
Separated the /mem and /mv who commands from the mem command
55+
56+
Corrected display glitches from the mem command
57+
58+
Moved all commands out of the server root directory, back in the Commands subdir
59+
60+
Added all the standard Minecraft commands
61+
62+
Added a Script sub-directory to store Scripts
63+
64+
Moved start* and stop commands to the Scripts subdirectory
65+
66+
Made the start command obey the .dontrestart directive and check if the server is already loaded
67+
68+
Added a mcchat script to display the chat
69+
70+
Added a mclast script to display players' log in and out from logfiles
71+
72+
Added a CronDetectCheaters Cron script to check if players are using forbidden client side mods and, if yes, apply justice to them
73+
74+
Added MSL_ForbiddenMods.txt and MSL_ForbiddenMods-full.txt config files in tge config subdir with the list of forbidden mods
75+
76+
Added usage and uninstall targets to the Makefile
77+
78+
1.00 2016-09-18 Initial public release
79+
80+
81+
Further development plans
82+
=========================
83+
I'm considering to add custom shell commands, which could be implemented either through a non existent /-prefixed command to be caught in the server log, through a "/mail send" Bukkit Essentials command sent to an admin account, or better through a gateway mod or plugin which would also pass additional info (player position, item held, block being aimed at, etc.).
84+
85+
Everybody is also welcome to complete the forbidden client side mods list.
4786

4887

4988
License
@@ -54,4 +93,4 @@ This open source software is distributed under a BSD license (see the "License"
5493
Author
5594
======
5695
Hubert Tournier
57-
September, 18 2016
96+
September, 30 2016

0 commit comments

Comments
 (0)