Permalink
Browse files

Update README

  • Loading branch information...
Silverfeelin committed Jan 20, 2018
1 parent dab475e commit ef5d5d6b8895f108d3b51ad43fd059aa16e6a83c
Showing with 22 additions and 9 deletions.
  1. +22 −9 README.md
@@ -1,7 +1,9 @@
# Starbound WEdit
WEdit is a tech mod that allows you to edit the world around you on a larger scale through various functions and features not present in the game.
## Table of Contents
- [Wiki](#wiki)
- [Features](#features)
- [Planned](#planned)
@@ -10,28 +12,39 @@ WEdit is a tech mod that allows you to edit the world around you on a larger sca
- [Licenses](#licenses)
## Features
* Edit terrain in-game on a large(r than usual) scale.
* Edit terrain in-game on a large scale.
* Copy and paste structures, even between planets.
* Many [tools](https://github.com/Silverfeelin/Starbound-WEdit/wiki/Features) accessible from a [compact interface](https://github.com/Silverfeelin/Starbound-WEdit/wiki/Compact-Interface).
* Configure settings in a Quickbar interface.
A full list of features with their usage can be found on the [Wiki](https://github.com/Silverfeelin/Starbound-WEdit/wiki).
## Wiki
The Wiki covers about everything you need to know and do to use WEdit.
The Wiki covers just about everything you need to know and do to use WEdit.
https://github.com/Silverfeelin/Starbound-WEdit/wiki
## Planned
No additional features planned yet. Feel free to suggest them [on the discussion page](http://community.playstarbound.com/threads/wedit.116953/)!
See the [Issues page](https://github.com/Silverfeelin/Starbound-WEdit/labels/enhancement). You can post your own suggestions here too!
## Potential Issues
* Blocks can not be placed directly in front of or behind empty space, when there are no adjacent blocks on the same layer. Some actions may not yield the result you expected initially because of this. The script tries to work around this issue by running the same actions multiple times.
* Server lag can cause synchronization issues; the script continues working while the world hasn't updated yet.
* Undo Tool should not be completely relied upon; it's probably pretty buggy. It is recommended to back up worlds before making any major changes.
* Server lag can cause synchronization issues; the script continues working while the world hasn't updated yet. You can compensate by slowing down WEdit in the [settings](https://github.com/Silverfeelin/Starbound-WEdit/wiki/Settings-Interface).
* The Undo Tool should not be relied upon; it's probably pretty buggy. It is recommended to **back up worlds** before making any major changes!
## Contributing
If you have any suggestions or feedback that might help improve this mod, please do post them [on the discussion page](http://community.playstarbound.com/threads/wedit.116953/)!
You can also create pull requests and contribute directly to the mod!
If you have any suggestions or feedback that might help improve this mod, please do post them by creating a [new Issue](https://github.com/Silverfeelin/Starbound-WEdit/issues/new).
You can also create pull requests to contribute directly to the mod!
## Licenses
Most of the icons used for the tools are courtesy of [Yusuke Kamiyamane](http://p.yusukekamiyamane.com/about/), and can be found in his [Fugue Icons](http://p.yusukekamiyamane.com/) pack. Some have been modified slightly to fit better into the game.
The icon pack mentioned above falls under the [Creative Commons 3.0 license](http://creativecommons.org/licenses/by/3.0/).
WEdit is licensed under the MIT license. Please see: [LICENSE](https://github.com/Silverfeelin/Starbound-WEdit/blob/master/LICENSE).
Most of the icons used for the tools are courtesy of [Yusuke Kamiyamane](http://p.yusukekamiyamane.com/about/), and can be found in his [Fugue Icons](http://p.yusukekamiyamane.com/) pack. Some have been modified slightly to fit better into the game.
Fugue Icons falls under the [Creative Commons 3.0 license](http://creativecommons.org/licenses/by/3.0/).

0 comments on commit ef5d5d6

Please sign in to comment.