Starmade Wrapper - A starmade server management tool

[gravypod]

StarmadeWrapper is a wrapper utility for the starmade server. It adds command, and scripting, functionality to your server.

Updates (All updates available at http://gravypod.com/smw/):

• Version 0.0.3: http://star-made.org/comment/97583#comment-97583
• Version 0.0.4: http://star-made.org/comment/97587#comment-97587
• Version 0.0.5: http://star-made.org/comment/97634#comment-97634

Configure:

1. Refer to "How to start"
2. Stop server (type "stop" in console and click ender)
3. Open "config.yml"
4. Change settings accordingly

Commands:

1. !addwarp (faction name or "all" for all users) (x) (z) (x) (z): Add a warp that links to sectors together (Admin Only)
2. !claim: Claim rewards for a user after they have voted for on http://starmade-servers.com
3. !delwarp (x) (z): Delete all warps that connect to (x) (z)
4. !setfactionowner (user) (faction name): Set the owner of a faction to allow them to permit users to use their warp-gates
5. !help: Get help info for a user
6. !location: Get the location as last reported to StarmadeWrapper
7. !permit (user): Permit (user) to use any warp-gates owned by your faction
8. !reload: Reload all of the commands, and scripts, registered to the server. (Admin Only)
9. !stuck: Teleports the sender to spawn
10. !tp (x) (z): Sends the command sender to sector (x) (z)
11. !warp: Warps the sender to the other end of a warp sector (Only works in a sector added as a warp)

How to find more builds:

1. Go to http://gravypod.com/smw/

How to start:

1. Unzip this into a directory
2. Run the script file for your OS
   
   On windows run "windows-start.bat"
3. On linux run "linux-start.sh"

[*]Wait for the server to start
[*]Stop the server, edit the configs to your liking.
[*]Redo step number 2 to start the server again.


How to use scripts:

1. Learn how to use the scripting API
   
   Learn how to use Sleep from http://sleep.dashnine.org/manual/
2. Download and read all of the information within this script: http://gravypod.com/smw/test.sl

[*]Create a file in the scripts directory named the same thing you would like the command to be and an extension of ".sl" (e.x. If you would like to create a ("!test" command, create a file called "test.sl")
[*]Restart the server, or run the "!reload" command in game, so that the wrapper loads your newly created script


How to get in touch:

1. Connect to irc.esper.net and join #gravypod
2. Email me at gravypod [at] gravypod com

Good to know info:

1. Yes, I do like feature requests and bug reports
2. Yes, I can work with you if you are a hosting company to get this working with your setup
3. No, I am not breaking the TOS of starmade

Requirements:

1. Java 7 may be required

Libraries used & packaged within the jar:

1. Sleep ( http://sleep.dashnine.org/ )
2. YamlBeans ( https://github.com/EsotericSoftware/yamlbeans/ )
3. Json-Simple ( https://code.google.com/p/json-simple/ )

 

[therimmer96]

You would think this kind of functionality was built into the game, buuut nope. I hope this sort of thing gets added to the vanilla game eventually

 

[gravypod]

I hope people like the scripting language used in this. I feel it is a much better alternative to lua.

 

[BDLS]

This thread isn\'t getting the attention it deserves, a bump is in order.

 

[DukeofRealms]

And you are definitely not breaking the TOS, we encourage the community to do exactly what you do +1

 

[Nameless]

Whaaaa? Java support for perl?!?! I am definitely downloading this to try out.

Perl-esque, technically but whatever..

 

[NeonSturm]

!addwarp (faction name or \"all\" for all users) (x) (z) (x) (z): Add a warp that links to sectors together (Admin Only)


+1

It would be cool if servers could choose every user can make 4 (or any other number) gates for his faction. And the leader 10, only activate 1 each 4 hours - spam protection - or just over certain distance (5 sectors or what the server wants).


!delwarp (x) (z): Delete all warps that connect to (x) (z)


It should accept 6 parameters as well. For the case you want to link a sector to 3 others and this also to 3 others and then break the link because \"the gate\" got killed.

Is there no !listwarps command?


!help: Get help info for a user


Does this not work via pm? I guess It could spam the chat.


!location: Get the location as last reported to StarmadeWrapper


Location of a player, a ship?


!permit (user): Permit (user) to use any warp-gates owned by your faction


Would be cool if gates could be given ranks or \"roles\", so only users of that role can use it.


!stuck: Teleports the sender to spawn


On some server we used 123455 0 0 as creative area with give_all_items. It would be cool if the tool could trap someone in a sector (because of shops) until he explicitely says he wanna get back to spawn.

Automatically backup or at least a give_all_items + trap in a sector - or delete_inventory and tp back to spawn- would be a nice addon to it.


!tp (x) (z): Sends the command sender to sector (x) (z)


/tp (with slash) teleports a player towards you. /change_sector is the admin command for this. I suggest to use !cs or !goto instead.

 

[gravypod]

Easy, fast, simple to learn; perl-style stuff has always been nice to work with.

 

[gravypod]

• \"It would be cool if servers could choose every user can make 4 (or any other number) gates for his faction. And the leader 10, only activate 1 each 4 hours - spam protection - or just over certain distance (5 sectors or what the server wants).\"
  
  This would be a nice idea. I want to, first, get the warps woring in such a way that you do not need to create \"fake\" factions. I would love to just use the faction IDs of players. I will look into more stuff like this, as well as the ability for server owners to create donor-only command, as I work with the code

[*]\"It should accept 6 parameters as well. For the case you want to link a sector to 3 others and this also to 3 others and then break the link because \"the gate\" got killed.\"

• 
  Adding a 6 argument version does sound as a good idea. That will most likely happen next release.

[*]\"Is there no !listwarps command?\"

• 
  Not at this time, no. I have been experimenting with getting chat messages to work better and PMs from the StarmadeWrapper to work better first.

[*]\"Does this not work via pm? I guess It could spam the chat.\"

• 
  Yes, all of the command responces are sent via PMs

[*]\"Location of a player, a ship?\"

• 
  A player location, although it may be inaccurate. There is no location information sent for when the play logs into the server, so the StarmadeWrapper assumes you start at (2, 2, 2).

[*]\"Would be cool if gates could be given ranks or \"roles\", so only users of that role can use it.\"

• 
  A permission system is planned. If you look at my minecraft mod, AllAdmin, you can see a projection of many of the features you should come to expect.

[*]\"On some server we used 123455 0 0 as creative area with give_all_items. It would be cool if the tool could trap someone in a sector (because of shops) until he explicitely says he wanna get back to spawn.Automatically backup or at least a give_all_items + trap in a sector - or delete_inventory and tp back to spawn- would be a nice addon to it.\"

• 
  ?This seems like a good feature to implement in a script. I will soon be making a site where users can share scripts that they have created (much like bukkit\'s dev.bukkit site, except with less oligarchical oversight).

[*]?\"/tp (with slash) teleports a player towards you. /change_sector is the admin command for this. I suggest to use !cs or !goto instead.\"

• 
  The commands name is fairly easy to change, I think I will just adapt the change sector command to do intra- and inter-sector teleports as well as teleporting to people. So \"!tp (username)\" TPs you to (user), \"!tp 0.1 0.9 0.99\" tps you within the sector, and \"!tp 1 1 1\" tps you to sector (1, 1, 1)

I hope that clears some stuff up.

 

[Titansmasher]

Im having a bit of a problem with the wrapper and the warp gates.

I initialised the server, set myself up as admin, restarted the server and then attempted to enter \"!addwarp all 3 3 3 5 5 5\" into the chat, and it returns the error \"One of the numbers input was unable tp be parsed! Check your arguments\" Any help on what i have done wrong?

My thinking is that it may have something to do with the fact that no warp.yml file was created by the wrapper on startup....

 

[matheus.de.alcantara]

No it\'s not. Lua is.. lua.

 

[gravypod]

That should not have effected the functionality of the wrapper.

A few questions:

1. What OS are you on?
2. Does the user you are runnning the wrapper under have the ability to read and write to the files?
3. Is there anything prineted out the the console?

 

[Titansmasher]

The OS is windows, but I will be putting it onto a Linux server

Yes, at the moment im just running it off of my home computer so permissions arent an issue

Nothing is being printed to the wrapper console, no.

All I did was follow the instructions included in the readme, ran the windows-start, waited for the server to start then restarted it, and then hopped on. All the other commands work as far as I can tell, its just that one

 

[gravypod]

That is strange, I am looking at the code now to determin the problem.

 

[Titansmasher]

Great work with this dude! I have no clue how I would have gone about getting warp gates and voting rewards into the windoom server if this hadnt been pointed out to me, its a great bit of code and you certainly diserve more attention for this!

 

[gravypod]

Thanks, always great to hear feedback.

 

[gravypod]

What do you mean?

 

[gravypod]

This version fixes the \"!addwarp\" problem people have been having.

 

[gravypod]

- Fix tp command when no arguments are given except for a trailing space
- Fix delwarp command
- Fix permit to handle incorrect arguments
- Improve concurrency while writing to stdin of starmade

 

[gravypod]

- Fix the config option \"update\"