-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
76 lines (64 loc) · 2.76 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
RCraft: A Ruby Minecraft Server Wrapper
Verion 0.1.8
=====
About:
=====
rcraft is a Ruby wrapper for Minecraft
It requires a Ruby installation and Minecraft server file to run.
The choice in the name is two fold: R for Ruby and R for Our, as we make minecraft our own.
Testing Environment: Ubuntu 10.10 Server
Features:
- Welcome message (Via config.yml)
- !help command (basic implimentation)
- !request command for players to request items and Kits
-- Listing comes from itemlist.yml
-- Uses server command: give <player> <id> <quantity>
-- Format: !request <quantity> <item>
-- Example: !request 10 Stone
-- Friendly item names: Use item names rather than ID's
-- Support requests for more than 64 of an item
-- MOD Friendly: Unrecognized items IDs will attempt to request the item by ID
- !item command to request listing of matching items
-- Format: !item name
-- Example: !item ore
-- Result: Listing of all items with 'ore' in their names
- !players command for players to see the list of other logged in players (Future)
-- Uses server command: list
- Backup system that will shut down the server, back it up, and restart the server (Future)
- Command to change the server time. Convenient for when multiple people are logged in.
-- Will need something to restrict spamming time changes.
=====
Usage:
=====
Place in the same directory as minecraft_server.jar.
Directory path, parameters, and differently named jar file will be configurable via config file in the future.
Run via: ruby rcraft.rb
=======
History:
=======
Version 0.1.8
Minor update of the item list and the readme.
Version 0.1.7
Improved item requests so if no quantity is listed it assumes 1 was requested
Updated item list to fix known bug involving casing
Updated item list with new items since last update
Thanks go out to Exar for some motivation and the item list updates
version 0.1.6
Added item requests by IDs and items quantities greater than 64
Fixed logging to remove redundant timestamp
Added friendly server message for when the server goes down in a full exit
Version 0.1.5
Added logging of player text. Logged text needs trimmed of server timestamp, since logger duplicates it.
Version 0.1.4
Completed item list, added !item command to search for item names, fixed a logic error allowing bad command matches
Version 0.1.3
Added in a partial item list, initial request command.
Version 0.1.2
Added config file for dynamic welcome message and minecraft server path
Version 0.1.1
Added in hardcoded welcome message and !help command.
General outline for further ! based commands started.
Version 0.1.0
Achieved reader threads for stdout and stderror.
Input threat stdin to push commands in from the user.
Input is echoed as is to the server except for the exit command which shuts the full program, threads, and minecraft down.