Skip to content
This repository was archived by the owner on Apr 27, 2019. It is now read-only.

Commit 900c0d0

Browse files
committed
Fixed bad merge on README.md.
1 parent 1674d51 commit 900c0d0

File tree

1 file changed

+0
-115
lines changed

1 file changed

+0
-115
lines changed

README.md

Lines changed: 0 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -32,68 +32,6 @@ should be set to the proxied server. StarryPy will default to port 21025 for
3232
normal clients to connect to. Select a good random port, or set it to 21024 and
3333
firewall it off from the outside.
3434

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:
43-
44-
`sudo apt-get install python2.7 python-dev python-pip git`
45-
46-
After installing the prerequisites, clone the repo in the directory of your choice using git:
47-
`git clone https://github.com/CarrotsAreMediocre/StarryPy`
48-
49-
## Windows
50-
51-
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-
=======
9735
## Run it
9836

9937
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
10846
plugins will break. We'll break them down by core plugin and normal plugin
10947
classes. If you are looking for the commands, feel free to skip the core plugins
11048
section.
111-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
11249

11350
### Core Plugins
11451

@@ -134,10 +71,6 @@ it on its merry way to the actual starbound server for processing.
13471

13572
### Plugins
13673

137-
<<<<<<< HEAD
138-
### Admin Commands
139-
The admin commands plugin implements player management from in game.
140-
=======
14174
#### Admin Commands
14275

14376
The admin commands plugin implements player management from in game. It is a
@@ -163,7 +96,6 @@ SimpleCommandPlugin that provides the following commands:
16396
number of items to give to a player is 1000. `Access: Admin`
16497

16598
#### Admin Messenger
166-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
16799

168100
This command forwards a message to all active moderators or greater. Any command
169101
prefixed with ## will be sent to moderators+ only. `Access: Everyone`
@@ -184,29 +116,17 @@ are set in config.json.
184116

185117
#### MOTD
186118

187-
<<<<<<< HEAD
188-
### MOTD
189-
This plugin sends a Message of the Day on login.
190-
=======
191119
This plugin sends a Message of the Day on login. The MOTD is located in motd.txt
192120
in the plugin folder. It provides the following command:
193121

194122
* **/set\_motd**: Sets the MOTD to the following text. `Access: Moderator`
195-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
196123

197124
#### New Player Greeter
198125

199126
Greets first-time players on the server. Gives them a greeting (located in
200127
new\_player\_message.txt) and gives them a pack of starter items (located in
201128
starter\_items.txt). Default items are 200 `coalore` and 5 `alienburger`s.
202129

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-
=======
210130
#### Planet Protection
211131

212132
This plugin protects specified planets against modification in any way.
@@ -230,14 +150,9 @@ commands:
230150
enable\_plugin. `Access: Everyone`
231151

232152
#### Warpy
233-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
234153

235154
This plugin provides various methods for warping players and ships around.
236155

237-
<<<<<<< HEAD
238-
### More plugins
239-
Even more plugins can be found over at [our plugin list](https://github.com/MrMarvin/StarryPy_plugins).
240-
=======
241156
* **/warp**: Warps you to another player's ship. `Access: Admin`
242157
* **/move\_ship**: Moves your ship to the location of another player, or
243158
coordinates in the form of `alpha 514180 -82519336 -23964461 4` `Access: Admin`
@@ -249,7 +164,6 @@ Even more plugins can be found over at
249164
[our plugin list](https://github.com/MrMarvin/StarryPy_plugins).
250165

251166
## Plugin development
252-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
253167

254168
There are several built-in plugins that you can derive inspiration from. The
255169
plugin API is decidedly simple, and simply responds to packet events. There is a
@@ -274,23 +188,9 @@ provide a link.
274188

275189
## Planned features
276190

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-
=======
290191
We haven't been able to pack in everything we've wanted to in this version. We
291192
love contributions, so please feel free to write whatever plugins/improve the
292193
core however you can.
293-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9
294194

295195
We have quite a roadmap, here are some of the highlights you can expect in the
296196
next major version, and in the development branch before that if you're feeling
@@ -303,20 +203,6 @@ brave:
303203
going to prison on the inevitable murder charge.
304204
* Lotteries. Because what is life without a little risk?
305205
* 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-
=======
320206
* Projectile blacklist. This should be coming very soon.
321207
* Internationalization. Translate plugins and core messages with ease to your
322208
preferred language.
@@ -340,4 +226,3 @@ that we discuss our development on primarily.
340226

341227
Other than that, please report any bugs you find with the appropriate section of
342228
the debug.log file that is generated.
343-
>>>>>>> 9a011bdc2a30e951aba1a98c2c7f247b2766f6f9

0 commit comments

Comments
 (0)