You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 27, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
-115Lines changed: 0 additions & 115 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,68 +32,6 @@ should be set to the proxied server. StarryPy will default to port 21025 for
32
32
normal clients to connect to. Select a good random port, or set it to 21024 and
33
33
firewall it off from the outside.
34
34
35
-
<<<<<<< HEAD
36
-
Below I provide installation instructions for Linux and Windows. Please note that Windows setup is more complex and in general seems to be buggier. I develop for Linux primarily, so you may consider the windows instructions unsupported; though they did work for me in a VM.
37
-
38
-
## Linux
39
-
(CentOS instructions coming in the near future.)
40
-
On Debian, the installation is decidedly simple, but it will require sudo access if you do not have python 2.7 installed.
41
-
42
-
First, let's make sure that all the prerequisites are installed:
As a reminder, though this worked for me I cannot guarantee it will fork for you. I offer no particular support for running StarryPy on windows as it has become a huge time sink that has dragged me away from development proper. If, however, you run into actual bugs with the server in Windows, please do let me know.
52
-
53
-
### Download Python
54
-
We'll be using ActiveState python for ease of use. This way you don't have to monkey around with your paths. Just download it from [here](http://www.activestate.com/activepython/downloads). ***Make sure you grab the 32-bit 2.7 version and not the python 3 version; the server will not run on Python 3, nor will it work with the 64-bit version on Windows due to licensing requirements.***
55
-
56
-
### Download StarryPy from GitHub.
57
-
58
-
I personally recommend using git, but a zip file will suffice. Please note that if you choose not to use git (not too hard to figure out), future upgrades are far more likely to break everything.
59
-
60
-
If not using git, click the Download zip file on the right side of the page.
61
-
62
-
Move the StarryPy-master folder somewhere convenient. You can rename it to whatever you like.
63
-
64
-
65
-
### Install requirements.
66
-
67
-
For this step, you'll need to get inside the StarryPy folder in the command prompt. For Vista or greater, which hopefully you are all running, you can simply open up the folder, make sure you don't have any files selected, and then hold down shift and right click in the empty space of the folder. There will be an option to 'Open Command Window Here' or something along those lines.
68
-
69
-
If you can't find that window, run the command 'cmd'. Then, use 'cd directory_name' to get to the right place. If you go too high, use 'cd..' to go down a level.
70
-
71
-
Once you're in the StarryPy folder, run 'pypm install -r requirements.txt' to install all of the dependencies. It will give you an error about enum34; don't worry about it, we'll take care of that next.
72
-
73
-
After all the components are done installing, run 'pypm install pip'. Wait for that to finish installing, and then run 'pip install enum34'.
74
-
75
-
Finally, once that's done, we can move onto configuration.
76
-
77
-
# Configuration
78
-
There are two areas of configuration that we are concerned with. The first is the StarryPy configuration, and the second is Starbound configuration.
79
-
80
-
For StarryPy, you will have to create a configuration file. Copy config.json.example to config.json in the config/ folder, and edit the following variables:
81
-
82
-
* upstream_port: This is the port that Starbound will be running on. I recommend 21024. It **must** match the port in your starbound.config file.
83
-
* upstream_hostname: Change this if you are hosting the wrapper on a different computer than your server.
84
-
* bind_port: This should be 21025 normally; it is the port that StarryPy listens on.
85
-
* passthrough: **Make sure this is false.** It is an emergency off switch for Starrypy.
86
-
87
-
Finally, find starbound.config and change `gameport` to be exactly the same as `upstream_port` in config.json.
88
-
89
-
# Run it
90
-
**After making sure the Starbound server is running**, use your terminal (cmd or powershell on windows) and `cd` to the directory you installed StarryPy into. Enter `python server.py` to start the proxy.
91
-
92
-
# Built-in plugins
93
-
StarryPy is nearly entirely plugin driven (our plugin manager is a plugin!), so there are quite a few built-in plugins. The truly important plugins are in the core\_plugins folder. If you remove any of those, it's likely that most other plugins will break. We'll break them down by core plugin and normal plugin classes.
94
-
95
-
If you are looking for commands, they have been removed from the listing due to the constant flux and the time required for documentation. For a list of commands that you can access from your current user level, use /help. For help with a specific command, use /help command_name.
96
-
=======
97
35
## Run it
98
36
99
37
After making sure the Starbound server is running, use your terminal (cmd or
@@ -108,7 +46,6 @@ there are quite a few built-in plugins. The truly important plugins are in the
108
46
plugins will break. We'll break them down by core plugin and normal plugin
109
47
classes. If you are looking for the commands, feel free to skip the core plugins
110
48
section.
111
-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
112
49
113
50
### Core Plugins
114
51
@@ -134,10 +71,6 @@ it on its merry way to the actual starbound server for processing.
134
71
135
72
### Plugins
136
73
137
-
<<<<<<< HEAD
138
-
### Admin Commands
139
-
The admin commands plugin implements player management from in game.
140
-
=======
141
74
#### Admin Commands
142
75
143
76
The admin commands plugin implements player management from in game. It is a
@@ -163,7 +96,6 @@ SimpleCommandPlugin that provides the following commands:
163
96
number of items to give to a player is 1000. `Access: Admin`
164
97
165
98
#### Admin Messenger
166
-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
167
99
168
100
This command forwards a message to all active moderators or greater. Any command
169
101
prefixed with ## will be sent to moderators+ only. `Access: Everyone`
@@ -184,29 +116,17 @@ are set in config.json.
184
116
185
117
#### MOTD
186
118
187
-
<<<<<<< HEAD
188
-
### MOTD
189
-
This plugin sends a Message of the Day on login.
190
-
=======
191
119
This plugin sends a Message of the Day on login. The MOTD is located in motd.txt
192
120
in the plugin folder. It provides the following command:
193
121
194
122
***/set\_motd**: Sets the MOTD to the following text. `Access: Moderator`
195
-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
196
123
197
124
#### New Player Greeter
198
125
199
126
Greets first-time players on the server. Gives them a greeting (located in
200
127
new\_player\_message.txt) and gives them a pack of starter items (located in
201
128
starter\_items.txt). Default items are 200 `coalore` and 5 `alienburger`s.
202
129
203
-
<<<<<<< HEAD
204
-
### Planet Protection
205
-
This plugin protects specified planets against modification in any way. Currently if a planet is protected only registered users may modify it.
206
-
207
-
### Plugin Manager
208
-
This plugin provides a method of enabling/disabling plugins. I know it's silly that it's a plugin, you don't have to tell me.
209
-
=======
210
130
#### Planet Protection
211
131
212
132
This plugin protects specified planets against modification in any way.
@@ -230,14 +150,9 @@ commands:
230
150
enable\_plugin. `Access: Everyone`
231
151
232
152
#### Warpy
233
-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
234
153
235
154
This plugin provides various methods for warping players and ships around.
236
155
237
-
<<<<<<< HEAD
238
-
### More plugins
239
-
Even more plugins can be found over at [our plugin list](https://github.com/MrMarvin/StarryPy_plugins).
240
-
=======
241
156
***/warp**: Warps you to another player's ship. `Access: Admin`
242
157
***/move\_ship**: Moves your ship to the location of another player, or
243
158
coordinates in the form of `alpha 514180 -82519336 -23964461 4``Access: Admin`
@@ -249,7 +164,6 @@ Even more plugins can be found over at
There are several built-in plugins that you can derive inspiration from. The
255
169
plugin API is decidedly simple, and simply responds to packet events. There is a
@@ -274,23 +188,9 @@ provide a link.
274
188
275
189
## Planned features
276
190
277
-
<<<<<<< HEAD
278
-
# Troubleshooting
279
-
## None of the commands are working
280
-
You are likely in passthrough mode or connecting to the vanilla server. Check config.json and ensure that passthrough is false.
281
-
282
-
If you are running StarryPy on the same computer you're playing it from, it is likely it is using the gameport in starbound.config to connect to. To avoid this, use localhost:21025 in the hostname field in Starbound. Other computers will be able to connect fine.
283
-
284
-
## Something else?
285
-
If you're having another issue, check the Issues tab over on the side. If you find that your issue isn't there, please create a new issue with a copy of your debug.log (if applicable.)
286
-
287
-
# Planned features
288
-
We haven't been able to pack in everything we've wanted to in this version. We love contributions, so please feel free to write whatever plugins/improve the core however you can.
289
-
=======
290
191
We haven't been able to pack in everything we've wanted to in this version. We
291
192
love contributions, so please feel free to write whatever plugins/improve the
292
193
core however you can.
293
-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
294
194
295
195
We have quite a roadmap, here are some of the highlights you can expect in the
296
196
next major version, and in the development branch before that if you're feeling
@@ -303,20 +203,6 @@ brave:
303
203
going to prison on the inevitable murder charge.
304
204
* Lotteries. Because what is life without a little risk?
305
205
* Creature spawning. Want to spawn a couple dozen bone dragons? So do we!
306
-
<<<<<<< HEAD
307
-
* Internationalization. Translate plugins and core messages with ease to your preferred language.
308
-
* Role based access control Thought the mod/admin/owner distinction is useful, having individual roles is our plan for the future.
309
-
* Client filtering based on modded items. Though asset digests aren't supported right now, we want to do some minor filtering to keep out the riff-raff (if you as an admin want to.)
310
-
* Plugin dependency overhaul. Really only interesting to developers, but it will allow for complex dependency resolution.
311
-
312
-
313
-
There are many more planned features, minor and major. If you have a feature you'd just love to have that we haven't covered here, put in a feature request on the issues page.
314
-
315
-
# Contributing
316
-
We're absolutely happy to accept pull requests. There is a freenode channel called ##starbound-dev that we discuss our development on primarily.
317
-
318
-
Other than that, please report any bugs you find with the appropriate section of the debug.log file that is generated.
319
-
=======
320
206
* Projectile blacklist. This should be coming very soon.
321
207
* Internationalization. Translate plugins and core messages with ease to your
322
208
preferred language.
@@ -340,4 +226,3 @@ that we discuss our development on primarily.
340
226
341
227
Other than that, please report any bugs you find with the appropriate section of
0 commit comments